articleGroups

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

Methods

pd.articleGroups.list(input, init?)

List articles, one item per content piece

GET /api/article-groups

One page of translation groups, newest change first, and how many match in all. A group is every language version of one article (they share translationGroupId). A group is listed when any of its versions passes all the filters given, and it always carries all its versions, matching or not. title and primaryLanguage are the oldest version's, the one the others were translated from. status is the status every version shares, or MIXED. GET /api/articles is unchanged and still lists one item per language version.

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

pd.articleGroups.get(input, init?)

Read one content piece with all its language versions

GET /api/article-groups/{translationGroupId}

One translation group with every language version, oldest first, in the shape of an item of GET /api/article-groups. Needs articles.read. The workspace is resolved from the group; 404 when it does not exist or the caller cannot see it.

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

pd.articleGroups.delete(input, init?)

Delete every language version of a content piece

DELETE /api/article-groups/{translationGroupId}

Permanent, in one transaction. Each version that was PUBLISHED emits an article.unpublished webhook (reason: "deleted"). Needs articles.delete. Every deleted version writes an articles.deleted audit entry, and the stored image files no other row refers to are removed afterwards. 404 when the group does not exist or the caller cannot see it.

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

pd.articleGroups.approve(input, init?)

Approve the language versions of a group

POST /api/article-groups/{translationGroupId}/approve

Moves the chosen language versions from NEEDS_REVIEW to APPROVED in one transaction and records a review on each. Needs articles.approve. All-or-nothing: a version already APPROVED is skipped; if any other cannot be approved (not in NEEDS_REVIEW, still being generated, or an empty draft left by a failed translation) none moves and the answer is 409 with the blocked versions. Each approved version emits its own article.approved webhook, writes an audit entry and emails the version's author. languages that the group has no version in are refused with INVALID_REQUEST.

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

pd.articleGroups.publish(input, init?)

Publish the language versions of a group

POST /api/article-groups/{translationGroupId}/publish

Moves the chosen language versions from APPROVED to PUBLISHED in one transaction. Needs articles.publish. All-or-nothing: a version already PUBLISHED is skipped; if any other is not APPROVED none moves and the answer is 409 with the blocked versions. Each published version emits its own article.published webhook and writes an audit entry; when the project has a CMS integration, a publishing job is queued for it and runs after the answer. languages that the group has no version in are refused with INVALID_REQUEST.

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

pd.articleGroups.unpublish(input, init?)

Unpublish the language versions of a group

POST /api/article-groups/{translationGroupId}/unpublish

Takes the chosen versions that are PUBLISHED back to DRAFT and skips the others; it is never blocked, and with nothing published it answers 200 with nothing applied. Needs articles.publish. Each unpublished version emits its own article.unpublished webhook (reason: "status_changed") and writes an audit entry. languages that the group has no version in are refused with INVALID_REQUEST.

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