feat(KNO-12791): Add workflow recipient runs to docs

Author: andy-knock

.vscode/settings.json

@@ -9,5 +9,8 @@
   },
   "[markdown]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[yaml]": {
+    "editor.formatOnSave": false
   }
-}
+}

data/sidebars/apiOverviewSidebar.ts

@@ -2,6 +2,7 @@ import { SidebarSection } from "../types";
 
 export const RESOURCE_ORDER = [
   "workflows",
+  "workflow_recipient_runs",
   "messages",
   "channels",
   "users",

data/specs/api/customizations.yml

@@ -85,6 +85,10 @@ resources:
           For a push channel, this includes device-specific tokens that map the recipient to the device they use, as well as [device metadata](/integrations/push/device-metadata) for supported providers. For chat apps, such as Slack, this includes the access token used to send notifications to a customer's Slack channel.
 
           The shape of the `data` payload varies depending on the channel type; you can learn more about channel data schemas [here](/send-notifications/setting-channel-data#provider-data-requirements).
+  workflow_recipient_runs:
+    name: Workflow runs
+    description: |-
+      A workflow run represents an individual execution of a [workflow](/concepts/workflows) for a specific recipient. Use the workflow runs API to inspect the status and event history of a workflow run, including which steps were executed and any errors encountered.
   schedules:
     name: Schedules
     description: |-

data/specs/api/stainless.yml

@@ -280,6 +280,18 @@ resources:
     methods:
       trigger: post /v1/workflows/{key}/trigger
       cancel: post /v1/workflows/{key}/cancel
+  workflow_recipient_runs:
+    models:
+      workflow_recipient_run: '#/components/schemas/WorkflowRecipientRun'
+      workflow_recipient_run_detail: '#/components/schemas/WorkflowRecipientRunDetail'
+      workflow_recipient_run_event: '#/components/schemas/WorkflowRecipientRunEvent'
+    methods:
+      list:
+        endpoint: get /v1/workflow_recipient_runs
+      get:
+        type: http
+        endpoint: get /v1/workflow_recipient_runs/{id}
+        positional_params: [ id ]
   schedules:
     models:
       schedule: '#/components/schemas/Schedule'

next-env.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
 /// <reference types="next/navigation-types/compat/navigation" />
-import "./.next/types/routes.d.ts";
+import "./.next/dev/types/routes.d.ts";
 
 // NOTE: This file should not be edited
 // see https://nextjs.org/docs/app/api-reference/config/typescript for more information.