Contact Verifications
The 2 operations under contact-verifications, as typed calls on the generated REST client.
Contact Verifications
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 });POST /v1/consumers/{consumerId}/contact-verifications
/v1/consumers/{consumerId}/contact-verificationsSend a one-time code to a consumer's e-mail address or phone number
const r = await cs.api.response("post", "/v1/consumers/{consumerId}/contact-verifications", {
path: {
consumerId: "csm_0000000000000000"
},
body: {
channel: "email",
target: "string",
locale: "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: POST /v1/consumers/{consumerId}/contact-verifications in the HTTP reference.
POST /v1/consumers/{consumerId}/contact-verifications/{id}/verify
/v1/consumers/{consumerId}/contact-verifications/{id}/verifyCheck the code the consumer received
const result = await cs.api.post("/v1/consumers/{consumerId}/contact-verifications/{id}/verify", {
path: {
consumerId: "csm_0000000000000000",
id: "contactverification_0000000000000000"
},
body: {
code: "string",
target: "string"
}
});Parameters, body and every documented response: POST /v1/consumers/{consumerId}/contact-verifications/{id}/verify in the HTTP reference.