# codegen: do not edit
defmodule GenLSP.Requests.TextDocumentInlayHint do
  @moduledoc """
  A request to provide inlay hints in a document. The request's parameter is of
  type {@link InlayHintsParams}, the response is of type
  {@link InlayHint InlayHint[]} or a Thenable that resolves to such.

  @since 3.17.0

  Message Direction: clientToServer
  """

  import Schematic, warn: false

  use TypedStruct

  @derive Jason.Encoder
  typedstruct do
    field :method, String.t(), default: "textDocument/inlayHint"
    field :jsonrpc, String.t(), default: "2.0"
    field :id, integer() | String.t(), enforce: true
    field :params, GenLSP.Structures.InlayHintParams.t()
  end

  @type result :: list(GenLSP.Structures.InlayHint.t()) | nil

  @doc false
  @spec schema() :: Schematic.t()
  def schema() do
    schema(__MODULE__, %{
      method: "textDocument/inlayHint",
      jsonrpc: "2.0",
      id: oneof([int(), str()]),
      params: GenLSP.Structures.InlayHintParams.schema()
    })
  end

  @doc false
  @spec result() :: Schematic.t()
  def result() do
    oneof([
      oneof([list(GenLSP.Structures.InlayHint.schema()), nil]),
      GenLSP.ErrorResponse.schema()
    ])
  end
end
