Account
The 4 operations under account, as typed calls on the generated REST client.
Available from @codespar/sdk 0.12.0; the version on npm is 0.16.11. Every example on this page is compiled against the installed package when these docs build: a call that does not type-check 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 { } from "@codespar/sdk";
const = new ({ : .. });GET /v1/account/agent-activity
BRL spent and received per agent, last 30 days
const result = await cs.api.get("/v1/account/agent-activity");This path is in the published OpenAPI document but the installed @codespar/sdk does not type it yet, so this one example is not compiled. The call works over HTTP today; cs.api types it after the next release of the package.
Parameters, body and every documented response: GET /v1/account/agent-activity in the HTTP reference.
GET /v1/account/balances
Account balances, per currency
const result = await cs.api.get("/v1/account/balances");This path is in the published OpenAPI document but the installed @codespar/sdk does not type it yet, so this one example is not compiled. The call works over HTTP today; cs.api types it after the next release of the package.
Parameters, body and every documented response: GET /v1/account/balances in the HTTP reference.
GET /v1/account/ledger
The project's ledger, every wallet merged
const result = await cs.api.get("/v1/account/ledger");This path is in the published OpenAPI document but the installed @codespar/sdk does not type it yet, so this one example is not compiled. The call works over HTTP today; cs.api types it after the next release of the package.
Parameters, body and every documented response: GET /v1/account/ledger in the HTTP reference.
GET /v1/account/summary
BRL money in, agent spend, tool calls and sessions over a window
const result = await cs.api.get("/v1/account/summary");This path is in the published OpenAPI document but the installed @codespar/sdk does not type it yet, so this one example is not compiled. The call works over HTTP today; cs.api types it after the next release of the package.
Parameters, body and every documented response: GET /v1/account/summary in the HTTP reference.