ExStreamClient.Operations.Chat.Commands (ExStreamClient v0.1.2)

View Source
Modules for interacting with the `chat/commands` group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Summary

Functions

create_command(payload)

Creates custom chat command


### Required Arguments:
    - `payload`: CreateCommandRequest

delete_command(name)

@spec delete_command(String.t()) ::
  {:ok, ExStreamClient.Model.DeleteCommandResponse.t()} | {:error, any()}
Deletes custom chat command


### Required Arguments:
    - `name`

get_command(name)

@spec get_command(String.t()) ::
  {:ok, ExStreamClient.Model.GetCommandResponse.t()} | {:error, any()}
Returns custom command by its name


### Required Arguments:
    - `name`

list_commands()

@spec list_commands() ::
  {:ok, ExStreamClient.Model.ListCommandsResponse.t()} | {:error, any()}
Returns all custom commands


### Required Arguments:

update_command(name, payload)

Updates custom chat command


### Required Arguments:
    - `name`
    - `payload`: UpdateCommandRequest