zen_ex v0.4.2 ZenEx.Model.JobStatus

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

iex> ZenEx.Model.JobStatus.list
%ZenEx.Collection{}

Specs

show(binary()) ::
  %ZenEx.Entity.JobStatus{
    id: term(),
    message: term(),
    progress: term(),
    results: term(),
    status: term(),
    total: term(),
    url: term()
  }
  | {:error, String.t()}

Show job_status specified by id.

Examples

iex> ZenEx.Model.JobStatus.show("xxx")
%ZenEx.Entity.JobStatus{id: "xxx", ...}

Specs

show_many([binary()]) ::
  %ZenEx.Collection{
    count: term(),
    decode_as: term(),
    entities: term(),
    next_page: term(),
    previous_page: term()
  }
  | {:error, String.t()}

Show multiple job_statuses specified by ids.

Examples

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