emailguard_sdk 1.0.0

data/docs/ChannelsApi.md

@@ -0,0 +1,366 @@
+# Emailguard::ChannelsApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_notifications_channels_channel_id_delete**](ChannelsApi.md#api_v1_team_notifications_channels_channel_id_delete) | **DELETE** /api/v1/team/notifications/channels/{channelId} | Delete notification channel |
+| [**api_v1_team_notifications_channels_channel_id_put**](ChannelsApi.md#api_v1_team_notifications_channels_channel_id_put) | **PUT** /api/v1/team/notifications/channels/{channelId} | Update notification channel |
+| [**api_v1_team_notifications_channels_channel_id_test_post**](ChannelsApi.md#api_v1_team_notifications_channels_channel_id_test_post) | **POST** /api/v1/team/notifications/channels/{channelId}/test | Test notification channel |
+| [**api_v1_team_notifications_channels_get**](ChannelsApi.md#api_v1_team_notifications_channels_get) | **GET** /api/v1/team/notifications/channels | List notification channels |
+| [**api_v1_team_notifications_channels_post**](ChannelsApi.md#api_v1_team_notifications_channels_post) | **POST** /api/v1/team/notifications/channels | Create notification channel |
+
+
+## api_v1_team_notifications_channels_channel_id_delete
+
+> <MessageResponse> api_v1_team_notifications_channels_channel_id_delete(channel_id)
+
+Delete notification channel
+
+Permanently deletes a channel and removes it from any rules that reference it.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::ChannelsApi.new
+channel_id = 'channel_id_example' # String | UUID of the notification channel to delete
+
+begin
+  # Delete notification channel
+  result = api_instance.api_v1_team_notifications_channels_channel_id_delete(channel_id)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_delete: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_channels_channel_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageResponse>, Integer, Hash)> api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id)
+
+```ruby
+begin
+  # Delete notification channel
+  data, status_code, headers = api_instance.api_v1_team_notifications_channels_channel_id_delete_with_http_info(channel_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** | UUID of the notification channel to delete |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_channels_channel_id_put
+
+> <GetNotificationChannelResponse> api_v1_team_notifications_channels_channel_id_put(channel_id, update_notification_channel_input)
+
+Update notification channel
+
+Updates a channel's display name or configuration. Send only fields you want to change.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::ChannelsApi.new
+channel_id = 'channel_id_example' # String | UUID of the notification channel to update
+update_notification_channel_input = Emailguard::UpdateNotificationChannelInput.new # UpdateNotificationChannelInput | Updated channel name and/or configuration
+
+begin
+  # Update notification channel
+  result = api_instance.api_v1_team_notifications_channels_channel_id_put(channel_id, update_notification_channel_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_put: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_channels_channel_id_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetNotificationChannelResponse>, Integer, Hash)> api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input)
+
+```ruby
+begin
+  # Update notification channel
+  data, status_code, headers = api_instance.api_v1_team_notifications_channels_channel_id_put_with_http_info(channel_id, update_notification_channel_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetNotificationChannelResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** | UUID of the notification channel to update |  |
+| **update_notification_channel_input** | [**UpdateNotificationChannelInput**](UpdateNotificationChannelInput.md) | Updated channel name and/or configuration |  |
+
+### Return type
+
+[**GetNotificationChannelResponse**](GetNotificationChannelResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_channels_channel_id_test_post
+
+> <MessageResponse> api_v1_team_notifications_channels_channel_id_test_post(channel_id)
+
+Test notification channel
+
+Sends a sample payload to a webhook channel to confirm the endpoint is reachable. On success the channel is marked verified.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::ChannelsApi.new
+channel_id = 'channel_id_example' # String | UUID of the webhook channel to test
+
+begin
+  # Test notification channel
+  result = api_instance.api_v1_team_notifications_channels_channel_id_test_post(channel_id)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_test_post: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_channels_channel_id_test_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageResponse>, Integer, Hash)> api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id)
+
+```ruby
+begin
+  # Test notification channel
+  data, status_code, headers = api_instance.api_v1_team_notifications_channels_channel_id_test_post_with_http_info(channel_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_channel_id_test_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** | UUID of the webhook channel to test |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_channels_get
+
+> <GetNotificationChannelsResponse> api_v1_team_notifications_channels_get
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::ChannelsApi.new
+
+begin
+  # List notification channels
+  result = api_instance.api_v1_team_notifications_channels_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_channels_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetNotificationChannelsResponse>, Integer, Hash)> api_v1_team_notifications_channels_get_with_http_info
+
+```ruby
+begin
+  # List notification channels
+  data, status_code, headers = api_instance.api_v1_team_notifications_channels_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetNotificationChannelsResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetNotificationChannelsResponse**](GetNotificationChannelsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_channels_post
+
+> <GetNotificationChannelResponse> api_v1_team_notifications_channels_post(create_notification_channel_input)
+
+Create notification channel
+
+Creates a delivery channel for the team. Email channels require verification; webhook channels can be verified with the test endpoint.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::ChannelsApi.new
+create_notification_channel_input = Emailguard::CreateNotificationChannelInput.new({name: 'name_example', type: 'type_example'}) # CreateNotificationChannelInput | Channel name, type, and type-specific configuration
+
+begin
+  # Create notification channel
+  result = api_instance.api_v1_team_notifications_channels_post(create_notification_channel_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_post: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_channels_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetNotificationChannelResponse>, Integer, Hash)> api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input)
+
+```ruby
+begin
+  # Create notification channel
+  data, status_code, headers = api_instance.api_v1_team_notifications_channels_post_with_http_info(create_notification_channel_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetNotificationChannelResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling ChannelsApi->api_v1_team_notifications_channels_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_notification_channel_input** | [**CreateNotificationChannelInput**](CreateNotificationChannelInput.md) | Channel name, type, and type-specific configuration |  |
+
+### Return type
+
+[**GetNotificationChannelResponse**](GetNotificationChannelResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateNotificationChannelInput.md

@@ -0,0 +1,22 @@
+# Emailguard::CreateNotificationChannelInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Hash<String, Object>** | Type-specific configuration (email address, webhook URL, headers, and so on). | [optional] |
+| **name** | **String** | Display name shown in team notification settings. |  |
+| **type** | **String** | Channel type (for example email or webhook). |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::CreateNotificationChannelInput.new(
+  config: null,
+  name: null,
+  type: null
+)
+```
+

data/docs/CreateNotificationRuleInput.md

@@ -0,0 +1,28 @@
+# Emailguard::CreateNotificationRuleInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | [**Array<NotificationRuleChannelInput>**](NotificationRuleChannelInput.md) | One or more channel targets to notify when matching events occur. |  |
+| **conditions** | **Hash<String, Object>** | Optional rule conditions (e.g. usage_threshold for USAGE_API_THRESHOLD). | [optional] |
+| **description** | **String** | Optional longer description of what the rule does. | [optional] |
+| **event_types** | **Array<String>** | Event type identifiers this rule listens for (at least one required). |  |
+| **is_enabled** | **Boolean** | When false, the rule is stored but does not deliver events. | [optional] |
+| **name** | **String** | Display name for the rule. |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::CreateNotificationRuleInput.new(
+  channels: null,
+  conditions: null,
+  description: null,
+  event_types: null,
+  is_enabled: null,
+  name: null
+)
+```
+

data/docs/EmailApi.md

@@ -0,0 +1,72 @@
+# Emailguard::EmailApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_emails_detect_get**](EmailApi.md#api_v1_emails_detect_get) | **GET** /api/v1/emails/detect | Detect email characteristics |
+
+
+## api_v1_emails_detect_get
+
+> <EmailDetectResponse> api_v1_emails_detect_get(email)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+
+api_instance = Emailguard::EmailApi.new
+email = 'email_example' # String | Email address to analyze
+
+begin
+  # Detect email characteristics
+  result = api_instance.api_v1_emails_detect_get(email)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling EmailApi->api_v1_emails_detect_get: #{e}"
+end
+```
+
+#### Using the api_v1_emails_detect_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailDetectResponse>, Integer, Hash)> api_v1_emails_detect_get_with_http_info(email)
+
+```ruby
+begin
+  # Detect email characteristics
+  data, status_code, headers = api_instance.api_v1_emails_detect_get_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailDetectResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling EmailApi->api_v1_emails_detect_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address to analyze |  |
+
+### Return type
+
+[**EmailDetectResponse**](EmailDetectResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/EmailDetectData.md

@@ -0,0 +1,44 @@
+# Emailguard::EmailDetectData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detection_source** | **String** |  | [optional] |
+| **disposable** | **Boolean** |  | [optional] |
+| **disposable_provider** | **String** |  | [optional] |
+| **domain** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **normalized** | **String** |  | [optional] |
+| **public_domain** | **Boolean** |  | [optional] |
+| **relay_domain** | **Boolean** |  | [optional] |
+| **relay_provider** | **String** |  | [optional] |
+| **role_address** | **Boolean** |  | [optional] |
+| **subaddressing** | **Boolean** |  | [optional] |
+| **suggested_domain** | **String** | Corrected domain candidate when a domain or TLD typo rule matches. | [optional] |
+| **suggested_email** | **String** | Corrected email candidate when a domain or TLD typo rule matches. | [optional] |
+| **syntax_validation** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::EmailDetectData.new(
+  detection_source: null,
+  disposable: null,
+  disposable_provider: null,
+  domain: null,
+  email: null,
+  normalized: null,
+  public_domain: null,
+  relay_domain: null,
+  relay_provider: null,
+  role_address: null,
+  subaddressing: null,
+  suggested_domain: null,
+  suggested_email: null,
+  syntax_validation: null
+)
+```
+

data/docs/EmailDetectResponse.md

@@ -0,0 +1,22 @@
+# Emailguard::EmailDetectResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Machine-readable status code (for example OK or INVALID_BODY). |  |
+| **data** | [**EmailDetectData**](EmailDetectData.md) |  | [optional] |
+| **message** | **String** | Human-readable detail when the code is not OK. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::EmailDetectResponse.new(
+  code: null,
+  data: null,
+  message: null
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,76 @@
+# Emailguard::EventsApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_notifications_events_get**](EventsApi.md#api_v1_team_notifications_events_get) | **GET** /api/v1/team/notifications/events | List notification events |
+
+
+## api_v1_team_notifications_events_get
+
+> <GetNotificationEventsResponse> api_v1_team_notifications_events_get
+
+List notification events
+
+Returns recent notification delivery events for polling integrations. Use this to inspect what was sent and when without configuring a webhook receiver.
+
+### Examples
+
+```ruby
+require 'time'
+require 'emailguard_sdk'
+# setup authorization
+Emailguard.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Emailguard::EventsApi.new
+
+begin
+  # List notification events
+  result = api_instance.api_v1_team_notifications_events_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling EventsApi->api_v1_team_notifications_events_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_events_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetNotificationEventsResponse>, Integer, Hash)> api_v1_team_notifications_events_get_with_http_info
+
+```ruby
+begin
+  # List notification events
+  data, status_code, headers = api_instance.api_v1_team_notifications_events_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetNotificationEventsResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling EventsApi->api_v1_team_notifications_events_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetNotificationEventsResponse**](GetNotificationEventsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GetNotificationChannelResponse.md

@@ -0,0 +1,22 @@
+# Emailguard::GetNotificationChannelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Machine-readable status code (for example OK or INVALID_BODY). |  |
+| **data** | [**NotificationChannelResponse**](NotificationChannelResponse.md) |  | [optional] |
+| **message** | **String** | Human-readable detail when the code is not OK. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::GetNotificationChannelResponse.new(
+  code: null,
+  data: null,
+  message: null
+)
+```
+

data/docs/GetNotificationChannelsResponse.md

@@ -0,0 +1,22 @@
+# Emailguard::GetNotificationChannelsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Machine-readable status code (for example OK or INVALID_BODY). |  |
+| **data** | [**Array<NotificationChannelResponse>**](NotificationChannelResponse.md) |  | [optional] |
+| **message** | **String** | Human-readable detail when the code is not OK. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::GetNotificationChannelsResponse.new(
+  code: null,
+  data: null,
+  message: null
+)
+```
+