relentless_identity 1.0.0

data/docs/ClientFinderResponseAlias.md

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

data/docs/ClientIdentityResponse.md

@@ -0,0 +1,34 @@
+# RelentlessIdentity::ClientIdentityResponse
+
+## 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::ClientIdentityResponse.new(
+  state: null,
+  outcome: null,
+  address: null,
+  is_alias: null,
+  _alias: null,
+  is_catchall: null,
+  identity_providers: null,
+  mx_hosts: null,
+  request_id: null
+)
+```
+

data/docs/ClientRequestHistoryItem.md

@@ -0,0 +1,52 @@
+# RelentlessIdentity::ClientRequestHistoryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **request_type** | **String** |  |  |
+| **input_name** | **String** |  | [optional] |
+| **input_domain** | **String** |  | [optional] |
+| **input_email** | **String** |  | [optional] |
+| **input_label** | **String** | Compact human-readable identifier for the original request input. |  |
+| **state** | **String** |  |  |
+| **outcome** | **String** |  |  |
+| **resolved_address** | **String** |  | [optional] |
+| **duration_ms** | **Integer** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+| **identity_providers** | **Array<Hash<String, Object>>** |  | [optional] |
+| **mx_hosts** | **Array<String>** |  | [optional] |
+| **metadata** | **Hash<String, Object>** | Small transport and outcome metadata associated with the request. | [optional] |
+| **is_alias** | **Boolean** |  | [optional][default to false] |
+| **is_catchall** | **Boolean** |  | [optional][default to false] |
+| **request_id** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientRequestHistoryItem.new(
+  id: null,
+  request_type: null,
+  input_name: null,
+  input_domain: null,
+  input_email: null,
+  input_label: null,
+  state: null,
+  outcome: null,
+  resolved_address: null,
+  duration_ms: null,
+  provider: null,
+  identity_providers: null,
+  mx_hosts: null,
+  metadata: null,
+  is_alias: null,
+  is_catchall: null,
+  request_id: null,
+  created_at: null
+)
+```
+

data/docs/ClientRequestHistoryPageResponse.md

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

data/docs/ClientTokenStatusResponse.md

@@ -0,0 +1,28 @@
+# RelentlessIdentity::ClientTokenStatusResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | Whether the current bearer token is valid for this request. | [optional] |
+| **user_id** | **String** | User id associated with the bearer token. |  |
+| **token_type** | **String** | How the bearer token was issued. |  |
+| **scopes** | **Array<String>** | Scopes currently attached to the bearer token. | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+| **expires_in_seconds** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientTokenStatusResponse.new(
+  valid: null,
+  user_id: null,
+  token_type: null,
+  scopes: null,
+  expires_at: null,
+  expires_in_seconds: null
+)
+```
+

data/docs/ClientUsageResponse.md

@@ -0,0 +1,54 @@
+# RelentlessIdentity::ClientUsageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan_tier** | **String** | Current plan family, such as free or paid. |  |
+| **billing_mode** | **String** |  |  |
+| **billing_status** | **String** |  | [optional] |
+| **free_window_limit** | **Integer** |  |  |
+| **free_window_hours** | **Integer** |  |  |
+| **free_weekly_limit** | **Integer** |  |  |
+| **window_requests_used** | **Integer** |  |  |
+| **weekly_requests_used** | **Integer** |  |  |
+| **window_requests_remaining** | **Integer** |  |  |
+| **weekly_requests_remaining** | **Integer** |  |  |
+| **billing_cycle_value_micros** | **Integer** |  | [optional] |
+| **billing_extra_value_micros** | **Integer** |  |  |
+| **billing_value_micros_used** | **Integer** |  |  |
+| **billing_value_micros_reserved** | **Integer** | Paid usage value currently reserved by queued or running background jobs. | [optional] |
+| **billing_value_micros_remaining** | **Integer** |  | [optional] |
+| **usage_percent_remaining** | **Float** |  | [optional] |
+| **current_plan_finder_deliverable_cost_micros** | **Integer** |  | [optional] |
+| **current_plan_finder_undeliverable_cost_micros** | **Integer** |  | [optional] |
+| **current_plan_probe_cost_micros** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientUsageResponse.new(
+  plan_tier: null,
+  billing_mode: null,
+  billing_status: null,
+  free_window_limit: null,
+  free_window_hours: null,
+  free_weekly_limit: null,
+  window_requests_used: null,
+  weekly_requests_used: null,
+  window_requests_remaining: null,
+  weekly_requests_remaining: null,
+  billing_cycle_value_micros: null,
+  billing_extra_value_micros: null,
+  billing_value_micros_used: null,
+  billing_value_micros_reserved: null,
+  billing_value_micros_remaining: null,
+  usage_percent_remaining: null,
+  current_plan_finder_deliverable_cost_micros: null,
+  current_plan_finder_undeliverable_cost_micros: null,
+  current_plan_probe_cost_micros: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,24 @@
+# RelentlessIdentity::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | Stable machine-readable error key. | [optional] |
+| **message** | **String** | Human-friendly error summary safe to show to an operator or end user. | [optional] |
+| **detail** | **String** | Optional raw backend detail when available. | [optional] |
+| **retry_after_seconds** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ErrorResponse.new(
+  error: null,
+  message: null,
+  detail: null,
+  retry_after_seconds: null
+)
+```
+

