emailguard-sdk 1.0.0__py3-none-any.whl

emailguard_sdk/__init__.py

@@ -0,0 +1,123 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    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 OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "BillingApi",
+    "ChannelsApi",
+    "EventsApi",
+    "InvitesApi",
+    "MembersApi",
+    "RulesApi",
+    "TeamsApi",
+    "EmailApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "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",
+]
+
+# import apis into sdk package
+from emailguard_sdk.api.billing_api import BillingApi as BillingApi
+from emailguard_sdk.api.channels_api import ChannelsApi as ChannelsApi
+from emailguard_sdk.api.events_api import EventsApi as EventsApi
+from emailguard_sdk.api.invites_api import InvitesApi as InvitesApi
+from emailguard_sdk.api.members_api import MembersApi as MembersApi
+from emailguard_sdk.api.rules_api import RulesApi as RulesApi
+from emailguard_sdk.api.teams_api import TeamsApi as TeamsApi
+from emailguard_sdk.api.email_api import EmailApi as EmailApi
+
+# import ApiClient
+from emailguard_sdk.api_response import ApiResponse as ApiResponse
+from emailguard_sdk.api_client import ApiClient as ApiClient
+from emailguard_sdk.configuration import Configuration as Configuration
+from emailguard_sdk.exceptions import OpenApiException as OpenApiException
+from emailguard_sdk.exceptions import ApiTypeError as ApiTypeError
+from emailguard_sdk.exceptions import ApiValueError as ApiValueError
+from emailguard_sdk.exceptions import ApiKeyError as ApiKeyError
+from emailguard_sdk.exceptions import ApiAttributeError as ApiAttributeError
+from emailguard_sdk.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from emailguard_sdk.models.base_response import BaseResponse as BaseResponse
+from emailguard_sdk.models.billing_usage_event import BillingUsageEvent as BillingUsageEvent
+from emailguard_sdk.models.billing_usage_item import BillingUsageItem as BillingUsageItem
+from emailguard_sdk.models.billing_usage_response import BillingUsageResponse as BillingUsageResponse
+from emailguard_sdk.models.create_notification_channel_input import CreateNotificationChannelInput as CreateNotificationChannelInput
+from emailguard_sdk.models.create_notification_rule_input import CreateNotificationRuleInput as CreateNotificationRuleInput
+from emailguard_sdk.models.email_detect_data import EmailDetectData as EmailDetectData
+from emailguard_sdk.models.email_detect_response import EmailDetectResponse as EmailDetectResponse
+from emailguard_sdk.models.get_notification_channel_response import GetNotificationChannelResponse as GetNotificationChannelResponse
+from emailguard_sdk.models.get_notification_channels_response import GetNotificationChannelsResponse as GetNotificationChannelsResponse
+from emailguard_sdk.models.get_notification_events_response import GetNotificationEventsResponse as GetNotificationEventsResponse
+from emailguard_sdk.models.get_notification_rules_response import GetNotificationRulesResponse as GetNotificationRulesResponse
+from emailguard_sdk.models.get_public_team_response import GetPublicTeamResponse as GetPublicTeamResponse
+from emailguard_sdk.models.id_data_response import IdDataResponse as IdDataResponse
+from emailguard_sdk.models.id_data_struct import IdDataStruct as IdDataStruct
+from emailguard_sdk.models.invite_team_member_input import InviteTeamMemberInput as InviteTeamMemberInput
+from emailguard_sdk.models.list_public_team_invites_response import ListPublicTeamInvitesResponse as ListPublicTeamInvitesResponse
+from emailguard_sdk.models.list_public_team_members_response import ListPublicTeamMembersResponse as ListPublicTeamMembersResponse
+from emailguard_sdk.models.message_response import MessageResponse as MessageResponse
+from emailguard_sdk.models.notification_channel_response import NotificationChannelResponse as NotificationChannelResponse
+from emailguard_sdk.models.notification_rule_channel_input import NotificationRuleChannelInput as NotificationRuleChannelInput
+from emailguard_sdk.models.notification_rule_channel_response import NotificationRuleChannelResponse as NotificationRuleChannelResponse
+from emailguard_sdk.models.notification_rule_response import NotificationRuleResponse as NotificationRuleResponse
+from emailguard_sdk.models.public_team_invite_response import PublicTeamInviteResponse as PublicTeamInviteResponse
+from emailguard_sdk.models.public_team_member_response import PublicTeamMemberResponse as PublicTeamMemberResponse
+from emailguard_sdk.models.public_team_response import PublicTeamResponse as PublicTeamResponse
+from emailguard_sdk.models.update_notification_channel_input import UpdateNotificationChannelInput as UpdateNotificationChannelInput
+from emailguard_sdk.models.update_notification_rule_input import UpdateNotificationRuleInput as UpdateNotificationRuleInput
+from emailguard_sdk.models.update_team_input import UpdateTeamInput as UpdateTeamInput
+from emailguard_sdk.models.update_team_member_input import UpdateTeamMemberInput as UpdateTeamMemberInput
+

