Packages

A client for [Stream](https://getstream.io) REST APIs in Elixir - auto generated from their [OpenAPI specification](https://github.com/GetStream/protocol).

Current section

Files

Jump to
ex_stream_client lib ex_stream_client operations chat polls.ex
Raw

lib/ex_stream_client/operations/chat/polls.ex

defmodule ExStreamClient.Operations.Chat.Polls do
@moduledoc ~S"""
Modules for interacting with the `chat/polls` group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
"""
require Logger
@doc ~S"""
Queries votes
### Required Arguments:
- `poll_id`
- `payload`: `Elixir.ExStreamClient.Model.QueryPollVotesRequest`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec query_poll_votes(String.t(), ExStreamClient.Model.QueryPollVotesRequest.t()) ::
{:ok, ExStreamClient.Model.PollVotesResponse.t()} | {:error, any()}
@spec query_poll_votes(String.t(), ExStreamClient.Model.QueryPollVotesRequest.t(), [
{:client, module()} | {:user_id, String.t()}
]) :: {:ok, ExStreamClient.Model.PollVotesResponse.t()} | {:error, any()}
def query_poll_votes(poll_id, payload, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/#{poll_id}/votes",
method: :post,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.PollVotesResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Updates a poll
### Sends events:
- `poll.closed`
- `poll.updated`
### Required Arguments:
- `payload`: `Elixir.ExStreamClient.Model.UpdatePollRequest`
### Optional Arguments:
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec update_poll(ExStreamClient.Model.UpdatePollRequest.t()) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
@spec update_poll(ExStreamClient.Model.UpdatePollRequest.t(), client: module()) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
def update_poll(payload, opts \\ []) do
client = get_client(opts)
request_opts = [url: "/api/v2/chat/polls", method: :put, params: []] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.PollResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Creates a new poll
### Required Arguments:
- `payload`: `Elixir.ExStreamClient.Model.CreatePollRequest`
### Optional Arguments:
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec create_poll(ExStreamClient.Model.CreatePollRequest.t()) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
@spec create_poll(ExStreamClient.Model.CreatePollRequest.t(), client: module()) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
def create_poll(payload, opts \\ []) do
client = get_client(opts)
request_opts = [url: "/api/v2/chat/polls", method: :post, params: []] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.PollResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Updates a poll option
### Sends events:
- `poll.updated`
### Required Arguments:
- `poll_id`
- `payload`: `Elixir.ExStreamClient.Model.UpdatePollOptionRequest`
### Optional Arguments:
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec update_poll_option(String.t(), ExStreamClient.Model.UpdatePollOptionRequest.t()) ::
{:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
@spec update_poll_option(String.t(), ExStreamClient.Model.UpdatePollOptionRequest.t(),
client: module()
) :: {:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
def update_poll_option(poll_id, payload, opts \\ []) do
client = get_client(opts)
request_opts =
[url: "/api/v2/chat/polls/#{poll_id}/options", method: :put, params: []] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.PollOptionResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Creates a poll option
### Sends events:
- `poll.updated`
### Required Arguments:
- `poll_id`
- `payload`: `Elixir.ExStreamClient.Model.CreatePollOptionRequest`
### Optional Arguments:
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec create_poll_option(String.t(), ExStreamClient.Model.CreatePollOptionRequest.t()) ::
{:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
@spec create_poll_option(String.t(), ExStreamClient.Model.CreatePollOptionRequest.t(),
client: module()
) :: {:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
def create_poll_option(poll_id, payload, opts \\ []) do
client = get_client(opts)
request_opts =
[url: "/api/v2/chat/polls/#{poll_id}/options", method: :post, params: []] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.PollOptionResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Updates a poll partially
### Sends events:
- `poll.updated`
### Required Arguments:
- `poll_id`
- `payload`: `Elixir.ExStreamClient.Model.UpdatePollPartialRequest`
### Optional Arguments:
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec update_poll_partial(String.t(), ExStreamClient.Model.UpdatePollPartialRequest.t()) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
@spec update_poll_partial(String.t(), ExStreamClient.Model.UpdatePollPartialRequest.t(),
client: module()
) :: {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
def update_poll_partial(poll_id, payload, opts \\ []) do
client = get_client(opts)
request_opts =
[url: "/api/v2/chat/polls/#{poll_id}", method: :patch, params: []] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
200 => ExStreamClient.Model.PollResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Retrieves a poll
### Required Arguments:
- `poll_id`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec get_poll(String.t()) :: {:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
@spec get_poll(String.t(), [{:client, module()} | {:user_id, String.t()}]) ::
{:ok, ExStreamClient.Model.PollResponse.t()} | {:error, any()}
def get_poll(poll_id, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/#{poll_id}",
method: :get,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ []
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
200 => ExStreamClient.Model.PollResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Deletes a poll
### Sends events:
- `poll.deleted`
### Required Arguments:
- `poll_id`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec delete_poll(String.t()) :: {:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
@spec delete_poll(String.t(), [{:client, module()} | {:user_id, String.t()}]) ::
{:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
def delete_poll(poll_id, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/#{poll_id}",
method: :delete,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ []
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
200 => ExStreamClient.Model.Response,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Queries polls
### Required Arguments:
- `payload`: `Elixir.ExStreamClient.Model.QueryPollsRequest`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec query_polls(ExStreamClient.Model.QueryPollsRequest.t()) ::
{:ok, ExStreamClient.Model.QueryPollsResponse.t()} | {:error, any()}
@spec query_polls(ExStreamClient.Model.QueryPollsRequest.t(), [
{:client, module()} | {:user_id, String.t()}
]) :: {:ok, ExStreamClient.Model.QueryPollsResponse.t()} | {:error, any()}
def query_polls(payload, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/query",
method: :post,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ [json: payload]
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
201 => ExStreamClient.Model.QueryPollsResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Retrieves a poll option
### Required Arguments:
- `poll_id`
- `option_id`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec get_poll_option(String.t(), String.t()) ::
{:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
@spec get_poll_option(String.t(), String.t(), [{:client, module()} | {:user_id, String.t()}]) ::
{:ok, ExStreamClient.Model.PollOptionResponse.t()} | {:error, any()}
def get_poll_option(poll_id, option_id, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/#{poll_id}/options/#{option_id}",
method: :get,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ []
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
200 => ExStreamClient.Model.PollOptionResponse,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
@doc ~S"""
Deletes a poll option
### Sends events:
- `poll.updated`
### Required Arguments:
- `poll_id`
- `option_id`
### Optional Arguments:
- `user_id`
- `client`: HTTP client to use. Must implement `ExStreamClient.Http.Behavior`(e.g., `ExStreamClient.Http`)
"""
@spec delete_poll_option(String.t(), String.t()) ::
{:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
@spec delete_poll_option(String.t(), String.t(), [{:client, module()} | {:user_id, String.t()}]) ::
{:ok, ExStreamClient.Model.Response.t()} | {:error, any()}
def delete_poll_option(poll_id, option_id, opts \\ []) do
client = get_client(opts)
request_opts =
[
url: "/api/v2/chat/polls/#{poll_id}/options/#{option_id}",
method: :delete,
params:
Keyword.merge([], Keyword.take(opts, [:user_id]))
|> Enum.reject(fn {_k, v} -> is_nil(v) end)
] ++ []
r =
Req.new(request_opts)
|> Req.Request.append_response_steps(
decode: fn {request, response} ->
response_type =
if response.status in 200..299 do
:ok
else
:error
end
response_handlers = %{
200 => ExStreamClient.Model.Response,
400 => ExStreamClient.Model.APIError,
429 => ExStreamClient.Model.APIError
}
parsed =
case Map.get(response_handlers, response.status) do
nil -> {:error, response.body}
mod -> {response_type, mod.decode(response.body)}
end
{request, %{response | body: parsed}}
end
)
case client.request(r, opts) do
{:ok, response} -> response.body
{:error, error} -> {:error, error}
end
end
defp get_client(opts) do
client = Keyword.get(opts, :client, ExStreamClient.Http)
unless Code.ensure_loaded?(client) and function_exported?(client, :request, 2) do
raise ArgumentError,
"client #{inspect(client)} must implement request/2 to conform to ExStreamClient.Http.Behavior"
end
client
end
end