integrations

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

Methods

pd.integrations.list(input, init?)

List publishing integrations

GET /api/workspaces/{workspaceId}/integrations

Requires integrations.read. Returns every integration of the workspace, active or not, newest first. The stored config holds credentials and is never returned.

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.integrations.list({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.integrations.create(input, init?)

Connect a publishing target

POST /api/workspaces/{workspaceId}/integrations

Requires integrations.create; answers 201 and records an integrations.created audit entry. The provider-specific config is validated, and any URL in it is checked against private address ranges before a credential is stored; either failure answers 400, and a projectId outside the workspace answers 404. The config is never echoed back. The integration starts active.

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.integrations.create({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  body: {
    type: "wordpress",
    name: "example",
    config: {},
  },
});
console.log(result);

pd.integrations.update(input, init?)

Update an integration

PATCH /api/workspaces/{workspaceId}/integrations/{integrationId}

Requires integrations.update. Only the fields sent change; an unknown integration, or one of another workspace, answers 404. A config sent is merged into the stored one and validated as on integrations.create (400 INVALID_REQUEST when it is not valid for the integration's type, or an address in it is private); the record of earlier publishes is kept, with one exception: when the stored credentials cannot be opened (the server could not decrypt them), the config sent replaces the stored one entirely, so it must be complete, and the record of published articles is lost, so each of them is published again as a new post. The type and projectId cannot be changed; sending a type has no effect. Records an integrations.updated audit entry that lists the field names changed, not their values.

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.integrations.update({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  integrationId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);

pd.integrations.delete(input, init?)

Disconnect an integration

DELETE /api/workspaces/{workspaceId}/integrations/{integrationId}

Requires integrations.delete; an unknown integration, or one of another workspace, answers 404. Posts already published to the CMS are not touched. Records an integrations.deleted audit entry.

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.integrations.delete({
  workspaceId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
  integrationId: "3f0c5a1e-8b2d-4c6e-9a7f-1d2e3f4a5b6c",
});
console.log(result);