@zapier/zapier-sdk 0.88.0 → 0.89.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk
 
+## 0.89.0
+
+### Minor Changes
+
+- e24c236: Added `listWorkflowDrafts` and `getWorkflowDraft` (experimental). `listWorkflowDrafts` is paginated (cursor + pageSize), returns a workflow's drafts most recently edited first, and filters by `status` (server default: open) or exact `slug`. `getWorkflowDraft` returns the full draft state including `source_files` and `draft_revision`, the draft's optimistic-concurrency counter. CLI commands taking a draft id present an interactive picker. All ID inputs are UUID-validated at the boundary.
+
+## 0.88.1
+
+### Patch Changes
+
+- 60892be: _This release contains no user-facing changes._
+
 ## 0.88.0
 
 ### Minor Changes

package/README.md

@@ -35,9 +35,11 @@
   - [`getDurableRun`](#getdurablerun--experimental)
   - [`getTriggerRun`](#gettriggerrun--experimental)
   - [`getWorkflow`](#getworkflow--experimental)
+  - [`getWorkflowDraft`](#getworkflowdraft--experimental)
   - [`getWorkflowRun`](#getworkflowrun--experimental)
   - [`getWorkflowVersion`](#getworkflowversion--experimental)
   - [`listDurableRuns`](#listdurableruns--experimental)
+  - [`listWorkflowDrafts`](#listworkflowdrafts--experimental)
   - [`listWorkflowRuns`](#listworkflowruns--experimental)
   - [`listWorkflowVersions`](#listworkflowversions--experimental)
   - [`listWorkflows`](#listworkflows--experimental)
@@ -1379,6 +1381,51 @@ const { data: workflow } = await zapier.getWorkflow({
 });
 ```
 
+#### `getWorkflowDraft` 🧪 _experimental_
+
+Get full details of a workflow draft including source files
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values | Description         |
+| -------------- | -------- | -------- | ------- | --------------- | ------------------- |
+| `options`      | `object` | ✅       | —       | —               |                     |
+| ​ ↳ `workflow` | `string` | ✅       | —       | —               | Durable workflow ID |
+| ​ ↳ `draft`    | `string` | ✅       | —       | —               | Workflow draft ID   |
+
+**Returns:** `Promise<WorkflowDraftItem>`
+
+| Name                         | Type     | Required | Possible Values     | Description                                                                                                      |
+| ---------------------------- | -------- | -------- | ------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `data`                       | `object` | ✅       | —                   |                                                                                                                  |
+| ​ ↳ `id`                     | `string` | ✅       | —                   | Workflow draft ID (UUID)                                                                                         |
+| ​ ↳ `workflow_id`            | `string` | ✅       | —                   | Parent workflow ID (UUID)                                                                                        |
+| ​ ↳ `slug`                   | `string` | ✅       | —                   | Human-friendly identifier for URL routing; unique among open drafts per workflow                                 |
+| ​ ↳ `base_version_id`        | `string` | ✅       | —                   | Live version at draft creation or last publish rebase, or null before the workflow's first publish               |
+| ​ ↳ `source_files`           | `object` | ✅       | —                   | Source files keyed by filename → contents                                                                        |
+| ​ ↳ `zapier_durable_version` | `string` | ✅       | —                   | Pinned semver of @zapier/zapier-durable used by this draft                                                       |
+| ​ ↳ `dependencies`           | `object` | ✅       | —                   | Additional npm dependencies pinned for this draft (or null)                                                      |
+| ​ ↳ `draft_revision`         | `number` | ✅       | —                   | Monotonic revision counter for optimistic concurrency. Echo it back on draft updates to detect concurrent edits. |
+| ​ ↳ `status`                 | `string` | ✅       | `open`, `discarded` | Lifecycle status of a workflow draft.                                                                            |
+| ​ ↳ `created_by_user_id`     | `string` | ✅       | —                   | ID of the user who created (forked) this draft                                                                   |
+| ​ ↳ `last_edited_by_user_id` | `string` | ✅       | —                   | ID of the user who last saved this draft (or null)                                                               |
+| ​ ↳ `last_edited_at`         | `string` | ✅       | —                   | When the draft was last edited (ISO-8601, or null)                                                               |
+| ​ ↳ `discarded_at`           | `string` | ✅       | —                   | When the draft was discarded (ISO-8601), or null while open                                                      |
+| ​ ↳ `created_at`             | `string` | ✅       | —                   | When the draft was created (ISO-8601)                                                                            |
+| ​ ↳ `updated_at`             | `string` | ✅       | —                   | When the draft row was last updated (ISO-8601)                                                                   |
+| ​ ↳ `trigger`                | `object` | ✅       | —                   | Trigger configuration held on this draft, or null for webhook-only workflows.                                    |
+| ​ ↳ `connections`            | `object` | ✅       | —                   | Connection aliases bound on this draft (or null).                                                                |
+| ​ ↳ `app_versions`           | `object` | ✅       | —                   | App-version pins bound on this draft (or null).                                                                  |
+
+**Example:**
+
+```typescript
+const { data: workflowDraft } = await zapier.getWorkflowDraft({
+  workflow: "example-workflow",
+  draft: "example-draft",
+});
+```
+
 #### `getWorkflowRun` 🧪 _experimental_
 
 Get the current state of a workflow run (a triggered execution of a deployed workflow)
@@ -1498,6 +1545,64 @@ for await (const durableRun of zapier.listDurableRuns().items()) {
 }
 ```
 
+#### `listWorkflowDrafts` 🧪 _experimental_
+
+List drafts for a workflow, most recently edited first (open drafts by default)
+
+**Parameters:**
+
+| Name           | Type     | Required | Default | Possible Values     | Description                                           |
+| -------------- | -------- | -------- | ------- | ------------------- | ----------------------------------------------------- |
+| `options`      | `object` | ✅       | —       | —                   |                                                       |
+| ​ ↳ `workflow` | `string` | ✅       | —       | —                   | Durable workflow ID                                   |
+| ​ ↳ `status`   | `string` | ❌       | —       | `open`, `discarded` | Filter by draft status (server default: open)         |
+| ​ ↳ `slug`     | `string` | ❌       | —       | —                   | Filter by exact slug match; returns at most one draft |
+| ​ ↳ `pageSize` | `number` | ❌       | —       | —                   | Number of drafts per page (max 100)                   |
+| ​ ↳ `cursor`   | `string` | ❌       | —       | —                   | Pagination cursor                                     |
+| ​ ↳ `maxItems` | `number` | ❌       | —       | —                   | Maximum total drafts to return across all pages       |
+
+**Returns:** `Promise<PaginatedResult<WorkflowDraftItem>>`
+
+| Name                         | Type       | Required | Possible Values     | Description                                                                                        |
+| ---------------------------- | ---------- | -------- | ------------------- | -------------------------------------------------------------------------------------------------- |
+| `data[]`                     | `object[]` | ✅       | —                   |                                                                                                    |
+| ​ ↳ `id`                     | `string`   | ✅       | —                   | Workflow draft ID (UUID)                                                                           |
+| ​ ↳ `workflow_id`            | `string`   | ✅       | —                   | Parent workflow ID (UUID)                                                                          |
+| ​ ↳ `slug`                   | `string`   | ✅       | —                   | Human-friendly identifier for URL routing; unique among open drafts per workflow                   |
+| ​ ↳ `base_version_id`        | `string`   | ✅       | —                   | Live version at draft creation or last publish rebase, or null before the workflow's first publish |
+| ​ ↳ `status`                 | `string`   | ✅       | `open`, `discarded` | Lifecycle status of a workflow draft.                                                              |
+| ​ ↳ `last_edited_by_user_id` | `string`   | ✅       | —                   | ID of the user who last saved this draft (or null)                                                 |
+| ​ ↳ `last_edited_at`         | `string`   | ✅       | —                   | When the draft was last edited (ISO-8601, or null)                                                 |
+| ​ ↳ `created_at`             | `string`   | ✅       | —                   | When the draft was created (ISO-8601)                                                              |
+| `nextCursor`                 | `string`   | ❌       | —                   | Cursor for the next page; omitted when there are no more pages                                     |
+
+**Example:**
+
+```typescript
+// Get first page and a cursor for the second page
+const { data: workflowDrafts, nextCursor } = await zapier.listWorkflowDrafts({
+  workflow: "example-workflow",
+});
+
+// Or iterate over all pages
+for await (const page of zapier
+  .listWorkflowDrafts({
+    workflow: "example-workflow",
+  })
+  .pages()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const workflowDraft of zapier
+  .listWorkflowDrafts({
+    workflow: "example-workflow",
+  })
+  .items()) {
+  // Do something with each workflowDraft
+}
+```
+
 #### `listWorkflowRuns` 🧪 _experimental_
 
 List workflow runs (triggered executions) for a specific deployed workflow, newest first