The Departments resource: full CRUD on organizational departments.
Summary
Functions
Creates a new department with the given name.
Deletes a department.
Fetches a single department by ID.
Returns a lazily auto-paginating Stream of Ramp.Departments.Departments.
Fetches a single page of departments. See Ramp.Page.
Renames an existing department.
Types
@type list_opt() :: {:start, String.t()} | {:page_size, pos_integer()}
Functions
@spec create(Ramp.Client.t(), String.t()) :: {:ok, Ramp.Departments.Department.t()} | {:error, Ramp.Error.t()}
Creates a new department with the given name.
@spec delete(Ramp.Client.t(), String.t()) :: :ok | {:error, Ramp.Error.t()}
Deletes a department.
@spec get(Ramp.Client.t(), String.t()) :: {:ok, Ramp.Departments.Department.t()} | {:error, Ramp.Error.t()}
Fetches a single department by ID.
@spec list(Ramp.Client.t(), [list_opt()]) :: Enumerable.t(Ramp.Departments.Department.t())
Returns a lazily auto-paginating Stream of Ramp.Departments.Departments.
@spec list_page(Ramp.Client.t(), [list_opt()]) :: {:ok, Ramp.Page.t(Ramp.Departments.Department.t())} | {:error, Ramp.Error.t()}
Fetches a single page of departments. See Ramp.Page.
@spec update(Ramp.Client.t(), String.t(), String.t()) :: {:ok, Ramp.Departments.Department.t()} | {:error, Ramp.Error.t()}
Renames an existing department.