calendar

The methods of pd.calendar. Inputs and outputs are described in Conventions; every method can also fail as described in Errors.

Methods

pd.calendar.list(input, init?)

The content calendar over a date range

GET /api/workspaces/{workspaceId}/calendar

Returns the workspace's calendar items with each linked article's current title and status and the assignee's name. Month, week and list views are this one call over different from and to bounds. Requires articles.read; items of a restricted project the caller is not a member of are left out, and so are items that track an article of one, whichever project the item itself is in. Items are ordered by scheduledFor, earliest first, and are not paginated; an unscheduled item appears only when neither bound is sent, after the scheduled ones.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.calendar.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.calendar.create(input, init?)

Add a calendar item

POST /api/workspaces/{workspaceId}/calendar

Adds an item to the content calendar. Requires articles.create in the workspace, and on the project when projectId is sent (404 for a foreign project, 409 for an archived one) and on the article's project when articleId is sent (404 for an article of another workspace). The item is a plan kept beside the article: its status is a label that nothing advances, and a scheduledFor date does not publish anything outside a publishing plan. Answers 201.

Input

Returns 201 Created

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.calendar.create({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    title: "example",
  },
});
console.log(result);

pd.calendar.update(input, init?)

Update a calendar item

PATCH /api/workspaces/{workspaceId}/calendar/{itemId}

Changes the fields sent and keeps the others. null clears projectId, articleId, scheduledFor and assignedTo. Requires articles.update, checked against the projectId and articleId when sent and against the item's current project and article: 403 for a caller who is not a member of a restricted project, 409 when that project is archived. 404 when the item is not in the workspace.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.calendar.update({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  itemId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.calendar.delete(input, init?)

Remove a calendar item

DELETE /api/workspaces/{workspaceId}/calendar/{itemId}

Removes the item from the calendar; the article it was linked to is untouched. Requires articles.delete, on the item's project and article when it has them (403 for a caller who is not a member of a restricted project, 409 when it is archived). 404 when the item is not in the workspace.

Input

Returns 200 OK

Errors 400 invalid input, 401 missing or invalid key, 403 the key's roles lack the permission, 404 not found, 429 rate limited or out of quota. See Errors.

Example

import { PrismDraft } from "@prism-draft/sdk";

const pd = new PrismDraft({ apiKey: process.env.PRISMDRAFT_API_KEY! });

const result = await pd.calendar.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  itemId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);