Boletos you owe (DDA)
The 4 operations under dda, as typed calls on the generated REST client.
Boletos you owe (DDA)
Available from @codespar/sdk 0.12.0, which is not on npm yet. The published version today is 0.11.0, and it has no cs.api; 0.12.0 is on the main branch of codespar-core. The examples below are not compiled against the installed package for that reason.
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/consumers/{consumerId}/dda/boletos
/v1/consumers/{consumerId}/dda/boletosThe boletos DDA has mirrored for this consumer
const result = await cs.api.get("/v1/consumers/{consumerId}/dda/boletos", {
path: {
consumerId: "csm_0000000000000000"
},
query: {
from_date: "string",
to_date: "string"
}
});Parameters, body and every documented response: GET /v1/consumers/{consumerId}/dda/boletos in the HTTP reference.
POST /v1/consumers/{consumerId}/dda/subscriptions
/v1/consumers/{consumerId}/dda/subscriptionsRegister the consumer's CPF/CNPJ with DDA
const r = await cs.api.response("post", "/v1/consumers/{consumerId}/dda/subscriptions", {
path: {
consumerId: "csm_0000000000000000"
},
body: {
document: "string",
client_name: "Example",
idempotency_key: "string"
}
});
// r.status is one of the documented statuses (200, 403, 422),
// each with its own body shape in r.data; nothing here throws on 403.
if (r.ok) {
console.log(r.data);
}Parameters, body and every documented response: POST /v1/consumers/{consumerId}/dda/subscriptions in the HTTP reference.
GET /v1/consumers/{consumerId}/dda/subscriptions/{document}
/v1/consumers/{consumerId}/dda/subscriptions/{document}Read a DDA registration
const result = await cs.api.get("/v1/consumers/{consumerId}/dda/subscriptions/{document}", {
path: {
consumerId: "csm_0000000000000000",
document: "string"
}
});Parameters, body and every documented response: GET /v1/consumers/{consumerId}/dda/subscriptions/{document} in the HTTP reference.
DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document}
/v1/consumers/{consumerId}/dda/subscriptions/{document}End a DDA registration
const result = await cs.api.delete("/v1/consumers/{consumerId}/dda/subscriptions/{document}", {
path: {
consumerId: "csm_0000000000000000",
document: "string"
}
});Parameters, body and every documented response: DELETE /v1/consumers/{consumerId}/dda/subscriptions/{document} in the HTTP reference.