Projects

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/projects`

GET/v1/projects

List projects

const result = await cs.api.get("/v1/projects");

Parameters, body and every documented response: GET /v1/projects in the HTTP reference.

POST `/v1/projects`

POST/v1/projects

Create a project

const result = await cs.api.post("/v1/projects", {
  body: {
    name: "Example",
    slug: "example",
    environment: "live",
    settings: {}
  }
});

Parameters, body and every documented response: POST /v1/projects in the HTTP reference.

GET `/v1/projects/{id}`

GET/v1/projects/{id}

Read one project

const result = await cs.api.get("/v1/projects/{id}", {
  path: {
    id: "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id} in the HTTP reference.

PATCH `/v1/projects/{id}`

PATCH/v1/projects/{id}

Rename a project, change its slug, or promote it to default

const result = await cs.api.patch("/v1/projects/{id}", {
  path: {
    id: "prj_0000000000000000"
  },
  body: {
    name: "Example",
    slug: "example",
    is_default: true
  }
});

Parameters, body and every documented response: PATCH /v1/projects/{id} in the HTTP reference.

DELETE `/v1/projects/{id}`

DELETE/v1/projects/{id}

Delete a project

const result = await cs.api.delete("/v1/projects/{id}", {
  path: {
    id: "prj_0000000000000000"
  }
});

Parameters, body and every documented response: DELETE /v1/projects/{id} in the HTTP reference.

GET `/v1/projects/{id}/settings`

GET/v1/projects/{id}/settings

Read a project's effective settings

const result = await cs.api.get("/v1/projects/{id}/settings", {
  path: {
    id: "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id}/settings in the HTTP reference.

PATCH `/v1/projects/{id}/settings`

PATCH/v1/projects/{id}/settings

Set or reset a project's settings

const result = await cs.api.patch("/v1/projects/{id}/settings", {
  path: {
    id: "prj_0000000000000000"
  },
  body: {
    settings: {}
  }
});

Parameters, body and every documented response: PATCH /v1/projects/{id}/settings in the HTTP reference.

GET `/v1/projects/{id}/settings/history`

GET/v1/projects/{id}/settings/history

Read a project's settings audit log

const result = await cs.api.get("/v1/projects/{id}/settings/history", {
  path: {
    id: "prj_0000000000000000"
  }
});

Parameters, body and every documented response: GET /v1/projects/{id}/settings/history in the HTTP reference.

Projects

On this page