Search documentation of polar_express

# PolarExpress.Services.MetersService (polar_express v0.1.5)

Copy Markdown View Source

Meters

Meters API operations.

## Summary

### Functions

create_meter(client, params \\ %{}, opts \\ [])

Create Meter

get_meter(client, id, params \\ %{}, opts \\ [])

Get Meter

get_meter_quantities(client, id, params \\ %{}, opts \\ [])

Get Meter Quantities

list_meters(client, params \\ %{}, opts \\ [])

List Meters

update_meter(client, id, params \\ %{}, opts \\ [])

Update Meter

## Functions

# create_meter(client, params \\ %{}, opts \\ [])

    @spec create_meter(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.Meter.t()} | {:error, PolarExpress.Error.t()}

Create Meter

Create a meter.

Scopes: `meters:write`

See `PolarExpress.Params.MetersCreateMeterParams` for parameter details.

# get_meter(client, id, params \\ %{}, opts \\ [])

    @spec get_meter(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.Meter.t()} | {:error, PolarExpress.Error.t()}

Get Meter

Get a meter by ID.

Scopes: `meters:read` `meters:write`

See `PolarExpress.Params.MetersGetMeterParams` for parameter details.

# get_meter_quantities(client, id, params \\ %{}, opts \\ [])

    @spec get_meter_quantities(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.MeterQuantities.t()}
      | {:error, PolarExpress.Error.t()}

Get Meter Quantities

Get quantities of a meter over a time period.

Scopes: `meters:read` `meters:write`

See `PolarExpress.Params.MetersGetMeterQuantitiesParams` for parameter details.

# list_meters(client, params \\ %{}, opts \\ [])

    @spec list_meters(PolarExpress.Client.t(), map(), keyword()) ::
      {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}

List Meters

List meters.

Scopes: `meters:read` `meters:write`

See `PolarExpress.Params.MetersListMetersParams` for parameter details.

# update_meter(client, id, params \\ %{}, opts \\ [])

    @spec update_meter(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
      {:ok, PolarExpress.Schemas.Meter.t()} | {:error, PolarExpress.Error.t()}

Update Meter

Update a meter.

Scopes: `meters:write`

See `PolarExpress.Params.MetersUpdateMeterParams` for parameter details.