Ory.Api.Events (ory_client v1.6.2)

API calls for all endpoints tagged Events.

Summary

Functions

create_event_stream(connection, project_id, create_event_stream_body, opts \\ [])

Create an event stream for your project.

delete_event_stream(connection, project_id, event_stream_id, opts \\ [])

Remove an event stream from a project Remove an event stream from a project.

list_event_streams(connection, project_id, opts \\ [])

List all event streams for the project. This endpoint is not paginated.

set_event_stream(connection, project_id, event_stream_id, opts \\ [])

Update an event stream for a project.

Functions

Link to this function

create_event_stream(connection, project_id, create_event_stream_body, opts \\ [])

@spec create_event_stream(
  Tesla.Env.client(),
  String.t(),
  Ory.Model.CreateEventStreamBody.t(),
  keyword()
) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, Ory.Model.EventStream.t()}
  | {:error, Tesla.Env.t()}

Create an event stream for your project.

Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • create_event_stream_body (CreateEventStreamBody):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Ory.Model.EventStream.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_event_stream(connection, project_id, event_stream_id, opts \\ [])

@spec delete_event_stream(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.ErrorGeneric.t()} | {:error, Tesla.Env.t()}

Remove an event stream from a project Remove an event stream from a project.

Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • event_stream_id (String.t): Event Stream ID The ID of the event stream to be deleted, as returned when created.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

list_event_streams(connection, project_id, opts \\ [])

@spec list_event_streams(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, Ory.Model.ListEventStreams.t()}
  | {:error, Tesla.Env.t()}

List all event streams for the project. This endpoint is not paginated.

Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, Ory.Model.ListEventStreams.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

set_event_stream(connection, project_id, event_stream_id, opts \\ [])

@spec set_event_stream(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, Ory.Model.EventStream.t()}
  | {:error, Tesla.Env.t()}

Update an event stream for a project.

Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • event_stream_id (String.t): Event Stream ID The event stream's ID.
  • opts (keyword): Optional parameters
    • :body (SetEventStreamBody):

Returns

  • {:ok, Ory.Model.EventStream.t} on success
  • {:error, Tesla.Env.t} on failure