Gleanex.Client.Answers (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to answers

Summary

Functions

createanswer(body, opts \\ [])

@spec createanswer(body :: Gleanex.Client.CreateAnswerRequest.t(), opts :: keyword()) ::
  {:ok, Gleanex.Client.Answer.t()} | {:error, Gleanex.Error.t()}

Create Answer

Create a user-generated Answer that contains a question and answer.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

CreateAnswer request

deleteanswer(body, opts \\ [])

@spec deleteanswer(body :: Gleanex.Client.DeleteAnswerRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Delete Answer

Delete an existing user-generated Answer.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

DeleteAnswer request

editanswer(body, opts \\ [])

@spec editanswer(body :: Gleanex.Client.EditAnswerRequest.t(), opts :: keyword()) ::
  {:ok, Gleanex.Client.Answer.t()} | {:error, Gleanex.Error.t()}

Update Answer

Update an existing user-generated Answer.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

EditAnswer request

getanswer(body, opts \\ [])

@spec getanswer(body :: Gleanex.Client.GetAnswerRequest.t(), opts :: keyword()) ::
  {:ok, Gleanex.Client.GetAnswerResponse.t()} | {:error, Gleanex.Error.t()}

Read Answer

Read the details of a particular Answer given its ID.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

GetAnswer request

listanswers(body, opts \\ [])

@spec listanswers(body :: Gleanex.Client.ListAnswersRequest.t(), opts :: keyword()) ::
  {:ok, Gleanex.Client.ListAnswersResponse.t()} | {:error, Gleanex.Error.t()}

List Answers

List Answers created by the current user.

Options

  • locale: The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request Body

Content Types: application/json

ListAnswers request