emailguard-sdk 1.0.0

EmailGuard Public API

emailguard-sdk

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 Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.0
• Generator version: 7.23.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://emailguard.co

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/emailguard/emailguard-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/emailguard/emailguard-python.git)

Then import the package:

import emailguard_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import emailguard_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import emailguard_sdk
from emailguard_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://api.emailguard.co
# See configuration.py for a list of all supported configuration parameters.
configuration = emailguard_sdk.Configuration(
    host = "http://api.emailguard.co"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with emailguard_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = emailguard_sdk.BillingApi(api_client)
    range = 'range_example' # str | Period selector: current, previous, or custom (optional)
    start = 'start_example' # str | Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom (optional)
    end = 'end_example' # str | Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom (optional)

    try:
        # Get billing usage
        api_response = api_instance.api_v1_team_billing_usage_get(range=range, start=start, end=end)
        print("The response of BillingApi->api_v1_team_billing_usage_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->api_v1_team_billing_usage_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://api.emailguard.co

Class	Method	HTTP request	Description
BillingApi	api_v1_team_billing_usage_get	GET /api/v1/team/billing/usage	Get billing usage
ChannelsApi	api_v1_team_notifications_channels_channel_id_delete	DELETE /api/v1/team/notifications/channels/{channelId}	Delete notification channel
ChannelsApi	api_v1_team_notifications_channels_channel_id_put	PUT /api/v1/team/notifications/channels/{channelId}	Update notification channel
ChannelsApi	api_v1_team_notifications_channels_channel_id_test_post	POST /api/v1/team/notifications/channels/{channelId}/test	Test notification channel
ChannelsApi	api_v1_team_notifications_channels_get	GET /api/v1/team/notifications/channels	List notification channels
ChannelsApi	api_v1_team_notifications_channels_post	POST /api/v1/team/notifications/channels	Create notification channel
EventsApi	api_v1_team_notifications_events_get	GET /api/v1/team/notifications/events	List notification events
InvitesApi	api_v1_team_members_invites_get	GET /api/v1/team/members/invites	List pending team invites
InvitesApi	api_v1_team_members_invites_invite_id_delete	DELETE /api/v1/team/members/invites/{inviteId}	Cancel a pending invite
InvitesApi	api_v1_team_members_invites_post	POST /api/v1/team/members/invites	Invite a team member
MembersApi	api_v1_team_members_get	GET /api/v1/team/members	List team members
MembersApi	api_v1_team_members_user_id_delete	DELETE /api/v1/team/members/{userId}	Remove a team member
MembersApi	api_v1_team_members_user_id_patch	PATCH /api/v1/team/members/{userId}	Update a team member role
RulesApi	api_v1_team_notifications_rules_get	GET /api/v1/team/notifications/rules	List notification rules
RulesApi	api_v1_team_notifications_rules_post	POST /api/v1/team/notifications/rules	Create notification rule
RulesApi	api_v1_team_notifications_rules_rule_id_delete	DELETE /api/v1/team/notifications/rules/{ruleId}	Delete notification rule
RulesApi	api_v1_team_notifications_rules_rule_id_put	PUT /api/v1/team/notifications/rules/{ruleId}	Update notification rule
TeamsApi	api_v1_team_get	GET /api/v1/team	Get team
TeamsApi	api_v1_team_patch	PATCH /api/v1/team	Update team
EmailApi	api_v1_emails_detect_get	GET /api/v1/emails/detect	Detect email characteristics

Documentation For Models

• BaseResponse
• BillingUsageEvent
• BillingUsageItem
• BillingUsageResponse
• CreateNotificationChannelInput
• CreateNotificationRuleInput
• EmailDetectData
• EmailDetectResponse
• GetNotificationChannelResponse
• GetNotificationChannelsResponse
• GetNotificationEventsResponse
• GetNotificationRulesResponse
• GetPublicTeamResponse
• IdDataResponse
• IdDataStruct
• InviteTeamMemberInput
• ListPublicTeamInvitesResponse
• ListPublicTeamMembersResponse
• MessageResponse
• NotificationChannelResponse
• NotificationRuleChannelInput
• NotificationRuleChannelResponse
• NotificationRuleResponse
• PublicTeamInviteResponse
• PublicTeamMemberResponse
• PublicTeamResponse
• UpdateNotificationChannelInput
• UpdateNotificationRuleInput
• UpdateTeamInput
• UpdateTeamMemberInput

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

Author

[e-mail]