data/docs/FinderApi.md

@@ -0,0 +1,77 @@
+# RelentlessIdentity::FinderApi
+
+All URIs are relative to *https://api.relentlessidentity.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**finder_attempt**](FinderApi.md#finder_attempt) | **POST** /client/attempt | Find a work email |
+
+
+## finder_attempt
+
+> <ClientFinderResponse> finder_attempt(finder_request)
+
+Find a work email
+
+Send a full name and company domain to resolve the most likely verified work email.
+
+### 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::FinderApi.new
+finder_request = RelentlessIdentity::FinderRequest.new({full_name: 'Jane Doe', email_domain: 'acme.com'}) # FinderRequest | 
+
+begin
+  # Find a work email
+  result = api_instance.finder_attempt(finder_request)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling FinderApi->finder_attempt: #{e}"
+end
+```
+
+#### Using the finder_attempt_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientFinderResponse>, Integer, Hash)> finder_attempt_with_http_info(finder_request)
+
+```ruby
+begin
+  # Find a work email
+  data, status_code, headers = api_instance.finder_attempt_with_http_info(finder_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientFinderResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling FinderApi->finder_attempt_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finder_request** | [**FinderRequest**](FinderRequest.md) |  |  |
+
+### Return type
+
+[**ClientFinderResponse**](ClientFinderResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FinderBatchJobRequest.md

@@ -0,0 +1,22 @@
+# RelentlessIdentity::FinderBatchJobRequest
+
+## 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] |
+| **inputs** | [**Array<FinderBatchJobRequestInputsInner>**](FinderBatchJobRequestInputsInner.md) | One or more Finder-style inputs that will be processed asynchronously. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::FinderBatchJobRequest.new(
+  deadline: 2027-01-02T00:00Z,
+  callback_url: null,
+  inputs: null
+)
+```
+

data/docs/FinderBatchJobRequestInputsInner.md

@@ -0,0 +1,20 @@
+# RelentlessIdentity::FinderBatchJobRequestInputsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The real person's full name. |  |
+| **email_domain** | **String** | The company website or mailbox domain. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::FinderBatchJobRequestInputsInner.new(
+  full_name: Jane Doe,
+  email_domain: acme.com
+)
+```
+

data/docs/FinderRequest.md

@@ -0,0 +1,20 @@
+# RelentlessIdentity::FinderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The real person's full name. Include middle names or initials when known. |  |
+| **email_domain** | **String** | The company's public website or mailbox domain. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::FinderRequest.new(
+  full_name: Jane Doe,
+  email_domain: acme.com
+)
+```
+

data/docs/HTTPValidationError.md

@@ -0,0 +1,18 @@
+# RelentlessIdentity::HTTPValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | [**Array<ValidationError>**](ValidationError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::HTTPValidationError.new(
+  detail: null
+)
+```
+

data/docs/IdentityProvider.md

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