relentless_identity 1.0.0

data/relentless_identity.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "relentless_identity/version"
+
+Gem::Specification.new do |s|
+  s.name        = "relentless_identity"
+  s.version     = RelentlessIdentity::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors = ["Relentless Identity"]
+  s.email = [""]
+  s.homepage = "https://relentlessidentity.com"
+  s.summary = "Official Ruby SDK for the Relentless Identity API"
+  s.description = "Official Ruby SDK for the Relentless Identity API — email Finder and Probe verification workflows."
+  s.license = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/account_api_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for RelentlessIdentity::AccountApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @api_instance = RelentlessIdentity::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@api_instance).to be_instance_of(RelentlessIdentity::AccountApi)
+    end
+  end
+
+  # unit tests for get_request_history
+  # Get paginated request history
+  # Return the authenticated user's latest request history with pagination and optional filters.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number starting at 1.
+  # @option opts [Integer] :page_size Number of history rows per page. Maximum 25.
+  # @option opts [String] :request_type Optional request-type filter.
+  # @option opts [String] :state Optional deliverability-state filter.
+  # @return [ClientRequestHistoryPageResponse]
+  describe 'get_request_history test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_token_status
+  # Inspect the current bearer token
+  # Validate the current bearer token and return its active claims.
+  # @param [Hash] opts the optional parameters
+  # @return [ClientTokenStatusResponse]
+  describe 'get_token_status test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_usage
+  # Get current usage and limits
+  # Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+  # @param [Hash] opts the optional parameters
+  # @return [ClientUsageResponse]
+  describe 'get_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/finder_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for RelentlessIdentity::FinderApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FinderApi' do
+  before do
+    # run before each test
+    @api_instance = RelentlessIdentity::FinderApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FinderApi' do
+    it 'should create an instance of FinderApi' do
+      expect(@api_instance).to be_instance_of(RelentlessIdentity::FinderApi)
+    end
+  end
+
+  # unit tests for finder_attempt
+  # Find a work email
+  # Send a full name and company domain to resolve the most likely verified work email.
+  # @param finder_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ClientFinderResponse]
+  describe 'finder_attempt test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/jobs_api_spec.rb

@@ -0,0 +1,130 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for RelentlessIdentity::JobsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'JobsApi' do
+  before do
+    # run before each test
+    @api_instance = RelentlessIdentity::JobsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of JobsApi' do
+    it 'should create an instance of JobsApi' do
+      expect(@api_instance).to be_instance_of(RelentlessIdentity::JobsApi)
+    end
+  end
+
+  # unit tests for get_job
+  # Get background job
+  # Return the current status and paginated results for one background job.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @option opts [Integer] :page_size 
+  # @return [ClientBackgroundJobDetailResponse]
+  describe 'get_job test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job_inputs_text
+  # Download job inputs
+  # Return the original background job inputs as plain text when the payload is still retained.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :if_none_match 
+  # @option opts [String] :if_modified_since 
+  # @return [String]
+  describe 'get_job_inputs_text test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job_results_json
+  # Download job results as JSON
+  # Return the canonical immutable background job results artifact as JSON.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :if_none_match 
+  # @option opts [String] :if_modified_since 
+  # @return [Object]
+  describe 'get_job_results_json test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_job_results_text
+  # Download job results as text
+  # Return the canonical background job results in a readable plain-text format.
+  # @param job_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :if_none_match 
+  # @option opts [String] :if_modified_since 
+  # @return [String]
+  describe 'get_job_results_text test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_jobs
+  # List background jobs
+  # Return the authenticated user's paginated background job history.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @option opts [Integer] :page_size 
+  # @option opts [String] :job_type 
+  # @option opts [String] :status 
+  # @return [ClientBackgroundJobPageResponse]
+  describe 'list_jobs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for schedule_finder_batch
+  # Schedule a finder batch
+  # Queue a background finder batch job with an optional deadline and callback URL.
+  # @param finder_batch_job_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ClientBackgroundJobResponse]
+  describe 'schedule_finder_batch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for schedule_probe_batch
+  # Schedule a probe batch
+  # Queue a background probe batch job with an optional deadline and callback URL.
+  # @param probe_batch_job_background_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ClientBackgroundJobResponse]
+  describe 'schedule_probe_batch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/probe_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for RelentlessIdentity::ProbeApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProbeApi' do
+  before do
+    # run before each test
+    @api_instance = RelentlessIdentity::ProbeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProbeApi' do
+    it 'should create an instance of ProbeApi' do
+      expect(@api_instance).to be_instance_of(RelentlessIdentity::ProbeApi)
+    end
+  end
+
+  # unit tests for probe_batch
+  # Verify many email addresses
+  # Send many known email addresses and receive compact per-item identity results plus a batch summary.
+  # @param probe_batch_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ClientBatchIdentityResponse]
+  describe 'probe_batch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for probe_email
+  # Verify an email address
+  # Send a single email address to verify it directly.
+  # @param probe_request 
+  # @param [Hash] opts the optional parameters
+  # @return [ClientIdentityResponse]
+  describe 'probe_email test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/alias_info_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for RelentlessIdentity::AliasInfo
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe RelentlessIdentity::AliasInfo do
+  #let(:instance) { RelentlessIdentity::AliasInfo.new }
+
+  describe 'test an instance of AliasInfo' do
+    it 'should create an instance of AliasInfo' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(RelentlessIdentity::AliasInfo)
+    end
+  end
+
+  describe 'test attribute "original"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "resolved"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/batch_summary_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for RelentlessIdentity::BatchSummary
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe RelentlessIdentity::BatchSummary do
+  #let(:instance) { RelentlessIdentity::BatchSummary.new }
+
+  describe 'test an instance of BatchSummary' do
+    it 'should create an instance of BatchSummary' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(RelentlessIdentity::BatchSummary)
+    end
+  end
+
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "found"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "not_found"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "unique_domains"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/client_background_job_detail_response_spec.rb

@@ -0,0 +1,72 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for RelentlessIdentity::ClientBackgroundJobDetailResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe RelentlessIdentity::ClientBackgroundJobDetailResponse do
+  #let(:instance) { RelentlessIdentity::ClientBackgroundJobDetailResponse.new }
+
+  describe 'test an instance of ClientBackgroundJobDetailResponse' do
+    it 'should create an instance of ClientBackgroundJobDetailResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(RelentlessIdentity::ClientBackgroundJobDetailResponse)
+    end
+  end
+
+  describe 'test attribute "job"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "items"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "total_items"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "page"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "page_size"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "total_pages"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "results_expired"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/client_background_job_item_response_spec.rb

@@ -0,0 +1,138 @@
+=begin
+#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.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for RelentlessIdentity::ClientBackgroundJobItemResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe RelentlessIdentity::ClientBackgroundJobItemResponse do
+  #let(:instance) { RelentlessIdentity::ClientBackgroundJobItemResponse.new }
+
+  describe 'test an instance of ClientBackgroundJobItemResponse' do
+    it 'should create an instance of ClientBackgroundJobItemResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(RelentlessIdentity::ClientBackgroundJobItemResponse)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "item_index"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["queued", "processing", "completed", "error", "canceled"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "request_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["finder", "probe"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.request_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "input"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "result"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "result_state"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "result_outcome"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["found", "not_found", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.result_outcome = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "resolved_address"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "provider"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "charge_micros"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "error_message"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "started_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "completed_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "created_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "updated_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end