Polarex.CustomerMeters (Polarex v0.1.0)
View SourceProvides API endpoints related to customer meters
Summary
Functions
@spec customer_meters_get( String.t(), keyword() ) :: {:ok, Polarex.CustomerMeter.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Customer Meter
Get a customer meter by ID.
Scopes: customer_meters:read
@spec customer_meters_list(keyword()) :: {:ok, Polarex.ListResourceCustomerMeter.t()} | {:error, Polarex.HTTPValidationError.t()}
List Customer Meters
List customer meters.
Scopes: customer_meters:read
Options
organization_id
: Filter by organization ID.customer_id
: Filter by customer ID.external_customer_id
: Filter by external customer ID.meter_id
: Filter by meter ID.page
: Page number, defaults to 1.limit
: Size of a page, defaults to 10. Maximum is 100.sorting
: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign-
before the criteria name to sort by descending order.
@spec customer_portal_customer_meters_get( String.t(), keyword() ) :: {:ok, Polarex.CustomerCustomerMeter.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Customer Meter
Get a meter by ID for the authenticated customer.
Scopes: customer_portal:read
customer_portal:write
@spec customer_portal_customer_meters_list(keyword()) :: {:ok, Polarex.ListResourceCustomerCustomerMeter.t()} | {:error, Polarex.HTTPValidationError.t()}
List Meters
List meters of the authenticated customer.
Scopes: customer_portal:read
customer_portal:write
Options
meter_id
: Filter by meter ID.query
: Filter by meter name.page
: Page number, defaults to 1.limit
: Size of a page, defaults to 10. Maximum is 100.sorting
: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign-
before the criteria name to sort by descending order.