emailguard_sdk 1.0.0

data/emailguard_sdk.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#EmailGuard Public API
+
+#Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference.
+
+The version of the OpenAPI document: 1.0
+Contact: dev@emailguard.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "emailguard_sdk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "emailguard_sdk"
+  s.version     = Emailguard::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["EmailGuard"]
+  s.email       = ["dev@emailguard.co"]
+  s.homepage    = "https://emailguard.co"
+  s.summary     = "EmailGuard Public API Ruby Gem"
+  s.description = "Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference."
+  s.license     = "Unlicense"
+  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/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="emailguard"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="emailguard-ruby"
+    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/emailguard_sdk/api/billing_api.rb

@@ -0,0 +1,92 @@
+=begin
+#EmailGuard Public API
+
+#Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference.
+
+The version of the OpenAPI document: 1.0
+Contact: dev@emailguard.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module Emailguard
+  class BillingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get billing usage
+    # Returns metered feature usage for the team's billing period. Defaults to the current period; use `range=previous` or `range=custom` with `start` and `end` to query other windows.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range Period selector: current, previous, or custom
+    # @option opts [String] :start Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+    # @option opts [String] :_end Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+    # @return [BillingUsageResponse]
+    def api_v1_team_billing_usage_get(opts = {})
+      data, _status_code, _headers = api_v1_team_billing_usage_get_with_http_info(opts)
+      data
+    end
+
+    # Get billing usage
+    # Returns metered feature usage for the team's billing period. Defaults to the current period; use `range=previous` or `range=custom` with `start` and `end` to query other windows.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range Period selector: current, previous, or custom
+    # @option opts [String] :start Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+    # @option opts [String] :_end Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+    # @return [Array<(BillingUsageResponse, Integer, Hash)>] BillingUsageResponse data, response status code and response headers
+    def api_v1_team_billing_usage_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BillingApi.api_v1_team_billing_usage_get ...'
+      end
+      allowable_values = ["current", "previous", "custom"]
+      if @api_client.config.client_side_validation && opts[:'range'] && !allowable_values.include?(opts[:'range'])
+        fail ArgumentError, "invalid value for \"range\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/v1/team/billing/usage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
+      query_params[:'start'] = opts[:'start'] if !opts[:'start'].nil?
+      query_params[:'end'] = opts[:'_end'] if !opts[:'_end'].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] || 'BillingUsageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"BillingApi.api_v1_team_billing_usage_get",
+        :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: BillingApi#api_v1_team_billing_usage_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/emailguard_sdk/api/channels_api.rb

