View Source Auth0.Management.EventStreams (Auth0Api v2.5.1)

Facade for the Auth0 Management API Event Streams endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()
id()

Functions

create(params, config)

Create an event stream.

delete(id, config)

Delete an event stream.

get(id, config)

Retrieve an event stream by its ID.

get_delivery(id, event_id, config)

Get a specific event's delivery history.

list(params, config)

Retrieve all event streams.

list_deliveries(id, params, config)

Get this event stream's delivery history.

redeliver(id, params, config)

Redeliver failed events.

redeliver_by_id(id, event_id, config)

Redeliver a single failed event by ID.

test(id, params, config)

Send a test event to an event stream.

update(id, params, config)

Update an event stream.

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

View Source 
@type error() :: {:error, integer(), term()} | {:error, term()}
Link to this type

id()

View Source 
@type id() :: String.t()

Functions

Link to this function

create(params, config)

View Source 
@spec create(map(), config()) :: {:ok, map()} | error()

Create an event stream.

see

https://auth0.com/docs/api/management/v2/event-streams/post-event-streams

Link to this function

delete(id, config)

View Source 
@spec delete(id(), config()) :: {:ok, String.t()} | error()

Delete an event stream.

see

https://auth0.com/docs/api/management/v2/event-streams/delete-event-streams-by-id

Link to this function

get(id, config)

View Source 
@spec get(id(), config()) :: {:ok, map()} | error()

Retrieve an event stream by its ID.

see

https://auth0.com/docs/api/management/v2/event-streams/get-event-streams-by-id

Link to this function

get_delivery(id, event_id, config)

View Source 
@spec get_delivery(String.t(), String.t(), config()) :: {:ok, map()} | error()

Get a specific event's delivery history.

see

https://auth0.com/docs/api/management/v2/event-streams/get-deliveries-by-event-id

Link to this function

list(params, config)

View Source 
@spec list(map(), config()) :: {:ok, [map()]} | error()

Retrieve all event streams.

see

https://auth0.com/docs/api/management/v2/event-streams/get-event-streams

Link to this function

list_deliveries(id, params, config)

View Source 
@spec list_deliveries(String.t(), map(), config()) :: {:ok, map()} | error()

Get this event stream's delivery history.

see

https://auth0.com/docs/api/management/v2/event-streams/get-event-deliveries

Link to this function

redeliver(id, params, config)

View Source 
@spec redeliver(String.t(), map(), config()) :: {:ok, map()} | error()

Redeliver failed events.

see

https://auth0.com/docs/api/management/v2/event-streams/post-redeliver

Link to this function

redeliver_by_id(id, event_id, config)

View Source 
@spec redeliver_by_id(String.t(), String.t(), config()) :: {:ok, String.t()} | error()

Redeliver a single failed event by ID.

see

https://auth0.com/docs/api/management/v2/event-streams/post-redeliver-by-event-id

Link to this function

test(id, params, config)

View Source 
@spec test(String.t(), map(), config()) :: {:ok, map()} | error()

Send a test event to an event stream.

see

https://auth0.com/docs/api/management/v2/event-streams/post-test-event

Link to this function

update(id, params, config)

View Source 
@spec update(id(), map(), config()) :: {:ok, map()} | error()

Update an event stream.

see

https://auth0.com/docs/api/management/v2/event-streams/patch-event-streams-by-id