ExStreamClient.Operations.Chat.Polls (ExStreamClient v0.1.0)

View Source 
Modules for interacting with the `chat/polls` group of OpenAI APIs

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

Summary

Functions

create_poll(payload)
create_poll_option(poll_id, payload)
delete_poll(poll_id, opts \\ [])
delete_poll_option(poll_id, option_id, opts \\ [])
get_poll(poll_id, opts \\ [])
get_poll_option(poll_id, option_id, opts \\ [])
query_poll_votes(poll_id, payload, opts \\ [])
query_polls(payload, opts \\ [])
update_poll(payload)
update_poll_option(poll_id, payload)
update_poll_partial(poll_id, payload)

Functions

create_poll(payload)

@spec create_poll(ExStreamClient.Model.CreatePollRequest.t()) ::
  {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
Creates a new poll


### Required Arguments:
    - `payload`: CreatePollRequest

create_poll_option(poll_id, payload)

@spec create_poll_option(String.t(), ExStreamClient.Model.CreatePollOptionRequest.t()) ::
  {:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
Creates a poll option

Sends events:

  • poll.updated

    ### Required Arguments:

      - `poll_id`
  - `payload`: CreatePollOptionRequest

delete_poll(poll_id, opts \\ [])

@spec delete_poll(String.t(), [{:user_id, String.t()}]) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes a poll

Sends events:

  • poll.deleted

    ### Required Arguments:

      - `poll_id`

    ### Optional Arguments:

      - `user_id`

delete_poll_option(poll_id, option_id, opts \\ [])

@spec delete_poll_option(String.t(), String.t(), [{:user_id, String.t()}]) ::
  {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
Deletes a poll option

Sends events:

  • poll.updated

    ### Required Arguments:

      - `poll_id`
  - `option_id`

    ### Optional Arguments:

      - `user_id`

get_poll(poll_id, opts \\ [])

@spec get_poll(String.t(), [{:user_id, String.t()}]) ::
  {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
Retrieves a poll


### Required Arguments:
    - `poll_id`
### Optional Arguments:
    - `user_id`

get_poll_option(poll_id, option_id, opts \\ [])

@spec get_poll_option(String.t(), String.t(), [{:user_id, String.t()}]) ::
  {:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
Retrieves a poll option


### Required Arguments:
    - `poll_id`
    - `option_id`
### Optional Arguments:
    - `user_id`

query_poll_votes(poll_id, payload, opts \\ [])

@spec query_poll_votes(String.t(), ExStreamClient.Model.QueryPollVotesRequest.t(), [
  {:user_id, String.t()}
]) :: {:ok, ExStreamClient.Model.PollVotesResponse.t()} | {:error, any()}
Queries votes


### Required Arguments:
    - `poll_id`
    - `payload`: QueryPollVotesRequest
### Optional Arguments:
    - `user_id`

query_polls(payload, opts \\ [])

@spec query_polls(ExStreamClient.Model.QueryPollsRequest.t(), [{:user_id, String.t()}]) ::
  {:ok, ExStreamClient.Model.QueryPollsResponse.t()} | {:error, any()}
Queries polls


### Required Arguments:
    - `payload`: QueryPollsRequest
### Optional Arguments:
    - `user_id`

update_poll(payload)

@spec update_poll(ExStreamClient.Model.UpdatePollRequest.t()) ::
  {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
Updates a poll

Sends events:

  • poll.closed

  • poll.updated

    ### Required Arguments:

      - `payload`: UpdatePollRequest

update_poll_option(poll_id, payload)

@spec update_poll_option(String.t(), ExStreamClient.Model.UpdatePollOptionRequest.t()) ::
  {:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
Updates a poll option

Sends events:

  • poll.updated

    ### Required Arguments:

      - `poll_id`
  - `payload`: UpdatePollOptionRequest

update_poll_partial(poll_id, payload)

@spec update_poll_partial(
  String.t(),
  ExStreamClient.Model.UpdatePollPartialRequest.t()
) ::
  {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
Updates a poll partially

Sends events:

  • poll.updated

    ### Required Arguments:

      - `poll_id`
  - `payload`: UpdatePollPartialRequest