Auth0.Management.Emails (Auth0Api v1.4.0) View Source

Documentation for Auth0 Management API of Emails.

endpoint

/api/v2/emails/provider

Link to this section Summary

Types

config()

error()

response_body()

Functions

configure_provider(params, config)

Configure the email provider.

delete_provider(config)

Delete the email provider.

get_provider(params, config)

Get the email provider.

update_provider(params, config)

Update the email provider.

Link to this section Types

config()

Specs

config() :: Auth0.Config.t()

error()

Specs

error() :: {:error, integer(), term()} | {:error, term()}

response_body()

Specs

response_body() :: String.t()

Link to this section Functions

configure_provider(params, config)

Specs

configure_provider(
  Auth0.Management.Emails.Provider.Configure.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()

Configure the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/post_provider

delete_provider(config)

Specs

delete_provider(config()) :: {:ok, String.t(), response_body()} | error()

Delete the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/delete_provider

get_provider(params, config)

Specs

get_provider(Auth0.Management.Emails.Provider.Get.Params.t() | map(), config()) ::
  {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()

Get the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/get_provider

update_provider(params, config)

Specs

update_provider(
  Auth0.Management.Emails.Provider.Patch.Params.t() | map(),
  config()
) ::
  {:ok, Auth0.Entity.EmailProvider.t(), response_body()} | error()

Update the email provider.

see

https://auth0.com/docs/api/management/v2/#!/Emails/patch_provider