View Source Zendesk (zendesk v0.0.3)
This is an Elixir library for interacting with the Zendesk platform.
It handles streaming paginated lists of tickets and users, and allows you to interact with the API with only a thin layer of Elixiry abstraction.
Link to this section Summary
Functions
Send a given Zendesk.Client.Operation
to the API endpoint.
Send a given Zendesk.Client.Operation
to the API endpoint, raising if there's any error.
Make a request, producing a Stream
for paginating results.
Link to this section Functions
@spec request(Zendesk.Client.Operation.t()) :: Zendesk.Client.Parser.parsed_result()
Send a given Zendesk.Client.Operation
to the API endpoint.
This is the general entry point for all requests.
@spec request!(Zendesk.Client.Operation.t()) :: struct()
Send a given Zendesk.Client.Operation
to the API endpoint, raising if there's any error.
@spec stream!(Zendesk.Client.Operation.t()) :: Enumerable.t()
Make a request, producing a Stream
for paginating results.
Send a given Zendesk.Client.Operation
to the API endpoint with the expectation that the
Zendesk.Client.Operation
will produce a paginated result. Any errors will raise an
exception.