emailguard_sdk 1.0.0

data/docs/NotificationRuleChannelResponse.md

@@ -0,0 +1,28 @@
+# Emailguard::NotificationRuleChannelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** | Linked custom channel ID, if any. | [optional] |
+| **channel_name** | **String** | Name of the linked channel, when resolved. | [optional] |
+| **channel_type** | **String** | Type of the linked channel, when resolved. | [optional] |
+| **id** | **String** | Assignment record ID. | [optional] |
+| **predefined** | **String** | Built-in channel identifier when not using a custom channel. | [optional] |
+| **target_user_id** | **String** | User ID when delivery is scoped to one member. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::NotificationRuleChannelResponse.new(
+  channel_id: null,
+  channel_name: null,
+  channel_type: null,
+  id: null,
+  predefined: null,
+  target_user_id: null
+)
+```
+

data/docs/NotificationRuleResponse.md

@@ -0,0 +1,32 @@
+# Emailguard::NotificationRuleResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | [**Array<NotificationRuleChannelResponse>**](NotificationRuleChannelResponse.md) | Channel targets notified when the rule matches. | [optional] |
+| **conditions** | **Hash<String, Object>** | Optional conditions (e.g. usage threshold percents). | [optional] |
+| **created_at** | **String** | When the rule was created (RFC3339). | [optional] |
+| **description** | **String** | Optional longer description. | [optional] |
+| **event_types** | **Array<String>** | Event types that trigger this rule. | [optional] |
+| **id** | **String** | Rule record ID. | [optional] |
+| **is_enabled** | **Boolean** | Whether the rule is actively delivering events. | [optional] |
+| **name** | **String** | Display name for the rule. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::NotificationRuleResponse.new(
+  channels: null,
+  conditions: null,
+  created_at: null,
+  description: null,
+  event_types: null,
+  id: null,
+  is_enabled: null,
+  name: null
+)
+```
+

data/docs/PublicTeamInviteResponse.md

@@ -0,0 +1,24 @@
+# Emailguard::PublicTeamInviteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address the invite was sent to. |  |
+| **expires_at** | **String** | When the invite expires if not accepted (RFC3339). |  |
+| **id** | **String** | Invite record ID. |  |
+| **role** | **String** | Role the invitee will receive when they accept. |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::PublicTeamInviteResponse.new(
+  email: null,
+  expires_at: null,
+  id: null,
+  role: null
+)
+```
+

data/docs/PublicTeamMemberResponse.md

@@ -0,0 +1,34 @@
+# Emailguard::PublicTeamMemberResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **String** | When the member joined the team (RFC3339). |  |
+| **email** | **String** | Member login email. |  |
+| **emoji** | **String** | User profile emoji. | [optional] |
+| **first_name** | **String** | Member given name. |  |
+| **id** | **String** | Team membership record ID. |  |
+| **last_name** | **String** | Member family name. |  |
+| **notes** | **String** | Internal notes stored on the membership. | [optional] |
+| **role** | **String** | Team role (for example Owner, Admin, Member). |  |
+| **user_id** | **String** | User account ID for this member. |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::PublicTeamMemberResponse.new(
+  created_at: null,
+  email: null,
+  emoji: null,
+  first_name: null,
+  id: null,
+  last_name: null,
+  notes: null,
+  role: null,
+  user_id: null
+)
+```
+

data/docs/PublicTeamResponse.md

