@taktoria/sdk 0.1.0 → 0.1.3

package/reference.md

@@ -332,7 +332,7 @@ await client.appDomains.verify("appSlug");
 Every launch's artifacts, as the Artifacts page shows them across
 launches: by their launch's planned launch date (drafts without one
 first), then by type, each with its launch. Gather a quarter's
-learnings, say, with `type=LEARNINGS&year=2026&quarter=3`. A launch
+learnings, say, with `type=LEARNINGS&period=2026-Q3`. A launch
 has its artifacts once its steps are added or they are created
 (`POST /launches/{launchId}/artifacts`); one with none is not listed.
 Needs `artifacts:read`.
@@ -662,9 +662,13 @@ person's account, a new one is made where `destinationId` says, and
 `outcome` is `replaced`. The link is kept on the artifact
 (`exports`). Writing it changes the launch, so a Viewer of LaunchCal
 is refused. Counts against `docs-export`. Needs `artifacts:write`.
-A tool not connected is `409 docs_not_connected`, a connection the
-tool turned down `409 docs_reconnect`, and a tool that did not
-answer `502 upstream_error`.
+An artifact with nothing written in it is `409 artifact_empty`, a
+tool this deployment does not export to `409 docs_tool_unavailable`,
+a tool the person has not connected `409 docs_not_connected`, a
+connection the tool turned down `409 docs_reconnect`, a
+`destinationId` that cannot take a page or that their account
+cannot reach `409 docs_destination_invalid`, and a tool that did
+not answer `502 upstream_error`.
 </dd>
 </dl>
 </dd>
@@ -805,8 +809,12 @@ await client.artifacts.docsTools();
 Where the signed-in person may export to in a tool, read from it with
 their own account: the Notion pages they shared with Taktoria when
 connecting (and the pages in them), or the Confluence spaces they can
-see. Empty for Google Docs. Counts against `docs-browse`. Needs
-`artifacts:read`.
+see. Empty for Google Docs. Counts against `docs-browse`. A
+workspace key is refused (`person_required`); a tool this deployment
+does not export to is `409 docs_tool_unavailable`, one the person
+has not connected `409 docs_not_connected`, a connection the tool
+turned down `409 docs_reconnect`, and a tool that did not answer
+`502 upstream_error`. Needs `artifacts:read`.
 </dd>
 </dl>
 </dd>
@@ -1809,11 +1817,12 @@ await client.dory.updateEvent("eventId", {});
 <dd>
 
 A copy of the event, to run it again, Not started until it is given
-a start. Its description,
-passcode, audience and domains, room and presenter settings,
-instructions, hosts and polls (as drafts) come along; its questions,
-participants, results, billing and dates do not. It gets a new code
-and belongs to whoever made it. Needs `events:write`.
+a start. Its description, passcode, audience and domains, room and
+presenter settings, instructions, meeting link (`meetingUrl`, so a
+recurring call keeps its link), time zone, hosts and polls (as
+drafts) come along; its questions, participants, results, billing
+and dates do not. It gets a new code and belongs to whoever made it.
+Needs `events:write`.
 </dd>
 </dl>
 </dd>
@@ -2677,6 +2686,75 @@ await client.dory.getEventJoinLink("evt_7f3a");
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.dory.<a href="/src/api/resources/dory/client/Client.ts">getEventCalendarInvite</a>(eventId) -> Taktoria.EventCalendarInvite</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The event for a calendar and a meeting invite, as the console's
+**Add to calendar** gives it: the lines to paste into an invite,
+links that open Google Calendar's and Outlook's new-event pages
+filled in, and the .ics file, each with the join link and code from
+`getEventJoinLink`, never the passcode. An event with no `startsAt`
+has the invite text only. In the signed-in person's language,
+English for a key. Needs `events:read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.dory.getEventCalendarInvite("evt_7f3a");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**eventId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `DoryClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -5117,8 +5195,11 @@ await client.launchOverview.get();
 
 List the launches in your organization, or with `mine=true` your own,
 the ones the app's My launches page counts as yours. Drafts included,
-by planned launch date. Every period unless `year` narrows it, where
-the app's lists open on this quarter and later. Needs `launches:read`.
+by planned launch date. Every period unless `period` (or `year`)
+narrows it, where the app's lists open on this quarter and later:
+`period=upcoming` lists what they do. With `launched=true` it is the
+Launched page instead: launches that have launched, newest first,
+with the periods going by when each launched. Needs `launches:read`.
 </dd>
 </dl>
 </dd>