@@ -0,0 +1,347 @@
+=begin
+#EmailGuard Public API
+
+#Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference.
+
+The version of the OpenAPI document: 1.0
+Contact: dev@emailguard.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module Emailguard
+  class ChannelsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete notification channel
+    # Permanently deletes a channel and removes it from any rules that reference it.
+    # @param channel_id [String] UUID of the notification channel to delete
+    # @param [Hash] opts the optional parameters
+    # @return [MessageResponse]
+    def api_v1_team_notifications_channels_channel_id_delete(channel_id, opts = {})
+      data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id, opts)
+      data
+    end
+
+    # Delete notification channel
+    # Permanently deletes a channel and removes it from any rules that reference it.
+    # @param channel_id [String] UUID of the notification channel to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MessageResponse, Integer, Hash)>] MessageResponse data, response status code and response headers
+    def api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_delete ...'
+      end
+      # verify the required parameter 'channel_id' is set
+      if @api_client.config.client_side_validation && channel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_delete"
+      end
+      # resource path
+      local_var_path = '/api/v1/team/notifications/channels/{channelId}'.sub('{channelId}', CGI.escape(channel_id.to_s))
+
+      # 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] || 'MessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_delete",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_channel_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update notification channel
+    # Updates a channel's display name or configuration. Send only fields you want to change.
+    # @param channel_id [String] UUID of the notification channel to update
+    # @param update_notification_channel_input [UpdateNotificationChannelInput] Updated channel name and/or configuration
+    # @param [Hash] opts the optional parameters
+    # @return [GetNotificationChannelResponse]
+    def api_v1_team_notifications_channels_channel_id_put(channel_id, update_notification_channel_input, opts = {})
+      data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input, opts)
+      data
+    end
+
+    # Update notification channel
+    # Updates a channel&#39;s display name or configuration. Send only fields you want to change.
+    # @param channel_id [String] UUID of the notification channel to update
+    # @param update_notification_channel_input [UpdateNotificationChannelInput] Updated channel name and/or configuration
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetNotificationChannelResponse, Integer, Hash)>] GetNotificationChannelResponse data, response status code and response headers
+    def api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_put ...'
+      end
+      # verify the required parameter 'channel_id' is set
+      if @api_client.config.client_side_validation && channel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_put"
+      end
+      # verify the required parameter 'update_notification_channel_input' is set
+      if @api_client.config.client_side_validation && update_notification_channel_input.nil?
+        fail ArgumentError, "Missing the required parameter 'update_notification_channel_input' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_put"
+      end
+      # resource path
+      local_var_path = '/api/v1/team/notifications/channels/{channelId}'.sub('{channelId}', CGI.escape(channel_id.to_s))
+
+      # 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(update_notification_channel_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetNotificationChannelResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_put",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChannelsApi#api_v1_team_notifications_channels_channel_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Test notification channel
+    # Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.
+    # @param channel_id [String] UUID of the webhook channel to test
+    # @param [Hash] opts the optional parameters
+    # @return [MessageResponse]
+    def api_v1_team_notifications_channels_channel_id_test_post(channel_id, opts = {})
+      data, _status_code, _headers = api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id, opts)
+      data
+    end
+
+    # Test notification channel
+    # Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.
+    # @param channel_id [String] UUID of the webhook channel to test
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MessageResponse, Integer, Hash)>] MessageResponse data, response status code and response headers
+    def api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post ...'
+      end
+      # verify the required parameter 'channel_id' is set
+      if @api_client.config.client_side_validation && channel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post"
+      end
+      # resource path
+      local_var_path = '/api/v1/team/notifications/channels/{channelId}/test'.sub('{channelId}', CGI.escape(channel_id.to_s))
+
+      # 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] || 'MessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.api_v1_team_notifications_channels_channel_id_test_post",
+        :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: ChannelsApi#api_v1_team_notifications_channels_channel_id_test_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List notification channels
+    # Returns every delivery channel configured for the team (email, webhook, and other supported types). Use channel IDs when attaching targets to notification rules.
+    # @param [Hash] opts the optional parameters
+    # @return [GetNotificationChannelsResponse]
+    def api_v1_team_notifications_channels_get(opts = {})
+      data, _status_code, _headers = api_v1_team_notifications_channels_get_with_http_info(opts)
+      data
+    end
+
+    # List notification channels
+    # Returns every delivery channel configured for the team (email, webhook, and other supported types). Use channel IDs when attaching targets to notification rules.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetNotificationChannelsResponse, Integer, Hash)>] GetNotificationChannelsResponse data, response status code and response headers
+    def api_v1_team_notifications_channels_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_get ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/team/notifications/channels'
+
+      # 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] || 'GetNotificationChannelsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.api_v1_team_notifications_channels_get",
+        :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: ChannelsApi#api_v1_team_notifications_channels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create notification channel
+    # Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.
+    # @param create_notification_channel_input [CreateNotificationChannelInput] Channel name, type, and type-specific configuration
+    # @param [Hash] opts the optional parameters
+    # @return [GetNotificationChannelResponse]
+    def api_v1_team_notifications_channels_post(create_notification_channel_input, opts = {})
+      data, _status_code, _headers = api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input, opts)
+      data
+    end
+
+    # Create notification channel
+    # Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.
+    # @param create_notification_channel_input [CreateNotificationChannelInput] Channel name, type, and type-specific configuration
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetNotificationChannelResponse, Integer, Hash)>] GetNotificationChannelResponse data, response status code and response headers
+    def api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.api_v1_team_notifications_channels_post ...'
+      end
+      # verify the required parameter 'create_notification_channel_input' is set
+      if @api_client.config.client_side_validation && create_notification_channel_input.nil?
+        fail ArgumentError, "Missing the required parameter 'create_notification_channel_input' when calling ChannelsApi.api_v1_team_notifications_channels_post"
+      end
+      # resource path
+      local_var_path = '/api/v1/team/notifications/channels'
+
+      # 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(create_notification_channel_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetNotificationChannelResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.api_v1_team_notifications_channels_post",
+        :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: ChannelsApi#api_v1_team_notifications_channels_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/emailguard_sdk/api/email_api.rb

@@ -0,0 +1,86 @@
+=begin
+#EmailGuard Public API
+
+#Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference.
+
+The version of the OpenAPI document: 1.0
+Contact: dev@emailguard.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'cgi'
+
+module Emailguard
+  class EmailApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Detect email characteristics
+    # Analyzes an email for syntax, normalization, typo suggestions, role/public/relay/disposable signals. Invalid TLDs can return suggested_email and suggested_domain while syntax_validation remains false.
+    # @param email [String] Email address to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [EmailDetectResponse]
+    def api_v1_emails_detect_get(email, opts = {})
+      data, _status_code, _headers = api_v1_emails_detect_get_with_http_info(email, opts)
+      data
+    end
+
+    # Detect email characteristics
+    # Analyzes an email for syntax, normalization, typo suggestions, role/public/relay/disposable signals. Invalid TLDs can return suggested_email and suggested_domain while syntax_validation remains false.
+    # @param email [String] Email address to analyze
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailDetectResponse, Integer, Hash)>] EmailDetectResponse data, response status code and response headers
+    def api_v1_emails_detect_get_with_http_info(email, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailApi.api_v1_emails_detect_get ...'
+      end
+      # verify the required parameter 'email' is set
+      if @api_client.config.client_side_validation && email.nil?
+        fail ArgumentError, "Missing the required parameter 'email' when calling EmailApi.api_v1_emails_detect_get"
+      end
+      # resource path
+      local_var_path = '/api/v1/emails/detect'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'email'] = email
+
+      # 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] || 'EmailDetectResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"EmailApi.api_v1_emails_detect_get",
+        :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: EmailApi#api_v1_emails_detect_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end