Mandates
The 5 operations under mandates, as typed calls on the generated REST client.
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 { } from "@codespar/sdk";
const = new ({ : .. });GET /v1/mandates
List consumer allowances
const = await ..("/v1/mandates");Parameters, body and every documented response: GET /v1/mandates in the HTTP reference.
GET /v1/mandates/{id}
Read one consumer allowance
const = await ..("/v1/mandates/{id}", {
: {
: "mandate_0000000000000000"
}
});Parameters, body and every documented response: GET /v1/mandates/{id} in the HTTP reference.
POST /v1/mandates/{id}/pause
Pause an allowance
const = await ..("post", "/v1/mandates/{id}/pause", {
: {
: "mandate_0000000000000000"
},
: {
: "string"
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/mandates/{id}/pause in the HTTP reference.
POST /v1/mandates/{id}/resume
Resume a paused allowance
const = await ..("post", "/v1/mandates/{id}/resume", {
: {
: "mandate_0000000000000000"
},
: {
: "string"
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/mandates/{id}/resume in the HTTP reference.
POST /v1/mandates/{id}/revoke
Revoke an allowance
const = await ..("post", "/v1/mandates/{id}/revoke", {
: {
: "mandate_0000000000000000"
},
: {
: "string"
}
});
// r.status is one of the documented statuses (200, 403),
// each with its own body shape in r.data; nothing here throws on 403.
if (.) {
.(.);
}Parameters, body and every documented response: POST /v1/mandates/{id}/revoke in the HTTP reference.