@@ -5186,7 +5267,8 @@ await client.launches.list({
 Add a launch. With a `plannedLaunchDate` it gets its launch template's
 steps at once, which is what fills each reviewer's queue; pass
 `generateSteps: false` to leave them off. Pass `draft: true` to save it
-without telling anybody.
+without telling anybody. A draft with `status: LAUNCHED` is
+`409 draft`: publish it, then launch it.
 </dd>
 </dl>
 </dd>
@@ -5304,7 +5386,9 @@ Change a launch's details. Its owners are told what changed, by whom
 and from what, about ten minutes after the edits stop, in one message
 that leaves out each owner's own edits (`launchUpdates` in their
 notification preferences). Its artifacts and links count too; its
-steps do not, and nothing is sent about a draft.
+steps do not, and nothing is sent about a draft. `409 launched` when
+`draft: true` would take a launched launch back to being a draft, and
+`409 draft` when the change would leave a draft `LAUNCHED`.
 </dd>
 </dl>
 </dd>
@@ -5506,9 +5590,15 @@ the connection can see (in its Linear workspace, on one of its Jira
 sites, in the GitHub organization the app is installed on, or in its
 Asana or ClickUp workspaces), and syncs at once: the answer's
 `ticketingProject` says how that went. Any other address, a whole
-Jira project or a GitHub repository included, is kept as a link and
-does not sync. It reads the system, so it shares the `ticketing-sync`
-budget with a sync. Needs `launches:write`.
+Jira project, a GitHub repository, or a ClickUp folder or space
+included, is kept as a link and does not sync. It reads the system,
+so it shares the `ticketing-sync` budget with a sync. `404 not_found`
+when the connection cannot find or see the project, `409 conflict`
+for one in another workspace or site of the system than the one
+connected, `409 ticketing_reconnect` when the system turned the
+connection down (a workspace admin connects it again in Settings →
+Integrations), and `502 upstream_error` when it did not answer.
+Needs `launches:write`.
 </dd>
 </dl>
 </dd>
@@ -5646,10 +5736,12 @@ await client.launches.unlinkTicketingProject("launchId");
 <dd>
 
 Sync now, as the daily sync does, for this launch: its status,
-progress, and new status updates (Linear, GitHub projects, Asana) or
-comments (Jira, ClickUp). `404 not_found` when the launch follows
-nothing; `409 conflict` for a link that cannot sync (a whole Jira
-project, a GitHub repository, or a system Taktoria does not sync);
+progress, and new status updates (Linear, GitHub projects) or
+comments (Jira, ClickUp); an Asana project brings its completion and
+progress, not its status updates. `404 not_found` when the launch
+follows nothing; `409 conflict` for a link that cannot sync (a whole
+Jira project, a GitHub repository, a ClickUp folder or space, or a
+system Taktoria does not sync);
 `409 ticketing_not_connected` or `409 ticketing_reconnect` when a
 workspace admin must connect its system in Settings → Integrations.
 Needs `launches:write`.
@@ -5718,8 +5810,8 @@ await client.launches.syncTicketingProject("launchId");
 What has happened to a launch, newest first, as its activity feed
 shows it: added, changed, published, taken back to draft, launched,
 its steps decided and reasons given for them, comments and updates
-posted, and its ticketing project linked, unlinked and synced. Each
-entry says it in a sentence. The comments and updates
+posted, its ticketing project linked, unlinked and synced, and its
+artifacts exported to a docs tool. Each entry says it in a sentence. The comments and updates
 themselves are at `/launches/{launchId}/posts`. Needs `launches:read`.
 </dd>
 </dl>
@@ -8163,6 +8255,9 @@ await client.okr.deleteKeyResult("keyResultId");
 <dd>
 
 The history behind a key result's current grade, most recent first.
+On a key result a connected metric drives (`metric` on the key
+result), the metric's own check-ins carry `metric`, and a person's
+stands only until the metric next moves.
 </dd>
 </dl>
 </dd>
@@ -8249,6 +8344,11 @@ one of their teams', or on any of an objective they may edit (see
 
 With `checkpoint`, it is also the key result's grade at that
 scorecard checkpoint, as the dashboard's check-in form makes it.
+
+On a key result a connected metric drives (`metric` on the key
+result), a check-in stands only until the metric next moves: the
+metric's next check-in is then the latest. A **Final** grade on the
+scorecard is the score whatever the metric does.
 </dd>
 </dl>
 </dd>
@@ -9330,8 +9430,11 @@ await client.organization.get();
 <dd>
 
 Rename the workspace, move its slug, set its fiscal year, the years
-OKR Hub offers, the default time zone, LaunchCal's holiday markets or
-whether seats grow as people join (`autoGrowSeats`). Requires
+OKR Hub offers, the default time zone, LaunchCal's holiday markets,
+whether seats grow as people join (`autoGrowSeats`), whether
+LaunchCal's calendar feeds are allowed (`allowCalendarFeeds`) or
+whether Slack commands take Slack's word while Google is required
+(`slackCommandsWithoutGoogle`). Requires
 `organization:write`, which a signed-in session never has: this takes
 a key. Everything is checked before anything is written.
 
@@ -9651,8 +9754,8 @@ await client.platform.getNotificationPreferences();
 <dl>
 <dd>
 
-Turn kinds of notification on or off, by email and by Slack, for the
-person behind this key or session; anything not named keeps its
+Turn kinds of notification on or off, by email, by Slack and by
+Microsoft Teams, for the person behind this key or session; anything not named keeps its
 value. Like reading them, it needs no scope, and a signed-in session
 may change its own. `404` for a key whose maker has left.
 </dd>
@@ -10521,8 +10624,10 @@ await client.posts.create("lch_7f3a", {
 <dd>
 
 Change a post's body, and an update's health. Only its author may:
-through an API key, the person the key belongs to. Needs
-`launches:write`.
+through an API key, the person the key belongs to. A post a ticketing
+sync brought in (one with a `source`) is that system's: changing it
+here is a `409 conflict`; change it there, and the next sync brings
+it across. Needs `launches:write`.
 </dd>
 </dl>
 </dd>
@@ -11888,6 +11993,141 @@ await client.search.search({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## SlackConnections
+<details><summary><code>client.slackConnections.<a href="/src/api/resources/slackConnections/client/Client.ts">list</a>({ ...params }) -> Taktoria.SlackConnectionPage</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+The workspace's Slack connections, newest first. A key, or a
+workspace admin's session, sees every one; anybody else's session
+sees their own, as the connect page lists them. Requires
+`slackConnections:read`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.slackConnections.list();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Taktoria.ListSlackConnectionsRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SlackConnectionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.slackConnections.<a href="/src/api/resources/slackConnections/client/Client.ts">disconnect</a>(connectionId) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Disconnect a Slack account, as the connect page's **Disconnect**
+does: where Google is required, its commands are refused from the
+next one, with a link to connect again. In the audit log as
+`slack_user_link.deleted`. Requires `slackConnections:write`. A
+person's session disconnects their own; a key or a workspace admin's
+session, anybody's. One the caller may not see is `404 not_found`.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.slackConnections.disconnect("slk_4b1e");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**connectionId:** `string` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `SlackConnectionsClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -12028,10 +12268,14 @@ await client.steps.createForLaunch("launchId", {
 <dl>
 <dd>
 
-"Add Launch Steps" copies the steps of the launch's own launch template
+"Add launch steps" copies the steps of the launch's own launch template
 (`launchTemplateId`, the workspace's default when it has none) onto
 the launch, back-scheduling each step from the planned launch date, and
-creates the press release, dashboard and learnings artifacts. Run again,
+creates the press release, dashboard and learnings artifacts. A step
+starts with its template step's default reviewer
+(`defaultReviewer` on the step template) when that is still a member
+of the workspace, who is told as anybody given a step is: once the
+launch is published, if it is a draft. Run again,
 say after the launch switches template, it adds only the steps the
 launch lacks: a step it already has, or the same review (the same name
 for the same functional team) from another template, is left out, and
@@ -12404,12 +12648,14 @@ await client.steps.setReason("stp_1", {
 <dl>
 <dd>
 
-Nudge the assigned reviewer over email and Slack. Throttled to one
-nudge per step per hour however many times it is called; `queued`
-is true either way, and `lastNudgedAt` on the step says when the
-last one went. A draft's reviewer hears nothing until it is
-published. A step with no reviewer is `409 no_reviewer`, and a key
-whose maker has left the workspace is `403 forbidden`: a nudge
+Nudge the assigned reviewer over email and Slack, as the step's bell
+does in the app. One nudge per step goes out an hour however many
+times it is called, and none on a draft, whose reviewers hear
+nothing until it is published: `sent` says whether this one went
+out and, when not, `reason` says why (`throttled`, with
+`retryInMinutes`, or `draft`). `lastNudgedAt` on the step says when
+the last one went. A step with no reviewer is `409 no_reviewer`, and
+a key whose maker has left the workspace is `403 forbidden`: a nudge
 comes from a person.
 </dd>
 </dl>
@@ -12425,7 +12671,7 @@ comes from a person.
 <dd>
 
 ```typescript
-await client.steps.nudge("stepId");
+await client.steps.nudge("stp_1");
 
 ```
 </dd>