relentless_identity 1.0.0

data/docs/ProbeBatchRequest.md

@@ -0,0 +1,18 @@
+# RelentlessIdentity::ProbeBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **emails** | **Array<String>** | One or more exact mailbox addresses to verify. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ProbeBatchRequest.new(
+  emails: ["jane.doe@acme.com","john.smith@acme.com"]
+)
+```
+

data/docs/ProbeRequest.md

@@ -0,0 +1,18 @@
+# RelentlessIdentity::ProbeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The email address you want to verify. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ProbeRequest.new(
+  email: jane.doe@acme.com
+)
+```
+

data/docs/ValidationError.md

@@ -0,0 +1,26 @@
+# RelentlessIdentity::ValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **loc** | [**Array<LocationInner>**](LocationInner.md) |  |  |
+| **msg** | **String** |  |  |
+| **type** | **String** |  |  |
+| **input** | **Object** |  | [optional] |
+| **ctx** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ValidationError.new(
+  loc: null,
+  msg: null,
+  type: null,
+  input: null,
+  ctx: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/relentless_identity/api/account_api.rb

@@ -0,0 +1,225 @@
+=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 'cgi'
+
+module RelentlessIdentity
+  class AccountApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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. (default to 1)
+    # @option opts [Integer] :page_size Number of history rows per page. Maximum 25. (default to 25)
+    # @option opts [String] :request_type Optional request-type filter.
+    # @option opts [String] :state Optional deliverability-state filter.
+    # @return [ClientRequestHistoryPageResponse]
+    def get_request_history(opts = {})
+      data, _status_code, _headers = get_request_history_with_http_info(opts)
+      data
+    end
+
+    # 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. (default to 1)
+    # @option opts [Integer] :page_size Number of history rows per page. Maximum 25. (default to 25)
+    # @option opts [String] :request_type Optional request-type filter.
+    # @option opts [String] :state Optional deliverability-state filter.
+    # @return [Array<(ClientRequestHistoryPageResponse, Integer, Hash)>] ClientRequestHistoryPageResponse data, response status code and response headers
+    def get_request_history_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_request_history ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_request_history, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 25
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_request_history, must be smaller than or equal to 25.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_request_history, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["finder", "probe"]
+      if @api_client.config.client_side_validation && opts[:'request_type'] && !allowable_values.include?(opts[:'request_type'])
+        fail ArgumentError, "invalid value for \"request_type\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["deliverable", "undeliverable"]
+      if @api_client.config.client_side_validation && opts[:'state'] && !allowable_values.include?(opts[:'state'])
+        fail ArgumentError, "invalid value for \"state\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/client/history'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'request_type'] = opts[:'request_type'] if !opts[:'request_type'].nil?
+      query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientRequestHistoryPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_request_history",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#get_request_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect the current bearer token
+    # Validate the current bearer token and return its active claims.
+    # @param [Hash] opts the optional parameters
+    # @return [ClientTokenStatusResponse]
+    def get_token_status(opts = {})
+      data, _status_code, _headers = get_token_status_with_http_info(opts)
+      data
+    end
+
+    # Inspect the current bearer token
+    # Validate the current bearer token and return its active claims.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientTokenStatusResponse, Integer, Hash)>] ClientTokenStatusResponse data, response status code and response headers
+    def get_token_status_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_token_status ...'
+      end
+      # resource path
+      local_var_path = '/client/token'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientTokenStatusResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_token_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#get_token_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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]
+    def get_usage(opts = {})
+      data, _status_code, _headers = get_usage_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(ClientUsageResponse, Integer, Hash)>] ClientUsageResponse data, response status code and response headers
+    def get_usage_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountApi.get_usage ...'
+      end
+      # resource path
+      local_var_path = '/client/usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientUsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"AccountApi.get_usage",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountApi#get_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/relentless_identity/api/finder_api.rb

@@ -0,0 +1,90 @@
+=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 'cgi'
+
+module RelentlessIdentity
+  class FinderApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Find a work email
+    # Send a full name and company domain to resolve the most likely verified work email.
+    # @param finder_request [FinderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ClientFinderResponse]
+    def finder_attempt(finder_request, opts = {})
+      data, _status_code, _headers = finder_attempt_with_http_info(finder_request, opts)
+      data
+    end
+
+    # Find a work email
+    # Send a full name and company domain to resolve the most likely verified work email.
+    # @param finder_request [FinderRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientFinderResponse, Integer, Hash)>] ClientFinderResponse data, response status code and response headers
+    def finder_attempt_with_http_info(finder_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FinderApi.finder_attempt ...'
+      end
+      # verify the required parameter 'finder_request' is set
+      if @api_client.config.client_side_validation && finder_request.nil?
+        fail ArgumentError, "Missing the required parameter 'finder_request' when calling FinderApi.finder_attempt"
+      end
+      # resource path
+      local_var_path = '/client/attempt'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(finder_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientFinderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FinderApi.finder_attempt",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FinderApi#finder_attempt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end