View Source CircleCI (CircleCI API Client v0.1.0)

Summary

Functions

Run a client operation and return the raw Operation or Error

Functions

Link to this function

raw(module, function, args, opts \\ [])

View Source
@spec raw(module(), atom(), [any()], keyword()) ::
  {:ok, CircleCI.Operation.t()} | {:error, CircleCI.Error.t()}

Run a client operation and return the raw Operation or Error

Normal client operation calls return only the response body. This function can be useful when the caller needs additional information, such as data from the response headers.

The args passed to this function should not include the opts argument usually available on client operations. Instead, any such options should be passed as the final argument to raw/4.

Example

iex> CircleCI.raw(CircleCI.Users, :get_authenticated, [])
{:ok, %CircleCI.Operation{}}