Events

Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, 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/events/summary

Count the project's events in a window, by type

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

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

POST /v1/events/{event_id}/replay

Re-dispatch a stored event to its subscribers

const result = await cs.api.post("/v1/events/{event_id}/replay", {
  path: {
    event_id: "event_0000000000000000"
  }
});

Parameters, body and every documented response: POST /v1/events/{event_id}/replay in the HTTP reference.