# `ExStreamClient.Model.BanRequest`
[🔗](https://github.com/Tango-Tango/ex_stream_client/blob/main/lib/ex_stream_client/model/ban_request.ex#L1)

Schema representing a BanRequest

# `t`

```elixir
@type t() :: %ExStreamClient.Model.BanRequest{
  banned_by: ExStreamClient.Model.UserRequest.t() | nil,
  banned_by_id: String.t() | nil,
  channel_cid: String.t() | nil,
  delete_messages: (:hard | :pruning | :soft) | nil,
  ip_ban: boolean() | nil,
  reason: String.t() | nil,
  shadow: boolean() | nil,
  target_user_id: String.t(),
  timeout: integer() | nil
}
```

# `decode`

Components could just be enums that are typed - so we need to decode those as enums as they will just be stings

# `nested_components`

---

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