Connect

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 { CodeSpar } from "@codespar/sdk";

const cs = new CodeSpar({ apiKey: process.env.CODESPAR_API_KEY });

POST /v1/connect/start

Begin the Connect Link OAuth flow for a provider

const r = await cs.api.response("post", "/v1/connect/start", {
  body: {
    server_id: "srv_0000000000000000",
    user_id: "user_0000000000000000",
    redirect_uri: "https://example.com/hook",
    scopes: "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/connect/start in the HTTP reference.