Pix keys (DICT)
The 3 operations under pix-keys, as typed calls on the generated REST client.
Pix keys (DICT)
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}/pix-keys
/v1/consumers/{consumerId}/pix-keysList the Pix keys on the consumer's account
const r = await cs.api.response("get", "/v1/consumers/{consumerId}/pix-keys", {
path: {
consumerId: "csm_0000000000000000"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (r.ok) {
console.log(r.data);
}Parameters, body and every documented response: GET /v1/consumers/{consumerId}/pix-keys in the HTTP reference.
POST /v1/consumers/{consumerId}/pix-keys
/v1/consumers/{consumerId}/pix-keysRegister a Pix key on the consumer's account
const r = await cs.api.response("post", "/v1/consumers/{consumerId}/pix-keys", {
path: {
consumerId: "csm_0000000000000000"
},
body: {
key_type: "EVP",
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}/pix-keys in the HTTP reference.
DELETE /v1/consumers/{consumerId}/pix-keys/{key}
/v1/consumers/{consumerId}/pix-keys/{key}Delete a Pix key from the consumer's account
const r = await cs.api.response("delete", "/v1/consumers/{consumerId}/pix-keys/{key}", {
path: {
consumerId: "csm_0000000000000000",
key: "string"
}
});
// r.status is one of the documented statuses (200, 422),
// each with its own body shape in r.data; nothing here throws on 422.
if (r.ok) {
console.log(r.data);
}Parameters, body and every documented response: DELETE /v1/consumers/{consumerId}/pix-keys/{key} in the HTTP reference.