emailguard_sdk/api/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+# import apis into api package
+from emailguard_sdk.api.billing_api import BillingApi
+from emailguard_sdk.api.channels_api import ChannelsApi
+from emailguard_sdk.api.events_api import EventsApi
+from emailguard_sdk.api.invites_api import InvitesApi
+from emailguard_sdk.api.members_api import MembersApi
+from emailguard_sdk.api.rules_api import RulesApi
+from emailguard_sdk.api.teams_api import TeamsApi
+from emailguard_sdk.api.email_api import EmailApi
+

emailguard_sdk/api/billing_api.py

@@ -0,0 +1,348 @@
+"""
+    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 OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr, field_validator
+from typing import Optional
+from typing_extensions import Annotated
+from emailguard_sdk.models.billing_usage_response import BillingUsageResponse
+
+from emailguard_sdk.api_client import ApiClient, RequestSerialized
+from emailguard_sdk.api_response import ApiResponse
+from emailguard_sdk.rest import RESTResponseType
+
+
+class BillingApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def api_v1_team_billing_usage_get(
+        self,
+        range: Annotated[Optional[StrictStr], Field(description="Period selector: current, previous, or custom")] = None,
+        start: Annotated[Optional[StrictStr], Field(description="Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        end: Annotated[Optional[StrictStr], Field(description="Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> BillingUsageResponse:
+        """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 range: Period selector: current, previous, or custom
+        :type range: str
+        :param start: Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type start: str
+        :param end: Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type end: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._api_v1_team_billing_usage_get_serialize(
+            range=range,
+            start=start,
+            end=end,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BillingUsageResponse",
+            '400': "BaseResponse",
+            '401': "BaseResponse",
+            '403': "BaseResponse",
+            '404': "BaseResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def api_v1_team_billing_usage_get_with_http_info(
+        self,
+        range: Annotated[Optional[StrictStr], Field(description="Period selector: current, previous, or custom")] = None,
+        start: Annotated[Optional[StrictStr], Field(description="Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        end: Annotated[Optional[StrictStr], Field(description="Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[BillingUsageResponse]:
+        """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 range: Period selector: current, previous, or custom
+        :type range: str
+        :param start: Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type start: str
+        :param end: Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type end: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._api_v1_team_billing_usage_get_serialize(
+            range=range,
+            start=start,
+            end=end,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BillingUsageResponse",
+            '400': "BaseResponse",
+            '401': "BaseResponse",
+            '403': "BaseResponse",
+            '404': "BaseResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def api_v1_team_billing_usage_get_without_preload_content(
+        self,
+        range: Annotated[Optional[StrictStr], Field(description="Period selector: current, previous, or custom")] = None,
+        start: Annotated[Optional[StrictStr], Field(description="Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        end: Annotated[Optional[StrictStr], Field(description="Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """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 range: Period selector: current, previous, or custom
+        :type range: str
+        :param start: Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type start: str
+        :param end: Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
+        :type end: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._api_v1_team_billing_usage_get_serialize(
+            range=range,
+            start=start,
+            end=end,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "BillingUsageResponse",
+            '400': "BaseResponse",
+            '401': "BaseResponse",
+            '403': "BaseResponse",
+            '404': "BaseResponse",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _api_v1_team_billing_usage_get_serialize(
+        self,
+        range,
+        start,
+        end,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if range is not None:
+            
+            _query_params.append(('range', range))
+            
+        if start is not None:
+            
+            _query_params.append(('start', start))
+            
+        if end is not None:
+            
+            _query_params.append(('end', end))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'ApiKeyAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/team/billing/usage',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+