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

Schema representing a BanActionRequestPayload

# `t`

```elixir
@type t() :: %ExStreamClient.Model.BanActionRequestPayload{
  ban_from_future_channels: boolean() | nil,
  channel_ban_only: boolean() | 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() | nil,
  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*