ZenEx.Model.JobStatus (zen_ex v0.8.0)

Provides functions to operate Zendesk JobStatus.

Link to this section Summary

Functions

List job_statuses.

Show job_status specified by id.

Show multiple job_statuses specified by ids.

Link to this section Functions

Link to this function

list(opts \\ [])

List job_statuses.

examples

Examples

iex> ZenEx.Model.JobStatus.list
{:ok, %ZenEx.Collection{}}
@spec show(binary()) ::
  {:ok,
   %ZenEx.Entity.JobStatus{
     id: term(),
     message: term(),
     progress: term(),
     results: term(),
     status: term(),
     total: term(),
     url: term()
   }}
  | {:error, any()}

Show job_status specified by id.

examples

Examples

iex> ZenEx.Model.JobStatus.show("xxx")
{:ok, %ZenEx.Entity.JobStatus{id: "xxx", ...}}
@spec show_many([binary()]) ::
  {:ok,
   %ZenEx.Collection{
     count: term(),
     decode_as: term(),
     entities: term(),
     next_page: term(),
     previous_page: term()
   }}
  | {:error, any()}

Show multiple job_statuses specified by ids.

examples

Examples

iex> ZenEx.Model.JobStatus.show_many(["xxx", ...])
{:ok, %ZenEx.Collection{}}