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