emailguard_sdk 1.0.0

data/docs/GetNotificationEventsResponse.md

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

data/docs/GetNotificationRulesResponse.md

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

data/docs/GetPublicTeamResponse.md

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

data/docs/IdDataResponse.md

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

data/docs/IdDataStruct.md

@@ -0,0 +1,18 @@
+# Emailguard::IdDataStruct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | UUID of the created or referenced record. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::IdDataStruct.new(
+  id: null
+)
+```
+

data/docs/InviteTeamMemberInput.md

@@ -0,0 +1,20 @@
+# Emailguard::InviteTeamMemberInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Email address that will receive the invite. |  |
+| **role** | **String** | Team role to assign when the invite is accepted (for example Owner, Admin, Member). See [Team roles and permissions](/docs/knowledge-base/team-roles-and-permissions). |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::InviteTeamMemberInput.new(
+  email: null,
+  role: null
+)
+```
+

data/docs/InvitesApi.md

@@ -0,0 +1,220 @@
+# Emailguard::InvitesApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_members_invites_get**](InvitesApi.md#api_v1_team_members_invites_get) | **GET** /api/v1/team/members/invites | List pending team invites |
+| [**api_v1_team_members_invites_invite_id_delete**](InvitesApi.md#api_v1_team_members_invites_invite_id_delete) | **DELETE** /api/v1/team/members/invites/{inviteId} | Cancel a pending invite |
+| [**api_v1_team_members_invites_post**](InvitesApi.md#api_v1_team_members_invites_post) | **POST** /api/v1/team/members/invites | Invite a team member |
+
+
+## api_v1_team_members_invites_get
+
+> <ListPublicTeamInvitesResponse> api_v1_team_members_invites_get
+
+List pending team invites
+
+Returns invites that have not yet been accepted or expired. Each invite includes the target email, assigned role, and expiry time.
+
+### 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::InvitesApi.new
+
+begin
+  # List pending team invites
+  result = api_instance.api_v1_team_members_invites_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_invites_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListPublicTeamInvitesResponse>, Integer, Hash)> api_v1_team_members_invites_get_with_http_info
+
+```ruby
+begin
+  # List pending team invites
+  data, status_code, headers = api_instance.api_v1_team_members_invites_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListPublicTeamInvitesResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListPublicTeamInvitesResponse**](ListPublicTeamInvitesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_members_invites_invite_id_delete
+
+> <MessageResponse> api_v1_team_members_invites_invite_id_delete(invite_id)
+
+Cancel a pending invite
+
+Revokes a pending invite so it can no longer be accepted. The invite is identified by its UUID from the list invites response.
+
+### 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::InvitesApi.new
+invite_id = 'invite_id_example' # String | UUID of the pending invite to cancel
+
+begin
+  # Cancel a pending invite
+  result = api_instance.api_v1_team_members_invites_invite_id_delete(invite_id)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_invite_id_delete: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_invites_invite_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_members_invites_invite_id_delete_with_http_info(invite_id)
+
+```ruby
+begin
+  # Cancel a pending invite
+  data, status_code, headers = api_instance.api_v1_team_members_invites_invite_id_delete_with_http_info(invite_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_invite_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invite_id** | **String** | UUID of the pending invite to cancel |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_members_invites_post
+
+> <MessageResponse> api_v1_team_members_invites_post(invite_team_member_input)
+
+Invite a team member
+
+Sends an email invite to join the team with the specified role. The invitee must accept before they appear in the members list.
+
+### 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::InvitesApi.new
+invite_team_member_input = Emailguard::InviteTeamMemberInput.new({email: 'email_example', role: 'role_example'}) # InviteTeamMemberInput | Invitee email and role to assign on acceptance
+
+begin
+  # Invite a team member
+  result = api_instance.api_v1_team_members_invites_post(invite_team_member_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_post: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_invites_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_members_invites_post_with_http_info(invite_team_member_input)
+
+```ruby
+begin
+  # Invite a team member
+  data, status_code, headers = api_instance.api_v1_team_members_invites_post_with_http_info(invite_team_member_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling InvitesApi->api_v1_team_members_invites_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invite_team_member_input** | [**InviteTeamMemberInput**](InviteTeamMemberInput.md) | Invitee email and role to assign on acceptance |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ListPublicTeamInvitesResponse.md

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

data/docs/ListPublicTeamMembersResponse.md

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

data/docs/MembersApi.md

@@ -0,0 +1,222 @@
+# Emailguard::MembersApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_members_get**](MembersApi.md#api_v1_team_members_get) | **GET** /api/v1/team/members | List team members |
+| [**api_v1_team_members_user_id_delete**](MembersApi.md#api_v1_team_members_user_id_delete) | **DELETE** /api/v1/team/members/{userId} | Remove a team member |
+| [**api_v1_team_members_user_id_patch**](MembersApi.md#api_v1_team_members_user_id_patch) | **PATCH** /api/v1/team/members/{userId} | Update a team member role |
+
+
+## api_v1_team_members_get
+
+> <ListPublicTeamMembersResponse> api_v1_team_members_get
+
+List team members
+
+Returns every member of the team, including role, profile fields, and join timestamp. Use the `user_id` field when calling member update or remove routes.
+
+### 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::MembersApi.new
+
+begin
+  # List team members
+  result = api_instance.api_v1_team_members_get
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListPublicTeamMembersResponse>, Integer, Hash)> api_v1_team_members_get_with_http_info
+
+```ruby
+begin
+  # List team members
+  data, status_code, headers = api_instance.api_v1_team_members_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListPublicTeamMembersResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListPublicTeamMembersResponse**](ListPublicTeamMembersResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_members_user_id_delete
+
+> <MessageResponse> api_v1_team_members_user_id_delete(user_id)
+
+Remove a team member
+
+Removes a user from the team. Identify the member by user account UUID in the path. The team owner cannot be removed through this 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::MembersApi.new
+user_id = 'user_id_example' # String | User account UUID of the member to remove
+
+begin
+  # Remove a team member
+  result = api_instance.api_v1_team_members_user_id_delete(user_id)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_user_id_delete: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_user_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_members_user_id_delete_with_http_info(user_id)
+
+```ruby
+begin
+  # Remove a team member
+  data, status_code, headers = api_instance.api_v1_team_members_user_id_delete_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_user_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | User account UUID of the member to remove |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## api_v1_team_members_user_id_patch
+
+> <MessageResponse> api_v1_team_members_user_id_patch(user_id, update_team_member_input)
+
+Update a team member role
+
+Changes a member's role or internal notes. Identify the member by user account UUID in the path (not the team membership record ID).
+
+### 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::MembersApi.new
+user_id = 'user_id_example' # String | User account UUID of the member to update
+update_team_member_input = Emailguard::UpdateTeamMemberInput.new({id: 'id_example'}) # UpdateTeamMemberInput | New role and/or notes for the member
+
+begin
+  # Update a team member role
+  result = api_instance.api_v1_team_members_user_id_patch(user_id, update_team_member_input)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_user_id_patch: #{e}"
+end
+```
+
+#### Using the api_v1_team_members_user_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessageResponse>, Integer, Hash)> api_v1_team_members_user_id_patch_with_http_info(user_id, update_team_member_input)
+
+```ruby
+begin
+  # Update a team member role
+  data, status_code, headers = api_instance.api_v1_team_members_user_id_patch_with_http_info(user_id, update_team_member_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling MembersApi->api_v1_team_members_user_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | User account UUID of the member to update |  |
+| **update_team_member_input** | [**UpdateTeamMemberInput**](UpdateTeamMemberInput.md) | New role and/or notes for the member |  |
+
+### Return type
+
+[**MessageResponse**](MessageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MessageResponse.md

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

data/docs/NotificationChannelResponse.md

@@ -0,0 +1,28 @@
+# Emailguard::NotificationChannelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Hash<String, Object>** | Type-specific configuration. Sensitive values may be redacted in responses. | [optional] |
+| **created_at** | **String** | When the channel was created (RFC3339). | [optional] |
+| **id** | **String** | Channel record ID. | [optional] |
+| **is_verified** | **Boolean** | Whether the channel has completed verification (email link or webhook test). | [optional] |
+| **name** | **String** | Display name in notification settings. | [optional] |
+| **type** | **String** | Channel type (for example email or webhook). | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::NotificationChannelResponse.new(
+  config: null,
+  created_at: null,
+  id: null,
+  is_verified: null,
+  name: null,
+  type: null
+)
+```
+

data/docs/NotificationRuleChannelInput.md

@@ -0,0 +1,22 @@
+# Emailguard::NotificationRuleChannelInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_id** | **String** | UUID of a team notification channel. Use this or predefined, not both. | [optional] |
+| **predefined** | **String** | Built-in channel identifier when not using a custom channel. | [optional] |
+| **target_user_id** | **String** | Restrict delivery to a specific team member's user ID. | [optional] |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::NotificationRuleChannelInput.new(
+  channel_id: null,
+  predefined: null,
+  target_user_id: null
+)
+```
+