emailguard_sdk 1.0.0

data/spec/api/billing_api_spec.rb

@@ -0,0 +1,49 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::BillingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'BillingApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::BillingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BillingApi' do
+    it 'should create an instance of BillingApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::BillingApi)
+    end
+  end
+
+  # unit tests for api_v1_team_billing_usage_get
+  # 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]
+  describe 'api_v1_team_billing_usage_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/channels_api_spec.rb

@@ -0,0 +1,95 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::ChannelsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ChannelsApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::ChannelsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ChannelsApi' do
+    it 'should create an instance of ChannelsApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::ChannelsApi)
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_channels_channel_id_delete
+  # Delete notification channel
+  # Permanently deletes a channel and removes it from any rules that reference it.
+  # @param channel_id UUID of the notification channel to delete
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_notifications_channels_channel_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_channels_channel_id_put
+  # Update notification channel
+  # Updates a channel's display name or configuration. Send only fields you want to change.
+  # @param channel_id UUID of the notification channel to update
+  # @param update_notification_channel_input Updated channel name and/or configuration
+  # @param [Hash] opts the optional parameters
+  # @return [GetNotificationChannelResponse]
+  describe 'api_v1_team_notifications_channels_channel_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_channels_channel_id_test_post
+  # 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 UUID of the webhook channel to test
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_notifications_channels_channel_id_test_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [GetNotificationChannelsResponse]
+  describe 'api_v1_team_notifications_channels_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_channels_post
+  # 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 Channel name, type, and type-specific configuration
+  # @param [Hash] opts the optional parameters
+  # @return [GetNotificationChannelResponse]
+  describe 'api_v1_team_notifications_channels_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/email_api_spec.rb

@@ -0,0 +1,47 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::EmailApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EmailApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::EmailApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailApi' do
+    it 'should create an instance of EmailApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::EmailApi)
+    end
+  end
+
+  # unit tests for api_v1_emails_detect_get
+  # 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 Email address to analyze
+  # @param [Hash] opts the optional parameters
+  # @return [EmailDetectResponse]
+  describe 'api_v1_emails_detect_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/events_api_spec.rb

@@ -0,0 +1,46 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::EventsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EventsApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::EventsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EventsApi' do
+    it 'should create an instance of EventsApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::EventsApi)
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [GetNotificationEventsResponse]
+  describe 'api_v1_team_notifications_events_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/invites_api_spec.rb

@@ -0,0 +1,70 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::InvitesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'InvitesApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::InvitesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InvitesApi' do
+    it 'should create an instance of InvitesApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::InvitesApi)
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [ListPublicTeamInvitesResponse]
+  describe 'api_v1_team_members_invites_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_members_invites_invite_id_delete
+  # 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.
+  # @param invite_id UUID of the pending invite to cancel
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_members_invites_invite_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_members_invites_post
+  # 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.
+  # @param invite_team_member_input Invitee email and role to assign on acceptance
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_members_invites_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/members_api_spec.rb

@@ -0,0 +1,71 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::MembersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MembersApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::MembersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MembersApi' do
+    it 'should create an instance of MembersApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::MembersApi)
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [ListPublicTeamMembersResponse]
+  describe 'api_v1_team_members_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_members_user_id_delete
+  # 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.
+  # @param user_id User account UUID of the member to remove
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_members_user_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_members_user_id_patch
+  # 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).
+  # @param user_id User account UUID of the member to update
+  # @param update_team_member_input New role and/or notes for the member
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_members_user_id_patch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/rules_api_spec.rb

@@ -0,0 +1,83 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::RulesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'RulesApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::RulesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RulesApi' do
+    it 'should create an instance of RulesApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::RulesApi)
+    end
+  end
+
+  # unit tests for 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.
+  # @param [Hash] opts the optional parameters
+  # @return [GetNotificationRulesResponse]
+  describe 'api_v1_team_notifications_rules_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_rules_post
+  # 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.
+  # @param create_notification_rule_input Rule name, event types, and channel targets
+  # @param [Hash] opts the optional parameters
+  # @return [IdDataResponse]
+  describe 'api_v1_team_notifications_rules_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_rules_rule_id_delete
+  # Delete notification rule
+  # Permanently deletes a routing rule and its channel assignments.
+  # @param rule_id UUID of the notification rule to delete
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_notifications_rules_rule_id_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_notifications_rules_rule_id_put
+  # 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.
+  # @param rule_id UUID of the notification rule to update
+  # @param update_notification_rule_input Fields to update on the rule
+  # @param [Hash] opts the optional parameters
+  # @return [MessageResponse]
+  describe 'api_v1_team_notifications_rules_rule_id_put test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/teams_api_spec.rb

@@ -0,0 +1,58 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Emailguard::TeamsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TeamsApi' do
+  before do
+    # run before each test
+    @api_instance = Emailguard::TeamsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TeamsApi' do
+    it 'should create an instance of TeamsApi' do
+      expect(@api_instance).to be_instance_of(Emailguard::TeamsApi)
+    end
+  end
+
+  # unit tests for api_v1_team_get
+  # Get team
+  # Returns profile fields for the team associated with your API key.
+  # @param [Hash] opts the optional parameters
+  # @return [GetPublicTeamResponse]
+  describe 'api_v1_team_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for api_v1_team_patch
+  # 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.
+  # @param update_team_input Team profile fields to update
+  # @param [Hash] opts the optional parameters
+  # @return [GetPublicTeamResponse]
+  describe 'api_v1_team_patch test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/base_response_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Emailguard::BaseResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Emailguard::BaseResponse do
+  #let(:instance) { Emailguard::BaseResponse.new }
+
+  describe 'test an instance of BaseResponse' do
+    it 'should create an instance of BaseResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Emailguard::BaseResponse)
+    end
+  end
+
+  describe 'test attribute "code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/billing_usage_event_spec.rb

@@ -0,0 +1,60 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Emailguard::BillingUsageEvent
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Emailguard::BillingUsageEvent do
+  #let(:instance) { Emailguard::BillingUsageEvent.new }
+
+  describe 'test an instance of BillingUsageEvent' do
+    it 'should create an instance of BillingUsageEvent' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Emailguard::BillingUsageEvent)
+    end
+  end
+
+  describe 'test attribute "delta"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "event_type"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "metadata"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "usage_after"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "usage_before"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end