ExStreamClient.Operations.Blocklists (ExStreamClient v0.1.0)

View Source
Modules for interacting with the `blocklists` group of OpenAI APIs

API Reference: https://platform.openai.com/docs/api-reference/blocklists

Summary

Functions

create_block_list(payload)

Creates a new application blocklist, once created the blocklist can be used by any channel type


### Required Arguments:
    - `payload`: CreateBlockListRequest

delete_block_list(name, opts \\ [])

@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`

get_block_list(name, opts \\ [])

@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`

list_block_lists(opts \\ [])

@spec list_block_lists([{:team, String.t()}]) ::
  {:ok, ExStreamClient.Model.ListBlockListResponse.t()} | {:error, any()}
Returns all available block lists


### Required Arguments:

### Optional Arguments:
    - `team`

update_block_list(name, payload)

Updates contents of the block list


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