@@ -0,0 +1,28 @@
+# Emailguard::PublicTeamResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Contact email for the workspace. | [optional] |
+| **emoji** | **String** | Avatar emoji. | [optional] |
+| **id** | **String** | Team UUID. | [optional] |
+| **name** | **String** | Display name. | [optional] |
+| **type** | **String** | Team kind (for example team or personal). | [optional] |
+| **url** | **String** | Public website URL. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::PublicTeamResponse.new(
+  email: null,
+  emoji: null,
+  id: null,
+  name: null,
+  type: null,
+  url: null
+)
+```
+

data/docs/RulesApi.md

@@ -0,0 +1,294 @@
+# Emailguard::RulesApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_notifications_rules_get**](RulesApi.md#api_v1_team_notifications_rules_get) | **GET** /api/v1/team/notifications/rules | List notification rules |
+| [**api_v1_team_notifications_rules_post**](RulesApi.md#api_v1_team_notifications_rules_post) | **POST** /api/v1/team/notifications/rules | Create notification rule |
+| [**api_v1_team_notifications_rules_rule_id_delete**](RulesApi.md#api_v1_team_notifications_rules_rule_id_delete) | **DELETE** /api/v1/team/notifications/rules/{ruleId} | Delete notification rule |
+| [**api_v1_team_notifications_rules_rule_id_put**](RulesApi.md#api_v1_team_notifications_rules_rule_id_put) | **PUT** /api/v1/team/notifications/rules/{ruleId} | Update notification rule |
+
+
+## api_v1_team_notifications_rules_get
+
+> <GetNotificationRulesResponse> api_v1_team_notifications_rules_get
+
+List notification rules
+
+Returns routing rules that map event types to one or more delivery channels. Each rule includes its enabled state and channel targets.
+
+### 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::RulesApi.new
+
+begin
+  # List notification rules
+  result = api_instance.api_v1_team_notifications_rules_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_rules_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetNotificationRulesResponse>, Integer, Hash)> api_v1_team_notifications_rules_get_with_http_info
+
+```ruby
+begin
+  # List notification rules
+  data, status_code, headers = api_instance.api_v1_team_notifications_rules_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetNotificationRulesResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetNotificationRulesResponse**](GetNotificationRulesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_rules_post
+
+> <IdDataResponse> api_v1_team_notifications_rules_post(create_notification_rule_input)
+
+Create notification rule
+
+Creates a rule that delivers matching events to the specified channels. At least one event type and one channel target are required.
+
+### 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::RulesApi.new
+create_notification_rule_input = Emailguard::CreateNotificationRuleInput.new({channels: [Emailguard::NotificationRuleChannelInput.new], event_types: ['event_types_example'], name: 'name_example'}) # CreateNotificationRuleInput | Rule name, event types, and channel targets
+
+begin
+  # Create notification rule
+  result = api_instance.api_v1_team_notifications_rules_post(create_notification_rule_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_post: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_rules_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IdDataResponse>, Integer, Hash)> api_v1_team_notifications_rules_post_with_http_info(create_notification_rule_input)
+
+```ruby
+begin
+  # Create notification rule
+  data, status_code, headers = api_instance.api_v1_team_notifications_rules_post_with_http_info(create_notification_rule_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IdDataResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_notification_rule_input** | [**CreateNotificationRuleInput**](CreateNotificationRuleInput.md) | Rule name, event types, and channel targets |  |
+
+### Return type
+
+[**IdDataResponse**](IdDataResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## api_v1_team_notifications_rules_rule_id_delete
+
+> <MessageResponse> api_v1_team_notifications_rules_rule_id_delete(rule_id)
+
+Delete notification rule
+
+Permanently deletes a routing rule and its channel assignments.
+
+### 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::RulesApi.new
+rule_id = 'rule_id_example' # String | UUID of the notification rule to delete
+
+begin
+  # Delete notification rule
+  result = api_instance.api_v1_team_notifications_rules_rule_id_delete(rule_id)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_rule_id_delete: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_rules_rule_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_rules_rule_id_delete_with_http_info(rule_id)
+
+```ruby
+begin
+  # Delete notification rule
+  data, status_code, headers = api_instance.api_v1_team_notifications_rules_rule_id_delete_with_http_info(rule_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_rule_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rule_id** | **String** | UUID of the notification rule 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_rules_rule_id_put
+
+> <MessageResponse> api_v1_team_notifications_rules_rule_id_put(rule_id, update_notification_rule_input)
+
+Update notification rule
+
+Updates a rule's name, description, event types, enabled flag, or channel targets. When `channels` is sent it replaces all existing targets.
+
+### 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::RulesApi.new
+rule_id = 'rule_id_example' # String | UUID of the notification rule to update
+update_notification_rule_input = Emailguard::UpdateNotificationRuleInput.new # UpdateNotificationRuleInput | Fields to update on the rule
+
+begin
+  # Update notification rule
+  result = api_instance.api_v1_team_notifications_rules_rule_id_put(rule_id, update_notification_rule_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_rule_id_put: #{e}"
+end
+```
+
+#### Using the api_v1_team_notifications_rules_rule_id_put_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_rules_rule_id_put_with_http_info(rule_id, update_notification_rule_input)
+
+```ruby
+begin
+  # Update notification rule
+  data, status_code, headers = api_instance.api_v1_team_notifications_rules_rule_id_put_with_http_info(rule_id, update_notification_rule_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling RulesApi->api_v1_team_notifications_rules_rule_id_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rule_id** | **String** | UUID of the notification rule to update |  |
+| **update_notification_rule_input** | [**UpdateNotificationRuleInput**](UpdateNotificationRuleInput.md) | Fields to update on the rule |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TeamsApi.md

@@ -0,0 +1,148 @@
+# Emailguard::TeamsApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_get**](TeamsApi.md#api_v1_team_get) | **GET** /api/v1/team | Get team |
+| [**api_v1_team_patch**](TeamsApi.md#api_v1_team_patch) | **PATCH** /api/v1/team | Update team |
+
+
+## api_v1_team_get
+
+> <GetPublicTeamResponse> api_v1_team_get
+
+Get team
+
+Returns profile fields for the team associated with your API key.
+
+### 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::TeamsApi.new
+
+begin
+  # Get team
+  result = api_instance.api_v1_team_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling TeamsApi->api_v1_team_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPublicTeamResponse>, Integer, Hash)> api_v1_team_get_with_http_info
+
+```ruby
+begin
+  # Get team
+  data, status_code, headers = api_instance.api_v1_team_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPublicTeamResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling TeamsApi->api_v1_team_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetPublicTeamResponse**](GetPublicTeamResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_patch
+
+> <GetPublicTeamResponse> api_v1_team_patch(update_team_input)
+
+Update team
+
+Updates mutable team profile fields (name, emoji, URL, email). Send only the fields you want to change; omitted fields are left unchanged except `name`, which is required on every request.
+
+### 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::TeamsApi.new
+update_team_input = Emailguard::UpdateTeamInput.new({name: 'name_example'}) # UpdateTeamInput | Team profile fields to update
+
+begin
+  # Update team
+  result = api_instance.api_v1_team_patch(update_team_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling TeamsApi->api_v1_team_patch: #{e}"
+end
+```
+
+#### Using the api_v1_team_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPublicTeamResponse>, Integer, Hash)> api_v1_team_patch_with_http_info(update_team_input)
+
+```ruby
+begin
+  # Update team
+  data, status_code, headers = api_instance.api_v1_team_patch_with_http_info(update_team_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPublicTeamResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling TeamsApi->api_v1_team_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_team_input** | [**UpdateTeamInput**](UpdateTeamInput.md) | Team profile fields to update |  |
+
+### Return type
+
+[**GetPublicTeamResponse**](GetPublicTeamResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UpdateNotificationChannelInput.md

@@ -0,0 +1,20 @@
+# Emailguard::UpdateNotificationChannelInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Hash<String, Object>** | Updated type-specific configuration. Omit to leave unchanged. | [optional] |
+| **name** | **String** | Updated display name. Omit to leave unchanged. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::UpdateNotificationChannelInput.new(
+  config: null,
+  name: null
+)
+```
+

data/docs/UpdateNotificationRuleInput.md

@@ -0,0 +1,28 @@
+# Emailguard::UpdateNotificationRuleInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channels** | [**Array<NotificationRuleChannelInput>**](NotificationRuleChannelInput.md) | Replaces all channel targets when provided. | [optional] |
+| **conditions** | **Hash<String, Object>** | Updated conditions. Omit to leave unchanged. | [optional] |
+| **description** | **String** | Updated description. Omit to leave unchanged. | [optional] |
+| **event_types** | **Array<String>** | Updated event types. Omit to leave unchanged. | [optional] |
+| **is_enabled** | **Boolean** | Enable or disable delivery for this rule. | [optional] |
+| **name** | **String** | Updated display name. Omit to leave unchanged. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::UpdateNotificationRuleInput.new(
+  channels: null,
+  conditions: null,
+  description: null,
+  event_types: null,
+  is_enabled: null,
+  name: null
+)
+```
+

data/docs/UpdateTeamInput.md

@@ -0,0 +1,24 @@
+# Emailguard::UpdateTeamInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Contact email address for the team workspace. | [optional] |
+| **emoji** | **String** | Single grapheme emoji shown as the team avatar in the product UI. | [optional] |
+| **name** | **String** | Human-readable team name. |  |
+| **url** | **String** | Public website URL for the team. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::UpdateTeamInput.new(
+  email: null,
+  emoji: null,
+  name: null,
+  url: null
+)
+```
+

data/docs/UpdateTeamMemberInput.md

@@ -0,0 +1,22 @@
+# Emailguard::UpdateTeamMemberInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Internal team member record ID. When calling the public API, this is set from the path userId. |  |
+| **notes** | **String** | Internal notes about the member. Omit to leave unchanged. | [optional] |
+| **role** | **String** | New team role (for example Owner, Admin, Member). Omit to leave unchanged. See [Team roles and permissions](/docs/knowledge-base/team-roles-and-permissions). | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::UpdateTeamMemberInput.new(
+  id: null,
+  notes: null,
+  role: null
+)
+```
+