View Source Zendesk.Client.Result (zendesk v0.0.3)
This module is used to represent the result of an API call.
It is passed to the parser specified in a given Zendesk.Client.Operation
and the
result is what's returned from an Zendesk.Client.request/1
.
Link to this section Summary
Functions
Convert the raw results of an API call and turn them into a Zendesk.Client.Result
.
Convert the Zendesk.Client.Result
of an API call and turn it into a Zendesk.Client.Streamable
.
Link to this section Types
@type t() :: %Zendesk.Client.Result{ body: binary(), headers: list(), operation: Zendesk.Client.Operation.t(), parsed: map() | nil }
Link to this section Functions
@spec from_encoded(String.t(), list(), Zendesk.Client.Operation.t()) :: t()
Convert the raw results of an API call and turn them into a Zendesk.Client.Result
.
@spec to_streamable(t()) :: Zendesk.Client.Streamable.t()
Convert the Zendesk.Client.Result
of an API call and turn it into a Zendesk.Client.Streamable
.
This is used in cases where we expect the result to contain pagination.