Meters

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.23. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.23, the version this site installs: a call that does not type-check against it fails the build.

Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.

import { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

GET /v1/meters

List the project's meters with their cycle figures

const result = await cs.api.get("/v1/meters");

Parameters, body and every documented response: GET /v1/meters in the HTTP reference.

POST /v1/meters

Define a meter on a usage event

const result = await cs.api.post("/v1/meters", {
  body: {
    event_name: "Example",
    aggregation: "count",
    price: 0,
    per_units: 1,
    unit_label: "Example",
    description: "string",
    channel: "invoice"
  }
});

Parameters, body and every documented response: POST /v1/meters in the HTTP reference.

GET /v1/meters/adjustments

Late max/last events pending adjustment

const result = await cs.api.get("/v1/meters/adjustments");

Parameters, body and every documented response: GET /v1/meters/adjustments in the HTTP reference.

GET /v1/meters/cycle

The meter cycle: progress, totals and totals by channel

const result = await cs.api.get("/v1/meters/cycle");

Parameters, body and every documented response: GET /v1/meters/cycle in the HTTP reference.

GET /v1/meters/statements

A closed cycle's statements

const result = await cs.api.get("/v1/meters/statements");

Parameters, body and every documented response: GET /v1/meters/statements in the HTTP reference.

GET /v1/meters/statements/{statementId}

Read one statement with its lines

const result = await cs.api.get("/v1/meters/statements/{statementId}", {
  path: {
    statementId: "statement_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/meters/statements/{statementId} in the HTTP reference.

GET /v1/meters/{meterId}

Read one meter with its cycle figures

const result = await cs.api.get("/v1/meters/{meterId}", {
  path: {
    meterId: "meter_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/meters/{meterId} in the HTTP reference.

GET /v1/meters/{meterId}/events

A meter's latest events

const result = await cs.api.get("/v1/meters/{meterId}/events", {
  path: {
    meterId: "meter_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/meters/{meterId}/events in the HTTP reference.

GET /v1/meters/{meterId}/usage

A meter's usage on each day of the cycle

const result = await cs.api.get("/v1/meters/{meterId}/usage", {
  path: {
    meterId: "meter_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/meters/{meterId}/usage in the HTTP reference.