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

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.

list(params, config)

Retrieve all event streams.

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

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

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