View Source PlacetelAPI.Api.Devices (placetel_api v2.0.1)

API calls for all endpoints tagged Devices.

Link to this section Summary

Functions

Fetch all devices Fetch a list of all provisionable devices

Link to this section Functions

Link to this function

get_devices(connection, opts \\ [])

View Source
@spec get_devices(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [PlacetelAPI.Model.Device.t()]} | {:error, Tesla.Env.t()}

Fetch all devices Fetch a list of all provisionable devices

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :page (integer()): Page of results to fetch.
    • :per_page (integer()): Number of results to return per page.

returns

Returns

  • {:ok, [%Device{}, ...]} on success
  • {:error, Tesla.Env.t} on failure