ExStreamClient.Operations.Blocklists (ExStreamClient v0.1.2)
View SourceModules for interacting with the `blocklists` group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
@spec create_block_list(ExStreamClient.Model.CreateBlockListRequest.t()) :: {:ok, ExStreamClient.Model.CreateBlockListResponse.t()} | {:error, any()}
Creates a new application blocklist, once created the blocklist can be used by any channel type
### Required Arguments:
- `payload`: CreateBlockListRequest
@spec delete_block_list(String.t(), [{:team, String.t()}]) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes previously created application blocklist
### Required Arguments:
- `name`
### Optional Arguments:
- `team`
@spec get_block_list(String.t(), [{:team, String.t()}]) :: {:ok, ExStreamClient.Model.GetBlockListResponse.t()} | {:error, any()}
Returns block list by given name
### Required Arguments:
- `name`
### Optional Arguments:
- `team`
@spec list_block_lists([{:team, String.t()}]) :: {:ok, ExStreamClient.Model.ListBlockListResponse.t()} | {:error, any()}
Returns all available block lists
### Required Arguments:
### Optional Arguments:
- `team`
@spec update_block_list(String.t(), ExStreamClient.Model.UpdateBlockListRequest.t()) :: {:ok, ExStreamClient.Model.UpdateBlockListResponse.t()} | {:error, any()}
Updates contents of the block list
### Required Arguments:
- `name`
- `payload`: UpdateBlockListRequest