# `Ory.Api.Events`

API calls for all endpoints tagged `Events`.

# `create_event_stream`

```elixir
@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

# `delete_event_stream`

```elixir
@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

# `list_event_streams`

```elixir
@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

# `set_event_stream`

```elixir
@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

---

*Consult [api-reference.md](api-reference.md) for complete listing*