emailguard_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33f133b489991ffce4efa4f9275120b4a4c0ca71637a397b2289a5d11367fe80
+  data.tar.gz: 47f9e45fbf7940df7eaedeab0771a899af7f8481a8220ad323f72706ed4495a7
+SHA512:
+  metadata.gz: f70fb0998aaa866c185e82719c4a07cfa2626ebf130afb59ce582f616ab60272c67db4e9a237a5cd9157212536dbb3d0ffb00e2f7e4bb00109b4d8fd100f02a6
+  data.tar.gz: 78b789290088d57e92dd95fc80ac3499efff1734ed919f05c3591e269158ba8e191ae79885bfb6d8a439d4e46c876be037f469294b773bac69f50ad85a76f231

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,169 @@
+# emailguard_sdk
+
+Emailguard - the Ruby gem for the 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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.0.0
+- Generator version: 7.23.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://emailguard.co](https://emailguard.co)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build emailguard_sdk.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./emailguard_sdk-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./emailguard_sdk-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'emailguard_sdk', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/emailguard/emailguard-ruby, then add the following in the Gemfile:
+
+    gem 'emailguard_sdk', :git => 'https://github.com/emailguard/emailguard-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+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::BillingApi.new
+opts = {
+  range: 'current', # String | Period selector: current, previous, or custom
+  start: 'start_example', # String | Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+  _end: '_end_example' # String | Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+}
+
+begin
+  #Get billing usage
+  result = api_instance.api_v1_team_billing_usage_get(opts)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Exception when calling BillingApi->api_v1_team_billing_usage_get: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://api.emailguard.co*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Emailguard::BillingApi* | [**api_v1_team_billing_usage_get**](docs/BillingApi.md#api_v1_team_billing_usage_get) | **GET** /api/v1/team/billing/usage | Get billing usage
+*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_delete**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_delete) | **DELETE** /api/v1/team/notifications/channels/{channelId} | Delete notification channel
+*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_put**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_put) | **PUT** /api/v1/team/notifications/channels/{channelId} | Update notification channel
+*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_test_post**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_test_post) | **POST** /api/v1/team/notifications/channels/{channelId}/test | Test notification channel
+*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_get**](docs/ChannelsApi.md#api_v1_team_notifications_channels_get) | **GET** /api/v1/team/notifications/channels | List notification channels
+*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_post**](docs/ChannelsApi.md#api_v1_team_notifications_channels_post) | **POST** /api/v1/team/notifications/channels | Create notification channel
+*Emailguard::EmailApi* | [**api_v1_emails_detect_get**](docs/EmailApi.md#api_v1_emails_detect_get) | **GET** /api/v1/emails/detect | Detect email characteristics
+*Emailguard::EventsApi* | [**api_v1_team_notifications_events_get**](docs/EventsApi.md#api_v1_team_notifications_events_get) | **GET** /api/v1/team/notifications/events | List notification events
+*Emailguard::InvitesApi* | [**api_v1_team_members_invites_get**](docs/InvitesApi.md#api_v1_team_members_invites_get) | **GET** /api/v1/team/members/invites | List pending team invites
+*Emailguard::InvitesApi* | [**api_v1_team_members_invites_invite_id_delete**](docs/InvitesApi.md#api_v1_team_members_invites_invite_id_delete) | **DELETE** /api/v1/team/members/invites/{inviteId} | Cancel a pending invite
+*Emailguard::InvitesApi* | [**api_v1_team_members_invites_post**](docs/InvitesApi.md#api_v1_team_members_invites_post) | **POST** /api/v1/team/members/invites | Invite a team member
+*Emailguard::MembersApi* | [**api_v1_team_members_get**](docs/MembersApi.md#api_v1_team_members_get) | **GET** /api/v1/team/members | List team members
+*Emailguard::MembersApi* | [**api_v1_team_members_user_id_delete**](docs/MembersApi.md#api_v1_team_members_user_id_delete) | **DELETE** /api/v1/team/members/{userId} | Remove a team member
+*Emailguard::MembersApi* | [**api_v1_team_members_user_id_patch**](docs/MembersApi.md#api_v1_team_members_user_id_patch) | **PATCH** /api/v1/team/members/{userId} | Update a team member role
+*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_get**](docs/RulesApi.md#api_v1_team_notifications_rules_get) | **GET** /api/v1/team/notifications/rules | List notification rules
+*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_post**](docs/RulesApi.md#api_v1_team_notifications_rules_post) | **POST** /api/v1/team/notifications/rules | Create notification rule
+*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_rule_id_delete**](docs/RulesApi.md#api_v1_team_notifications_rules_rule_id_delete) | **DELETE** /api/v1/team/notifications/rules/{ruleId} | Delete notification rule
+*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_rule_id_put**](docs/RulesApi.md#api_v1_team_notifications_rules_rule_id_put) | **PUT** /api/v1/team/notifications/rules/{ruleId} | Update notification rule
+*Emailguard::TeamsApi* | [**api_v1_team_get**](docs/TeamsApi.md#api_v1_team_get) | **GET** /api/v1/team | Get team
+*Emailguard::TeamsApi* | [**api_v1_team_patch**](docs/TeamsApi.md#api_v1_team_patch) | **PATCH** /api/v1/team | Update team
+
+
+## Documentation for Models
+
+ - [Emailguard::BaseResponse](docs/BaseResponse.md)
+ - [Emailguard::BillingUsageEvent](docs/BillingUsageEvent.md)
+ - [Emailguard::BillingUsageItem](docs/BillingUsageItem.md)
+ - [Emailguard::BillingUsageResponse](docs/BillingUsageResponse.md)
+ - [Emailguard::CreateNotificationChannelInput](docs/CreateNotificationChannelInput.md)
+ - [Emailguard::CreateNotificationRuleInput](docs/CreateNotificationRuleInput.md)
+ - [Emailguard::EmailDetectData](docs/EmailDetectData.md)
+ - [Emailguard::EmailDetectResponse](docs/EmailDetectResponse.md)
+ - [Emailguard::GetNotificationChannelResponse](docs/GetNotificationChannelResponse.md)
+ - [Emailguard::GetNotificationChannelsResponse](docs/GetNotificationChannelsResponse.md)
+ - [Emailguard::GetNotificationEventsResponse](docs/GetNotificationEventsResponse.md)
+ - [Emailguard::GetNotificationRulesResponse](docs/GetNotificationRulesResponse.md)
+ - [Emailguard::GetPublicTeamResponse](docs/GetPublicTeamResponse.md)
+ - [Emailguard::IdDataResponse](docs/IdDataResponse.md)
+ - [Emailguard::IdDataStruct](docs/IdDataStruct.md)
+ - [Emailguard::InviteTeamMemberInput](docs/InviteTeamMemberInput.md)
+ - [Emailguard::ListPublicTeamInvitesResponse](docs/ListPublicTeamInvitesResponse.md)
+ - [Emailguard::ListPublicTeamMembersResponse](docs/ListPublicTeamMembersResponse.md)
+ - [Emailguard::MessageResponse](docs/MessageResponse.md)
+ - [Emailguard::NotificationChannelResponse](docs/NotificationChannelResponse.md)
+ - [Emailguard::NotificationRuleChannelInput](docs/NotificationRuleChannelInput.md)
+ - [Emailguard::NotificationRuleChannelResponse](docs/NotificationRuleChannelResponse.md)
+ - [Emailguard::NotificationRuleResponse](docs/NotificationRuleResponse.md)
+ - [Emailguard::PublicTeamInviteResponse](docs/PublicTeamInviteResponse.md)
+ - [Emailguard::PublicTeamMemberResponse](docs/PublicTeamMemberResponse.md)
+ - [Emailguard::PublicTeamResponse](docs/PublicTeamResponse.md)
+ - [Emailguard::UpdateNotificationChannelInput](docs/UpdateNotificationChannelInput.md)
+ - [Emailguard::UpdateNotificationRuleInput](docs/UpdateNotificationRuleInput.md)
+ - [Emailguard::UpdateTeamInput](docs/UpdateTeamInput.md)
+ - [Emailguard::UpdateTeamMemberInput](docs/UpdateTeamMemberInput.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+### BasicAuth
+
+- **Type**: HTTP basic authentication
+
+### BearerAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/BaseResponse.md

@@ -0,0 +1,20 @@
+# Emailguard::BaseResponse
+
+## 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::BaseResponse.new(
+  code: null,
+  message: null
+)
+```
+

data/docs/BillingApi.md

@@ -0,0 +1,85 @@
+# Emailguard::BillingApi
+
+All URIs are relative to *http://api.emailguard.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**api_v1_team_billing_usage_get**](BillingApi.md#api_v1_team_billing_usage_get) | **GET** /api/v1/team/billing/usage | Get billing usage |
+
+
+## api_v1_team_billing_usage_get
+
+> <BillingUsageResponse> api_v1_team_billing_usage_get(opts)
+
+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.
+
+### 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::BillingApi.new
+opts = {
+  range: 'current', # String | Period selector: current, previous, or custom
+  start: 'start_example', # String | Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+  _end: '_end_example' # String | Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+}
+
+begin
+  # Get billing usage
+  result = api_instance.api_v1_team_billing_usage_get(opts)
+  p result
+rescue Emailguard::ApiError => e
+  puts "Error when calling BillingApi->api_v1_team_billing_usage_get: #{e}"
+end
+```
+
+#### Using the api_v1_team_billing_usage_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingUsageResponse>, Integer, Hash)> api_v1_team_billing_usage_get_with_http_info(opts)
+
+```ruby
+begin
+  # Get billing usage
+  data, status_code, headers = api_instance.api_v1_team_billing_usage_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingUsageResponse>
+rescue Emailguard::ApiError => e
+  puts "Error when calling BillingApi->api_v1_team_billing_usage_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **range** | **String** | Period selector: current, previous, or custom | [optional] |
+| **start** | **String** | Custom range start (RFC3339 or YYYY-MM-DD); required when range&#x3D;custom | [optional] |
+| **_end** | **String** | Custom range end (RFC3339 or YYYY-MM-DD); required when range&#x3D;custom | [optional] |
+
+### Return type
+
+[**BillingUsageResponse**](BillingUsageResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BillingUsageEvent.md

@@ -0,0 +1,26 @@
+# Emailguard::BillingUsageEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delta** | **Integer** |  |  |
+| **event_type** | **String** |  |  |
+| **metadata** | **String** |  |  |
+| **usage_after** | **Integer** |  |  |
+| **usage_before** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::BillingUsageEvent.new(
+  delta: null,
+  event_type: null,
+  metadata: null,
+  usage_after: null,
+  usage_before: null
+)
+```
+

data/docs/BillingUsageItem.md

@@ -0,0 +1,28 @@
+# Emailguard::BillingUsageItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<BillingUsageEvent>**](BillingUsageEvent.md) |  | [optional] |
+| **feature_key** | **String** |  |  |
+| **limit** | **Integer** |  | [optional] |
+| **period_end** | **String** |  |  |
+| **period_start** | **String** |  |  |
+| **usage** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'emailguard_sdk'
+
+instance = Emailguard::BillingUsageItem.new(
+  events: null,
+  feature_key: null,
+  limit: null,
+  period_end: null,
+  period_start: null,
+  usage: null
+)
+```
+

data/docs/BillingUsageResponse.md

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