from __future__ import annotations
from typing import Any
from ..rest import RestClient, RestClientOptions
from ..types import TimeoutType
[docs]class Emails:
"""Auth0 email endpoints
Args:
domain (str): Your Auth0 domain, e.g: 'username.auth0.com'
token (str): Management API v2 Token
telemetry (bool, optional): Enable or disable Telemetry
(defaults to True)
timeout (float or tuple, optional): Change the requests
connect and read timeout. Pass a tuple to specify
both values separately or a float to set both to it.
(defaults to 5.0 for both)
protocol (str, optional): Protocol to use when making requests.
(defaults to "https")
rest_options (RestClientOptions): Pass an instance of
RestClientOptions to configure additional RestClient
options, such as rate-limit retries.
(defaults to None)
"""
def __init__(
self,
domain: str,
token: str,
telemetry: bool = True,
timeout: TimeoutType = 5.0,
protocol: str = "https",
rest_options: RestClientOptions | None = None,
) -> None:
self.domain = domain
self.protocol = protocol
self.client = RestClient(
jwt=token, telemetry=telemetry, timeout=timeout, options=rest_options
)
def _url(self, id: str | None = None) -> str:
url = f"{self.protocol}://{self.domain}/api/v2/emails/provider"
if id is not None:
return f"{url}/{id}"
return url
[docs] def get(
self, fields: list[str] | None = None, include_fields: bool = True
) -> dict[str, Any]:
"""Get the email provider.
Args:
fields (list of str, optional): A list of fields to include or
exclude from the result (depending on include_fields). Leave empty to
retrieve all fields.
include_fields (bool, optional): True if the fields specified are
to be included in the result, False otherwise. Defaults to True.
See: https://auth0.com/docs/api/management/v2#!/Emails/get_provider
"""
params = {
"fields": fields and ",".join(fields) or None,
"include_fields": str(include_fields).lower(),
}
return self.client.get(self._url(), params=params)
[docs] def config(self, body: dict[str, Any]) -> dict[str, Any]:
"""Configure the email provider.
Args:
body (dict): attributes of the created email provider.
See: https://auth0.com/docs/api/v2#!/Emails/post_provider
"""
return self.client.post(self._url(), data=body)
[docs] def delete(self) -> Any:
"""Delete the email provider. (USE WITH CAUTION)
See: https://auth0.com/docs/api/management/v2#!/Emails/delete_provider
"""
return self.client.delete(self._url())
[docs] def update(self, body: dict[str, Any]) -> dict[str, Any]:
"""Update the email provider.
Args:
body (dict): attributes to update on the email provider
See: https://auth0.com/docs/api/v2#!/Emails/patch_provider
"""
return self.client.patch(self._url(), data=body)