ExStreamClient.Operations.Chat.Commands (ExStreamClient v0.1.2)
View SourceModules for interacting with the `chat/commands` group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
@spec create_command(ExStreamClient.Model.CreateCommandRequest.t()) :: {:ok, ExStreamClient.Model.CreateCommandResponse.t()} | {:error, any()}
Creates custom chat command
### Required Arguments:
- `payload`: CreateCommandRequest
@spec delete_command(String.t()) :: {:ok, ExStreamClient.Model.DeleteCommandResponse.t()} | {:error, any()}
Deletes custom chat command
### Required Arguments:
- `name`
@spec get_command(String.t()) :: {:ok, ExStreamClient.Model.GetCommandResponse.t()} | {:error, any()}
Returns custom command by its name
### Required Arguments:
- `name`
@spec list_commands() :: {:ok, ExStreamClient.Model.ListCommandsResponse.t()} | {:error, any()}
Returns all custom commands
### Required Arguments:
@spec update_command(String.t(), ExStreamClient.Model.UpdateCommandRequest.t()) :: {:ok, ExStreamClient.Model.UpdateCommandResponse.t()} | {:error, any()}
Updates custom chat command
### Required Arguments:
- `name`
- `payload`: UpdateCommandRequest