@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/sequences.md

@@ -0,0 +1,3232 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.sequences`: Sequences
+
+71 operations (30 read, 19 write, 9 destructive, 4 billable, 9 external).
+
+6 of these also have a hand-written method (`g8.sequences`), marked **★** below. Prefer the hand-written method when one exists: it unwraps the `data` envelope and takes friendlier arguments. See [../sdk-clients.md](../sdk-clients.md).
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [sequences.d.ts](sequences.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`addContactsToSequence`](#op-addcontactstosequence) ★ | `POST /api/v1/sequences/{sequence_id}/contacts` | external | `sequences:run` | Add Contacts To Sequence |
+| [`addSequenceChannels`](#op-addsequencechannels) | `POST /api/v1/sequences/{sequence_id}/channels` | write | `sequences:write` | Add Sequence Channels |
+| [`addSequenceSteps`](#op-addsequencesteps) | `POST /api/v1/sequences/{sequence_id}/steps` | write | `sequences:write` | Add Sequence Steps |
+| [`archiveSchedule`](#op-archiveschedule) | `PATCH /api/v1/schedules/{schedule_id}/archive` | destructive | `campaigns:delete` | Archive Schedule |
+| [`archiveSequence`](#op-archivesequence) | `POST /api/v1/sequences/{sequence_id}/archive` | destructive | `sequences:delete` | Archive Sequence |
+| [`archiveSequenceTemplate`](#op-archivesequencetemplate) | `PATCH /api/v1/sequencer/templates/sequences/{sequence_template_id}/archive` | destructive | `sequences:delete` | Archive Sequence Template |
+| [`archiveStepTemplate`](#op-archivesteptemplate) | `PATCH /api/v1/sequencer/templates/steps/{step_template_id}/archive` | destructive | `sequences:delete` | Archive Step Template |
+| [`createNurture`](#op-createnurture) | `POST /api/v1/nurtures` | write | `sequences:write` | Create Nurture |
+| [`createSchedule`](#op-createschedule) | `POST /api/v1/schedules` | write | `campaigns:write` | Create Schedule |
+| [`createSequenceTemplate`](#op-createsequencetemplate) | `POST /api/v1/sequencer/templates/sequences` | write | `sequences:write` | Create Sequence Template |
+| [`createStepTemplate`](#op-createsteptemplate) | `POST /api/v1/sequencer/templates/steps` | write | `sequences:write` | Create Step Template |
+| [`deleteNurture`](#op-deletenurture) | `DELETE /api/v1/nurtures/{nurture_id}` | destructive | `sequences:delete` | Delete Nurture |
+| [`deleteSequenceStep`](#op-deletesequencestep) | `DELETE /api/v1/sequences/{sequence_id}/steps/{step_id}` | destructive | `sequences:delete` | Delete Sequence Step |
+| [`draftEmail`](#op-draftemail) | `POST /api/v1/sequencer/content/email/generate` | billable | `sequences:run` | Draft Email |
+| [`draftLinkedinMessage`](#op-draftlinkedinmessage) | `POST /api/v1/sequencer/content/linkedin/generate` | billable | `sequences:run` | Draft Linkedin Message |
+| [`duplicateNurture`](#op-duplicatenurture) | `POST /api/v1/nurtures/{nurture_id}/duplicate` | write | `sequences:write` | Duplicate Nurture |
+| [`duplicateSequence`](#op-duplicatesequence) | `POST /api/v1/sequences/{sequence_id}/duplicate` | write | `sequences:write` | Duplicate Sequence |
+| [`estimateEmailDraft`](#op-estimateemaildraft) | `POST /api/v1/sequencer/content/email/estimate` | read | `sequences:read` | Estimate Email Draft |
+| [`generateSequenceSpintax`](#op-generatesequencespintax) | `POST /api/v1/sequences/generate-spintax` | external | `sequences:run` | Generate Sequence Spintax |
+| [`generateStepTemplates`](#op-generatesteptemplates) | `POST /api/v1/sequencer/templates/steps/generate` | billable | `sequences:run` | Generate Step Templates |
+| [`getNurture`](#op-getnurture) | `GET /api/v1/nurtures/{nurture_id}` | read | `sequences:read` | Get Nurture |
+| [`getProviderSizing`](#op-getprovidersizing) | `GET /api/v1/sequencer/deliverability/provider-sizing` | read | `sequences:read` | Get Provider Sizing |
+| [`getSchedule`](#op-getschedule) | `GET /api/v1/schedules/{schedule_id}` | read | `campaigns:read` | Get Schedule |
+| [`getSequence`](#op-getsequence) ★ | `GET /api/v1/sequences/{sequence_id}` | read | `sequences:read` | Get Sequence |
+| [`getSequenceJob`](#op-getsequencejob) | `GET /api/v1/sequence-jobs/{job_id}` | read | `sequences:read` | Get Sequence Job |
+| [`getSequenceReports`](#op-getsequencereports) | `GET /api/v1/sequences/{sequence_id}/reports` | read | `sequences:read` | Get Sequence Reports |
+| [`getSequenceRoutingSummary`](#op-getsequenceroutingsummary) | `GET /api/v1/sequences/{sequence_id}/routing-summary` | read | `sequences:read` | Get Sequence Routing Summary |
+| [`getSequenceStats`](#op-getsequencestats) | `GET /api/v1/sequences/{sequence_id}/stats` | read | `sequences:read` | Get Sequence Stats |
+| [`getSequencerCapacityEstimate`](#op-getsequencercapacityestimate) | `GET /api/v1/sequencer/channels/capacity-estimate` | read | `sequences:read` | Get Sequencer Capacity Estimate |
+| [`getSequencesOverview`](#op-getsequencesoverview) | `GET /api/v1/sequencer/stats` | read | `sequences:read` | Get Sequences Overview |
+| [`improveStepInstruction`](#op-improvestepinstruction) | `POST /api/v1/sequencer/content/instructions/improve` | billable | `sequences:run` | Improve Step Instruction |
+| [`launchNurture`](#op-launchnurture) | `POST /api/v1/nurtures/{nurture_id}/launch` | external | `sequences:run` | Launch Nurture |
+| [`linkSequenceCampaign`](#op-linksequencecampaign) | `PUT /api/v1/sequences/{sequence_id}/campaign` | write | `sequences:write` | Link Sequence Campaign |
+| [`listDialerContacts`](#op-listdialercontacts) | `GET /api/v1/sequencer/dialer/sequences/{sequence_id}/contacts` | read | `sequences:read` | List Dialer Contacts |
+| [`listDialerSequences`](#op-listdialersequences) | `GET /api/v1/sequencer/dialer/sequences` | read | `sequences:read` | List Dialer Sequences |
+| [`listEmailDraftModels`](#op-listemaildraftmodels) | `GET /api/v1/sequencer/content/email/models` | read | `sequences:read` | List Email Draft Models |
+| [`listLinkedinAccounts`](#op-listlinkedinaccounts) | `GET /api/v1/sequencer/channels/linkedin_accounts` | read | `sequences:read` | List Linkedin Accounts |
+| [`listNurtures`](#op-listnurtures) | `GET /api/v1/nurtures` | read | `sequences:read` | List Nurtures |
+| [`listSegVendors`](#op-listsegvendors) | `GET /api/v1/sequencer/deliverability/seg-vendors` | read | `sequences:read` | List Seg Vendors |
+| [`listSequenceChannels`](#op-listsequencechannels) | `GET /api/v1/sequences/{sequence_id}/channels` | read | `sequences:read` | List Sequence Channels |
+| [`listSequenceContactIds`](#op-listsequencecontactids) | `GET /api/v1/sequences/{sequence_id}/contact-ids` | read | `sequences:read` | List Sequence Contact Ids |
+| [`listSequenceContacts`](#op-listsequencecontacts) ★ | `GET /api/v1/sequences/{sequence_id}/contacts` | read | `sequences:read` | List Sequence Contacts |
+| [`listSequenceTemplates`](#op-listsequencetemplates) | `GET /api/v1/sequencer/templates/sequences` | read | `sequences:read` | List Sequence Templates |
+| [`listSequencerMailboxes`](#op-listsequencermailboxes) | `GET /api/v1/sequencer/channels/mailboxes` | read | `sequences:read` | List Sequencer Mailboxes |
+| [`listSequencerPhoneNumbers`](#op-listsequencerphonenumbers) | `GET /api/v1/sequencer/channels/phone_numbers` | read | `sequences:read` | List Sequencer Phone Numbers |
+| [`listSequencerSmsNumbers`](#op-listsequencersmsnumbers) | `GET /api/v1/sequencer/channels/sms_numbers` | read | `sequences:read` | List Sequencer Sms Numbers |
+| [`listSequencerTextualAgents`](#op-listsequencertextualagents) | `GET /api/v1/sequencer/agents/textual` | read | `sequences:read` | List Sequencer Textual Agents |
+| [`listSequencerVoiceAgents`](#op-listsequencervoiceagents) | `GET /api/v1/sequencer/agents/voice` | read | `sequences:read` | List Sequencer Voice Agents |
+| [`listSequencerWhatsappNumbers`](#op-listsequencerwhatsappnumbers) | `GET /api/v1/sequencer/channels/whatsapp_numbers` | read | `sequences:read` | List Sequencer Whatsapp Numbers |
+| [`listSequencerWhatsappTemplates`](#op-listsequencerwhatsapptemplates) | `GET /api/v1/sequencer/channels/whatsapp_templates` | read | `sequences:read` | List Sequencer Whatsapp Templates |
+| [`listSequences`](#op-listsequences) | `GET /api/v1/sequences` | read | `sequences:read` | List Sequences |
+| [`listStepTemplates`](#op-liststeptemplates) | `GET /api/v1/sequencer/templates/steps` | read | `sequences:read` | List Step Templates |
+| [`pauseNurture`](#op-pausenurture) | `POST /api/v1/nurtures/{nurture_id}/pause` | write | `sequences:write` | Pause Nurture |
+| [`pauseSequence`](#op-pausesequence) ★ | `POST /api/v1/sequences/{sequence_id}/pause` | external | `sequences:run` | Pause Sequence |
+| [`pauseSequenceContact`](#op-pausesequencecontact) | `POST /api/v1/sequences/{sequence_id}/contacts/{contact_id}/pause` | write | `sequences:write` | Pause Sequence Contact |
+| [`placeVoiceTestCall`](#op-placevoicetestcall) | `POST /api/v1/sequencer/content/voice/test-call` | external | `sequences:run` | Place Voice Test Call |
+| [`recordDialerOutcome`](#op-recorddialeroutcome) | `POST /api/v1/sequencer/dialer/sequences/{sequence_id}/contacts/{contact_id}/callback` | write | `sequences:write` | Record Dialer Outcome |
+| [`removeSequenceChannel`](#op-removesequencechannel) | `DELETE /api/v1/sequences/{sequence_id}/channels/{sequence_channel_id}` | destructive | `sequences:delete` | Remove Sequence Channel |
+| [`removeSequenceChannels`](#op-removesequencechannels) | `DELETE /api/v1/sequences/{sequence_id}/channels` | destructive | `sequences:delete` | Remove Sequence Channels |
+| [`resumeNurture`](#op-resumenurture) | `POST /api/v1/nurtures/{nurture_id}/resume` | write | `sequences:write` | Resume Nurture |
+| [`resumeSequence`](#op-resumesequence) ★ | `POST /api/v1/sequences/{sequence_id}/resume` | external | `sequences:run` | Resume Sequence |
+| [`resumeSequenceContact`](#op-resumesequencecontact) | `POST /api/v1/sequences/{sequence_id}/contacts/{contact_id}/resume` | external | `sequences:run` | Resume Sequence Contact |
+| [`runSequence`](#op-runsequence) ★ | `POST /api/v1/sequences/{sequence_id}/run` | external | `sequences:run` | Run Sequence |
+| [`setSequenceStatus`](#op-setsequencestatus) | `POST /api/v1/sequences/{sequence_id}/status` | write | `sequences:write` | Set Sequence Status |
+| [`syncSequence`](#op-syncsequence) | `POST /api/v1/sequences/{sequence_id}/sync` | external | `sequences:run` | Sync Sequence |
+| [`terminateSequence`](#op-terminatesequence) | `POST /api/v1/sequences/{sequence_id}/terminate` | write | `sequences:write` | Terminate Sequence |
+| [`unlinkSequenceCampaign`](#op-unlinksequencecampaign) | `DELETE /api/v1/sequences/{sequence_id}/campaign` | destructive | `sequences:delete` | Unlink Sequence Campaign |
+| [`updateNurture`](#op-updatenurture) | `PATCH /api/v1/nurtures/{nurture_id}` | write | `sequences:write` | Update Nurture |
+| [`updateSchedule`](#op-updateschedule) | `PATCH /api/v1/schedules/{schedule_id}` | write | `campaigns:write` | Update Schedule |
+| [`updateSequenceTemplate`](#op-updatesequencetemplate) | `PATCH /api/v1/sequencer/templates/sequences/{sequence_template_id}` | write | `sequences:write` | Update Sequence Template |
+| [`updateStepTemplate`](#op-updatesteptemplate) | `PATCH /api/v1/sequencer/templates/steps/{step_template_id}` | write | `sequences:write` | Update Step Template |
+
+---
+
+<a id="op-addcontactstosequence"></a>
+
+### `g8.api.sequences.addContactsToSequence(input)`
+
+**Add Contacts To Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/contacts`
+- operationId: `add_contacts_to_sequence_sequences__sequence_id__contacts_post` (also callable as `g8.api.call("add_contacts_to_sequence_sequences__sequence_id__contacts_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+- ★ Hand-written: [`g8.sequences.add()`](../sdk-clients.md#g8-sequences-add)
+
+Add contacts to a live or drafted sequence using V2 queuing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+| `body` | `AddSequenceContactsRequest` | yes | Request body; fields below. |
+
+Body fields (`AddSequenceContactsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contact_ids` | `Array<integer>` | yes | Contact IDs to add to the sequence |
+| `body.list_id` | `integer` | yes | List ID the contacts belong to |
+
+**Returns** `ApiResponse_SequenceActionResponse_`: the envelope `{ data: SequenceActionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceActionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `sequence_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `contacts_affected` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.addContactsToSequence({
+  path: { sequence_id: "id" },
+  body: { contact_ids: [123], list_id: 123 },
+});
+```
+
+---
+
+<a id="op-addsequencechannels"></a>
+
+### `g8.api.sequences.addSequenceChannels(input)`
+
+**Add Sequence Channels**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/channels`
+- operationId: `add_sequence_channels_sequences__sequence_id__channels_post` (also callable as `g8.api.call("add_sequence_channels_sequences__sequence_id__channels_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Attach senders to a sequence. Answers with every channel now attached.
+
+Take the values from the `/sequencer/channels/*` pickers: `channel_id` is
+the sender's own id and `channel_value` its address.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `body` | `AddChannelsRequest` | yes | Request body; fields below. |
+
+Body fields (`AddChannelsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channels` | `Array<AddChannelItem>` | yes | min items 1 |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.addSequenceChannels({
+  path: { sequence_id: "id" },
+  body: {
+    channels: [
+      { channel_id: 123, channel_type: "SMTP", channel_value: "example" },
+    ],
+  },
+});
+```
+
+---
+
+<a id="op-addsequencesteps"></a>
+
+### `g8.api.sequences.addSequenceSteps(input)`
+
+**Add Sequence Steps**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/steps`
+- operationId: `add_sequence_steps_sequences__sequence_id__steps_post` (also callable as `g8.api.call("add_sequence_steps_sequences__sequence_id__steps_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Add one or more steps to an existing sequence. Answers with EVERY step now in it.
+
+The content is validated on write, as in the app: copy that cannot render
+(broken spintax, unclosed merge tags) is a 400 naming the problem, and
+hand-written copy on an `ON_DEMAND` step - which the generator would
+silently discard - is refused rather than accepted and dropped.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `body` | `AddStepsRequest` | yes | Request body; fields below. |
+
+Body fields (`AddStepsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.steps` | `Array<AddStepItem>` | yes | min items 1 |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.addSequenceSteps({
+  path: { sequence_id: "id" },
+  body: {
+    steps: [
+      {
+        input_type: "ON_DEMAND",
+        step_data: {},
+        step_order: 1,
+        step_type: "PHONE",
+      },
+    ],
+  },
+});
+```
+
+---
+
+<a id="op-archiveschedule"></a>
+
+### `g8.api.sequences.archiveSchedule(input)`
+
+**Archive Schedule**
+
+- HTTP: `PATCH /api/v1/schedules/{schedule_id}/archive`
+- operationId: `archive_schedule_schedules__schedule_id__archive_patch` (also callable as `g8.api.call("archive_schedule_schedules__schedule_id__archive_patch", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `campaigns:delete`
+
+Archive or UN-archive a schedule (`is_archived` is explicit).
+
+Archived schedules drop out of `GET /schedules` unless `include_archived`
+is set. Nothing is deleted.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id, from `GET /schedules`. |
+| `body` | `ArchiveRequest` | yes | Request body; fields below. |
+
+Body fields (`ArchiveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_archived` | `boolean` | yes |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.archiveSchedule({ path: { schedule_id: "id" }, body: { is_archived: true } });
+```
+
+---
+
+<a id="op-archivesequence"></a>
+
+### `g8.api.sequences.archiveSequence(input)`
+
+**Archive Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/archive`
+- operationId: `archive_sequence_sequences__sequence_id__archive_post` (also callable as `g8.api.call("archive_sequence_sequences__sequence_id__archive_post", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Archive a sequence - a soft delete.
+
+NOT REVERSIBLE THROUGH THIS API TODAY. The app's `unarchive` endpoint is a
+reserved stub that unconditionally returns 403 ("Unarchiving is not
+available yet"), so it is not published here - archiving is a one-way door
+for an API caller until that lands. Contact support to restore one.
+
+A LIVE or WAITING sequence is paused first and wound down in the
+background; `is_archived` blocks every worker immediately. Archiving one
+that is already archived is a 400, and one mid-transition (scheduling,
+pausing) is a 409, so a retry loop cannot corrupt the state machine.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.archiveSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-archivesequencetemplate"></a>
+
+### `g8.api.sequences.archiveSequenceTemplate(input)`
+
+**Archive Sequence Template**
+
+- HTTP: `PATCH /api/v1/sequencer/templates/sequences/{sequence_template_id}/archive`
+- operationId: `archive_sequence_template_sequencer_templates_sequences__sequence_template_id__archive_patch` (also callable as `g8.api.call("archive_sequence_template_sequencer_templates_sequences__sequence_template_id__archive_patch", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Archive or UN-archive a sequence template (`is_archived` is explicit).
+
+Nothing is deleted - the row stays in the list with `is_archived` set.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_template_id` | `string` | yes | Sequence template id. |
+| `body` | `ArchiveRequest` | yes | Request body; fields below. |
+
+Body fields (`ArchiveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_archived` | `boolean` | yes |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.archiveSequenceTemplate({ path: { sequence_template_id: "id" }, body: { is_archived: true } });
+```
+
+---
+
+<a id="op-archivesteptemplate"></a>
+
+### `g8.api.sequences.archiveStepTemplate(input)`
+
+**Archive Step Template**
+
+- HTTP: `PATCH /api/v1/sequencer/templates/steps/{step_template_id}/archive`
+- operationId: `archive_step_template_sequencer_templates_steps__step_template_id__archive_patch` (also callable as `g8.api.call("archive_step_template_sequencer_templates_steps__step_template_id__archive_patch", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Archive or un-archive a step template (`is_archived` is explicit).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.step_template_id` | `string` | yes | Step template id. |
+| `body` | `ArchiveRequest` | yes | Request body; fields below. |
+
+Body fields (`ArchiveRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_archived` | `boolean` | yes |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.archiveStepTemplate({ path: { step_template_id: "id" }, body: { is_archived: true } });
+```
+
+---
+
+<a id="op-createnurture"></a>
+
+### `g8.api.sequences.createNurture(input)`
+
+**Create Nurture**
+
+- HTTP: `POST /api/v1/nurtures`
+- operationId: `create_nurture_nurtures_post` (also callable as `g8.api.call("create_nurture_nurtures_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Create a nurture.
+
+`sequence_kind` is pinned to `nurture` by the app and re-validated there,
+so the nurture-specific channel rules fire even though this endpoint never
+accepts the field. `user_email` defaults to the identity the key was
+minted under; a personal nurture owned by anyone else is a 403.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `NurtureCreateRequest` | yes | Request body; fields below. |
+
+Body fields (`NurtureCreateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | Nurture name. min length 1 |
+| `body.pinned_mailbox_id` | `integer` | yes | The ONE mailbox this nurture sends from. Required: a nurture is pinned to a single sender so its consented audience always hears from the same address, and every email channel attached must use it. `validate_nurture_rules` rejects a nurture without one, so this is required here rather than left to fail deeper in. |
+| `body.associated_list_id` | `integer \| null` | no | Audience list whose contacts this nurture engages. |
+| `body.campaign_builder_campaign_id` | `string \| null` | no | Studio campaign to link this nurture to. |
+| `body.channels` | `Array<Record<string, unknown>>` | no | Sending channels to attach. |
+| `body.description` | `string \| null` | no |  |
+| `body.finish_on_reply` | `boolean` | no | Stop nurturing a contact once they reply. default `true` |
+| `body.include_unsubscribe_cta` | `boolean` | no | Append the visible reply-opt-out CTA to email bodies. default `true` |
+| `body.is_shared` | `boolean` | no | True makes the nurture visible org-wide. Requires an Admin or Owner role; see this router's note on org-scope promotion. default `false` |
+| `body.schedule_id` | `string \| null` | no |  |
+| `body.send_in_same_thread` | `boolean` | no | Keep follow-ups in the original email thread. default `true` |
+| `body.status` | `string` | no | Initial status. Nurtures start drafted. default `"drafted"` |
+| `body.steps` | `Array<Record<string, unknown>>` | no | Sequence steps, in order. |
+| `body.textual_agent_name` | `string \| null` | no |  |
+| `body.user_email` | `string \| null` | no | Owner of the nurture. Defaults to the identity the key was minted under. A PERSONAL nurture can only be owned by the caller - supplying anyone else's address with `is_shared=false` is a 403. |
+| `body.voice_agent_name` | `string \| null` | no |  |
+| `body.wait_for_new_contacts` | `boolean` | no | default `false` |
+
+**Returns** `ApiResponse_NurtureResponse_`: the envelope `{ data: NurtureResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`NurtureResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_shared` | `boolean \| null` | no | True when visible org-wide. |
+| `name` | `string \| null` | no |  |
+| `status` | `string \| null` | no | draft, live, paused, completed, terminated. |
+| `updated_at` | `string (date-time) \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.createNurture({ body: { name: "Example", pinned_mailbox_id: 123 } });
+```
+
+---
+
+<a id="op-createschedule"></a>
+
+### `g8.api.sequences.createSchedule(input)`
+
+**Create Schedule**
+
+- HTTP: `POST /api/v1/schedules`
+- operationId: `create_schedule_schedules_post` (also callable as `g8.api.call("create_schedule_schedules_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Create a sending schedule: a weekly set of windows in one timezone.
+
+A day left out of `config` is a day nothing is sent. Put it on a sequence
+with `PATCH /sequences/{id}` (`schedule_id`).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateSendingScheduleRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateSendingScheduleRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.config` | `SendingWeek` | yes |  |
+| `body.name` | `string` | yes | max length 255 |
+| `body.description` | `string \| null` | no | max length 1024 |
+| `body.timezone` | `string` | no | IANA timezone. default `"UTC"`, max length 128 |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.createSchedule({ body: { config: {}, name: "Example" } });
+```
+
+---
+
+<a id="op-createsequencetemplate"></a>
+
+### `g8.api.sequences.createSequenceTemplate(input)`
+
+**Create Sequence Template**
+
+- HTTP: `POST /api/v1/sequencer/templates/sequences`
+- operationId: `create_sequence_template_sequencer_templates_sequences_post` (also callable as `g8.api.call("create_sequence_template_sequencer_templates_sequences_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Save a reusable sequence skeleton.
+
+Answers with the FULL template list, not the new row - that is the app's
+response, kept so the two cannot disagree about what was created.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateSequenceTemplateRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateSequenceTemplateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | max length 255 |
+| `body.appointment_id` | `integer \| null` | no | Event type id for the booking link. |
+| `body.description` | `string \| null` | no |  |
+| `body.schedule_id` | `string \| null` | no | Sending schedule, from `GET /schedules`. |
+| `body.steps` | `Array<SequenceTemplateStep> \| null` | no |  |
+| `body.textual_agent_name` | `string \| null` | no | Agent for email / social steps. |
+| `body.voice_agent_name` | `string \| null` | no | Agent for phone / SMS steps. |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.createSequenceTemplate({ body: { name: "Example" } });
+```
+
+---
+
+<a id="op-createsteptemplate"></a>
+
+### `g8.api.sequences.createStepTemplate(input)`
+
+**Create Step Template**
+
+- HTTP: `POST /api/v1/sequencer/templates/steps`
+- operationId: `create_step_template_sequencer_templates_steps_post` (also callable as `g8.api.call("create_step_template_sequencer_templates_steps_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Save reusable step content. Answers with the full list, as the app does.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateStepTemplateRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateStepTemplateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.input_type` | `"ON_DEMAND" \| "AI_GENERATED_TEMPLATE" \| "MANUAL_TEMPLATE"` | yes |  |
+| `body.name` | `string` | yes |  |
+| `body.step_data` | `Record<string, unknown>` | yes | The step's content: `subject` / `body` for email, `message_body` for SMS and WhatsApp, the `linkedin_*` fields for LinkedIn, `instructions` for AI generation. The same shape as `step_data` on `GET /sequences/{sequence_id}/steps`. |
+| `body.step_type` | `"PHONE" \| "EMAIL" \| "MANUAL_DIALER" \| "HEYREACH" \| "NETRION" \| "SMS" \| "WHATSAPP"` | yes |  |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.createStepTemplate({
+  body: {
+    input_type: "ON_DEMAND",
+    name: "Example",
+    step_data: {},
+    step_type: "PHONE",
+  },
+});
+```
+
+---
+
+<a id="op-deletenurture"></a>
+
+### `g8.api.sequences.deleteNurture(input)`
+
+**Delete Nurture**
+
+- HTTP: `DELETE /api/v1/nurtures/{nurture_id}`
+- operationId: `delete_nurture_nurtures__nurture_id__delete` (also callable as `g8.api.call("delete_nurture_nurtures__nurture_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Archive a nurture - a soft delete, not a purge.
+
+A LIVE or WAITING nurture is paused first and wound down in the
+background; `is_archived` blocks every worker immediately. Archiving an
+already-archived nurture is a 400, and one mid-transition (scheduling,
+pausing) is a 409, so a retry loop cannot corrupt the state machine.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.deleteNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-deletesequencestep"></a>
+
+### `g8.api.sequences.deleteSequenceStep(input)`
+
+**Delete Sequence Step**
+
+- HTTP: `DELETE /api/v1/sequences/{sequence_id}/steps/{step_id}`
+- operationId: `delete_sequence_step_sequences__sequence_id__steps__step_id__delete` (also callable as `g8.api.call("delete_sequence_step_sequences__sequence_id__steps__step_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Permanently delete a step. Returns the sequence's remaining steps.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `path.step_id` | `string` | yes | Step id. |
+
+**Returns** `ApiResponse_SequenceOpsPayload_`: the envelope `{ data: SequenceOpsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.deleteSequenceStep({ path: { sequence_id: "id", step_id: "id" } });
+```
+
+---
+
+<a id="op-draftemail"></a>
+
+### `g8.api.sequences.draftEmail(input)`
+
+**Draft Email**
+
+- HTTP: `POST /api/v1/sequencer/content/email/generate`
+- operationId: `draft_email_sequencer_content_email_generate_post` (also callable as `g8.api.call("draft_email_sequencer_content_email_generate_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Draft one contact's email with an agent. SPENDS CREDITS per call.
+
+Returns the subject and body; nothing is saved or sent. A 402 means the
+organisation is out of credits. Price it first with `.../email/estimate`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `DraftEmailRequest` | yes | Request body; fields below. |
+
+Body fields (`DraftEmailRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agent_name` | `string` | yes | The textual agent whose voice and context are used. |
+| `body.contact_id` | `integer` | yes |  |
+| `body.contact_work_email` | `string` | yes |  |
+| `body.first_name` | `string` | yes |  |
+| `body.instructions` | `string` | yes | What the email should do - the step's prompt. |
+| `body.last_name` | `string` | yes |  |
+| `body.lead_info` | `string` | yes | What is known about the contact, as free text. |
+| `body.model` | `string \| null` | no | Model slug, from `GET /sequencer/content/email/models`. |
+| `body.provider` | `"openai" \| "anthropic" \| "openrouter" \| null` | no | Model provider, from `GET /sequencer/content/email/models`. |
+| `body.sequence_id` | `string \| null` | no | Draft in the context of this sequence's linked campaign. |
+| `body.step_order` | `integer \| null` | no |  |
+| `body.studio_campaign_id` | `string \| null` | no | Draft in this campaign's context; wins over `sequence_id`. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.sequences.draftEmail({
+  body: {
+    agent_name: "Example",
+    contact_id: 123,
+    contact_work_email: "jane@acme.com",
+    first_name: "Example",
+    instructions: "example",
+    last_name: "Example",
+    lead_info: "example",
+  },
+});
+```
+
+---
+
+<a id="op-draftlinkedinmessage"></a>
+
+### `g8.api.sequences.draftLinkedinMessage(input)`
+
+**Draft Linkedin Message**
+
+- HTTP: `POST /api/v1/sequencer/content/linkedin/generate`
+- operationId: `draft_linkedin_message_sequencer_content_linkedin_generate_post` (also callable as `g8.api.call("draft_linkedin_message_sequencer_content_linkedin_generate_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Draft one contact's LinkedIn message with an agent. SPENDS CREDITS per call.
+
+Returns `message` (and `subject` for an InMail); nothing is saved or sent.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `DraftLinkedInRequest` | yes | Request body; fields below. |
+
+Body fields (`DraftLinkedInRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.contact_id` | `integer` | yes |  |
+| `body.first_name` | `string` | yes |  |
+| `body.instructions` | `string` | yes |  |
+| `body.last_name` | `string` | yes |  |
+| `body.lead_info` | `string` | yes |  |
+| `body.linkedin_action_type` | `string` | yes | The LinkedIn step kind the message is for, e.g. a connection request or a message. |
+| `body.agent_name` | `string` | no | default `"default-agent"` |
+| `body.step_history` | `string \| null` | no | What earlier steps already said, so the draft does not repeat it. |
+| `body.studio_campaign_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.sequences.draftLinkedinMessage({
+  body: {
+    contact_id: 123,
+    first_name: "Example",
+    instructions: "example",
+    last_name: "Example",
+    lead_info: "example",
+    linkedin_action_type: "example",
+  },
+});
+```
+
+---
+
+<a id="op-duplicatenurture"></a>
+
+### `g8.api.sequences.duplicateNurture(input)`
+
+**Duplicate Nurture**
+
+- HTTP: `POST /api/v1/nurtures/{nurture_id}/duplicate`
+- operationId: `duplicate_nurture_nurtures__nurture_id__duplicate_post` (also callable as `g8.api.call("duplicate_nurture_nurtures__nurture_id__duplicate_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Copy a nurture. The copy is drafted, owned by the caller, no channels.
+
+`user_email` is pinned to the caller by the app even if one is sent, which
+is why the request model does not offer it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id to copy. |
+| `body` | `NurtureDuplicateRequest` | no | Request body; fields below. |
+
+Body fields (`NurtureDuplicateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_new_list` | `boolean \| null` | no | Give the copy a fresh contacts list instead of reusing the source's. |
+| `body.is_shared` | `boolean \| null` | no | Share setting for the copy. Omit to INHERIT the source's setting - which means duplicating an already-shared nurture still needs Admin/Owner even though this field was never sent. |
+| `body.name` | `string \| null` | no | Name for the copy. Defaults to the source name with ' (Copy)' appended. |
+| `body.new_list_id` | `integer \| null` | no | Existing list for the copy. Ignored unless `is_new_list` is true. |
+
+**Returns** `ApiResponse_NurtureResponse_`: the envelope `{ data: NurtureResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`NurtureResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_shared` | `boolean \| null` | no | True when visible org-wide. |
+| `name` | `string \| null` | no |  |
+| `status` | `string \| null` | no | draft, live, paused, completed, terminated. |
+| `updated_at` | `string (date-time) \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.duplicateNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-duplicatesequence"></a>
+
+### `g8.api.sequences.duplicateSequence(input)`
+
+**Duplicate Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/duplicate`
+- operationId: `duplicate_sequence_sequences__sequence_id__duplicate_post` (also callable as `g8.api.call("duplicate_sequence_sequences__sequence_id__duplicate_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Copy a sequence. The copy is drafted, owned by the caller, no channels.
+
+`user_email` is pinned to the caller by the app even if one is sent, which
+is why the request model does not offer it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id to copy. |
+| `body` | `SequenceDuplicateRequest` | no | Request body; fields below. |
+
+Body fields (`SequenceDuplicateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.is_new_list` | `boolean \| null` | no | Give the copy a fresh contacts list instead of the source's. |
+| `body.is_shared` | `boolean \| null` | no | Share setting for the copy. Omit to INHERIT the source's - which means duplicating an already-shared sequence can still require Admin/Owner even though this field was never sent. |
+| `body.name` | `string \| null` | no | Name for the copy. Defaults to the source name with ' (Copy)' appended. |
+| `body.new_list_id` | `integer \| null` | no | Existing list for the copy. Ignored unless `is_new_list` is true. |
+
+**Returns** `ApiResponse_SequenceRecord_`: the envelope `{ data: SequenceRecord, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceRecord` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `associated_list_id` | `integer \| null` | no |  |
+| `campaign_builder_campaign_id` | `string \| null` | no | Linked Studio campaign, if any. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `is_shared` | `boolean \| null` | no |  |
+| `name` | `string \| null` | no |  |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `user_email` | `string \| null` | no | Owner. |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.duplicateSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-estimateemaildraft"></a>
+
+### `g8.api.sequences.estimateEmailDraft(input)`
+
+**Estimate Email Draft**
+
+- HTTP: `POST /api/v1/sequencer/content/email/estimate`
+- operationId: `estimate_email_draft_sequencer_content_email_estimate_post` (also callable as `g8.api.call("estimate_email_draft_sequencer_content_email_estimate_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+What drafting this email WOULD cost, in credits - without drafting it. Free.
+
+Takes exactly the body of `.../email/generate`, and builds the identical
+prompt, so the number is what that call is billed. `cached: true` with
+`estimated_credits: 0` means the draft would be served from cache free.
+A 503 means the price list is unavailable - the cost is unknown, not zero.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `DraftEmailRequest` | yes | Request body; fields below. |
+
+Body fields (`DraftEmailRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agent_name` | `string` | yes | The textual agent whose voice and context are used. |
+| `body.contact_id` | `integer` | yes |  |
+| `body.contact_work_email` | `string` | yes |  |
+| `body.first_name` | `string` | yes |  |
+| `body.instructions` | `string` | yes | What the email should do - the step's prompt. |
+| `body.last_name` | `string` | yes |  |
+| `body.lead_info` | `string` | yes | What is known about the contact, as free text. |
+| `body.model` | `string \| null` | no | Model slug, from `GET /sequencer/content/email/models`. |
+| `body.provider` | `"openai" \| "anthropic" \| "openrouter" \| null` | no | Model provider, from `GET /sequencer/content/email/models`. |
+| `body.sequence_id` | `string \| null` | no | Draft in the context of this sequence's linked campaign. |
+| `body.step_order` | `integer \| null` | no |  |
+| `body.studio_campaign_id` | `string \| null` | no | Draft in this campaign's context; wins over `sequence_id`. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.estimateEmailDraft({
+  body: {
+    agent_name: "Example",
+    contact_id: 123,
+    contact_work_email: "jane@acme.com",
+    first_name: "Example",
+    instructions: "example",
+    last_name: "Example",
+    lead_info: "example",
+  },
+});
+```
+
+---
+
+<a id="op-generatesequencespintax"></a>
+
+### `g8.api.sequences.generateSequenceSpintax(input)`
+
+**Generate Sequence Spintax**
+
+- HTTP: `POST /api/v1/sequences/generate-spintax`
+- operationId: `generate_sequence_spintax_sequences_generate_spintax_post` (also callable as `g8.api.call("generate_sequence_spintax_sequences_generate_spintax_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+
+One-time AI generation: rewrite a manual email into spintax.
+
+Returns the subject + body rewritten with (possibly nested)
+``{{option a|option b}}`` blocks; the sequencer's per-contact resolver
+then sends a different-looking variant to each lead. Content-level and
+sequence-agnostic: paste the result into any sequence or campaign email
+step as a MANUAL_TEMPLATE.
+
+Requires an active subscription and consumes credits (token-metered;
+402 on either failure). Synchronous, up to ~2 minutes; per-worker
+concurrency is capped (429 + Retry-After when saturated). Output is
+validated server-side (balanced braces, ``{{variables}}`` and links
+preserved) - invalid model output surfaces as 422, never as silently
+broken content.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `GenerateSpintaxRequest` | yes | Request body; fields below. |
+
+Body fields (`GenerateSpintaxRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.body` | `string` | yes | Email body to rewrite into spintax min length 1, max length 50000 |
+| `body.subject` | `string` | yes | Email subject to rewrite into spintax min length 1, max length 2000 |
+| `body.email_type` | `"plain" \| "html"` | no | Body format. 'html' preserves every <a href> link and all {{variables}} in the rewrite. default `"plain"` |
+| `body.strength` | `"light" \| "balanced" \| "maximum"` | no | Variation intensity: how heavily to vary the copy and how deeply to nest spintax blocks. Each level carries an ENFORCED ceiling on total distinct renderings (subject x body), applied after generation: 'light' up to 200 (flat blocks only), 'balanced' up to 5,000, 'maximum' up to 100,000. Output over the ceiling is trimmed down, never rejected. default `"balanced"` |
+| `body.tone_instructions` | `string \| null` | no | Optional tone/style guidance applied during the rewrite (e.g. 'casual, no exclamation marks'). max length 2000 |
+
+**Returns** `ApiResponse_GenerateSpintaxResponse_`: the envelope `{ data: GenerateSpintaxResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`GenerateSpintaxResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `string` | yes | Body rewritten with (possibly nested) spintax blocks |
+| `body_combinations` | `integer` | yes | Distinct renderings the body can produce |
+| `subject` | `string` | yes | Subject rewritten with {{option a\|option b}} spintax blocks |
+| `subject_combinations` | `integer` | yes | Distinct renderings the subject can produce |
+| `total_combinations` | `integer` | yes | Distinct full-email renderings (subject x body) |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.generateSequenceSpintax({ body: { body: "example", subject: "Example" } });
+```
+
+---
+
+<a id="op-generatesteptemplates"></a>
+
+### `g8.api.sequences.generateStepTemplates(input)`
+
+**Generate Step Templates**
+
+- HTTP: `POST /api/v1/sequencer/templates/steps/generate`
+- operationId: `generate_step_templates_sequencer_templates_steps_generate_post` (also callable as `g8.api.call("generate_step_templates_sequencer_templates_steps_generate_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Have an agent DRAFT step content. Spends credits on every call.
+
+Nothing is saved - the drafts come back for you to keep with
+`POST /sequencer/templates/steps` or discard. It runs a full model
+generation and can take tens of seconds; a 402 means the organisation is
+out of credits.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `GenerateStepTemplatesRequest` | yes | Request body; fields below. |
+
+Body fields (`GenerateStepTemplatesRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agent_name` | `string` | yes | The agent whose voice and context the drafts use. |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.sequences.generateStepTemplates({ body: { agent_name: "Example" } });
+```
+
+---
+
+<a id="op-getnurture"></a>
+
+### `g8.api.sequences.getNurture(input)`
+
+**Get Nurture**
+
+- HTTP: `GET /api/v1/nurtures/{nurture_id}`
+- operationId: `get_nurture_nurtures__nurture_id__get` (also callable as `g8.api.call("get_nurture_nurtures__nurture_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Read one nurture. 404s if it is not a nurture, or not yours to see.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+
+**Returns** `ApiResponse_NurtureResponse_`: the envelope `{ data: NurtureResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`NurtureResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_shared` | `boolean \| null` | no | True when visible org-wide. |
+| `name` | `string \| null` | no |  |
+| `status` | `string \| null` | no | draft, live, paused, completed, terminated. |
+| `updated_at` | `string (date-time) \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-getprovidersizing"></a>
+
+### `g8.api.sequences.getProviderSizing(input?)`
+
+**Get Provider Sizing**
+
+- HTTP: `GET /api/v1/sequencer/deliverability/provider-sizing`
+- operationId: `get_provider_sizing_sequencer_deliverability_provider_sizing_get` (also callable as `g8.api.call("get_provider_sizing_sequencer_deliverability_provider_sizing_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+How the organisation's whole contact corpus splits across mail providers.
+
+FAIL-OPEN by design: on a backend error it answers all zeros, so all-zero
+means "could not measure", not "no contacts".
+
+**Input**: none.
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getProviderSizing();
+```
+
+---
+
+<a id="op-getschedule"></a>
+
+### `g8.api.sequences.getSchedule(input)`
+
+**Get Schedule**
+
+- HTTP: `GET /api/v1/schedules/{schedule_id}`
+- operationId: `get_schedule_schedules__schedule_id__get` (also callable as `g8.api.call("get_schedule_schedules__schedule_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `campaigns:read`
+
+One sending schedule, with its full per-day `config`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id, from `GET /schedules`. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSchedule({ path: { schedule_id: "id" } });
+```
+
+---
+
+<a id="op-getsequence"></a>
+
+### `g8.api.sequences.getSequence(input)`
+
+**Get Sequence**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}`
+- operationId: `get_sequence_sequences__sequence_id__get` (also callable as `g8.api.call("get_sequence_sequences__sequence_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+- ★ Hand-written: [`g8.sequences.get()`](../sdk-clients.md#g8-sequences-get)
+
+Get detailed information about a sequence.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+
+**Returns** `ApiResponse_SequenceDetailResponse_`: the envelope `{ data: SequenceDetailResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceDetailResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `appointment_id` | `integer \| null` | no |  |
+| `associated_list_id` | `integer \| null` | no |  |
+| `created_at` | `string \| null` | no |  |
+| `description` | `string \| null` | no |  |
+| `finish_on_reply` | `boolean` | no | default `false` |
+| `name` | `string \| null` | no |  |
+| `paused_at` | `string \| null` | no |  |
+| `pinned_mailbox_id` | `integer \| null` | no |  |
+| `resumed_at` | `string \| null` | no |  |
+| `schedule_id` | `string \| null` | no |  |
+| `send_in_same_thread` | `boolean` | no | default `false` |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `textual_agent_name` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+| `user_email` | `string \| null` | no |  |
+| `voice_agent_name` | `string \| null` | no |  |
+| `wait_for_new_contacts` | `boolean` | no | default `false` |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-getsequencejob"></a>
+
+### `g8.api.sequences.getSequenceJob(input)`
+
+**Get Sequence Job**
+
+- HTTP: `GET /api/v1/sequence-jobs/{job_id}`
+- operationId: `get_sequence_job_sequence_jobs__job_id__get` (also callable as `g8.api.call("get_sequence_job_sequence_jobs__job_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The status of a background sequence job the org started.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.job_id` | `string` | yes | Background job id. |
+
+**Returns** `ApiResponse_SequenceOpsPayload_`: the envelope `{ data: SequenceOpsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequenceJob({ path: { job_id: "id" } });
+```
+
+---
+
+<a id="op-getsequencereports"></a>
+
+### `g8.api.sequences.getSequenceReports(input)`
+
+**Get Sequence Reports**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/reports`
+- operationId: `get_sequence_reports_sequences__sequence_id__reports_get` (also callable as `g8.api.call("get_sequence_reports_sequences__sequence_id__reports_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+A sequence's full report: overview, funnel, engagement, 30-day timeline, distribution.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_SequenceOpsPayload_`: the envelope `{ data: SequenceOpsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequenceReports({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-getsequenceroutingsummary"></a>
+
+### `g8.api.sequences.getSequenceRoutingSummary(input)`
+
+**Get Sequence Routing Summary**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/routing-summary`
+- operationId: `get_sequence_routing_summary_sequences__sequence_id__routing_summary_get` (also callable as `g8.api.call("get_sequence_routing_summary_sequences__sequence_id__routing_summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Which providers this sequence's recipients sit behind, and what is suppressed.
+
+Two properties that change how the answer should be read:
+
+  * APPROXIMATE - it scans up to 10,000 recipients, not all of them.
+  * FAIL-OPEN - on any error every count is zero, so an all-zero summary
+    means "could not compute" just as much as "nothing matched". Do not
+    render it as a confident zero.
+
+Each recipient lands in exactly ONE bucket, suppression beating routing
+(bounce > seg > personal), so the buckets partition the scanned set rather
+than overlapping.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_SequenceRoutingSummary_`: the envelope `{ data: SequenceRoutingSummary, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceRoutingSummary` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `bounce_suppressed_count` | `integer` | no | default `0` |
+| `google_count` | `integer` | no | default `0` |
+| `m365_count` | `integer` | no | default `0` |
+| `other_count` | `integer` | no | default `0` |
+| `personal_suppressed_count` | `integer` | no | default `0` |
+| `scanned_count` | `integer \| null` | no | How many recipients were actually scanned (capped at 10,000). |
+| `seg_suppressed_count` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequenceRoutingSummary({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-getsequencestats"></a>
+
+### `g8.api.sequences.getSequenceStats(input)`
+
+**Get Sequence Stats**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/stats`
+- operationId: `get_sequence_stats_sequences__sequence_id__stats_get` (also callable as `g8.api.call("get_sequence_stats_sequences__sequence_id__stats_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Per-step delivery and engagement counts.
+
+`skip_reason_breakdown` is SEQUENCE-level and counted once per contact, so
+its total can be LESS than the per-step `skipped` tiles sum to - the
+durable-LinkedIn-skip cascade writes one receipt per contiguous LinkedIn
+step, and a skip with no recorded reason is omitted. The two are not meant
+to reconcile.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_SequenceStats_`: the envelope `{ data: SequenceStats, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceStats` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `skip_reason_breakdown` | `Record<string, integer>` | no | Distinct terminal-skipped contacts by raw skip-reason token, e.g. `skipped_too_distant`. Sequence-level, counted once per contact. |
+| `step_stats` | `Array<Record<string, unknown>>` | no |  |
+| `total_contacts` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequenceStats({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-getsequencercapacityestimate"></a>
+
+### `g8.api.sequences.getSequencerCapacityEstimate(input)`
+
+**Get Sequencer Capacity Estimate**
+
+- HTTP: `GET /api/v1/sequencer/channels/capacity-estimate`
+- operationId: `get_sequencer_capacity_estimate_sequencer_channels_capacity_estimate_get` (also callable as `g8.api.call("get_sequencer_capacity_estimate_sequencer_channels_capacity_estimate_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+How many mailboxes and domains a target volume needs, and what it costs.
+
+Read-only: it computes an estimate and buys nothing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.contacts_per_month` | `integer` | yes | Target contacts to reach per month. |
+| `query.warmed` | `boolean` | no | False = cold start (25/day); True = warmed (100/day). default `false` |
+| `query.domain_tld` | `string` | no | TLD for the per-domain USD cost estimate. default `".com"` |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequencerCapacityEstimate({ query: { contacts_per_month: 0 } });
+```
+
+---
+
+<a id="op-getsequencesoverview"></a>
+
+### `g8.api.sequences.getSequencesOverview(input?)`
+
+**Get Sequences Overview**
+
+- HTTP: `GET /api/v1/sequencer/stats`
+- operationId: `get_sequences_overview_sequencer_stats_get` (also callable as `g8.api.call("get_sequences_overview_sequencer_stats_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Every sequence with its step and contact counts, plus executed-step totals.
+
+`summary` rolls executed steps up by sequence and step, which is what a
+dashboard across sequences needs - per-sequence detail is
+`GET /sequences/{id}/stats`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.is_personal` | `boolean` | no | True: sequences the key owner created. False: the team's SHARED sequences. An organisation key owns none, so `true` answers empty. default `false` |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.getSequencesOverview();
+```
+
+---
+
+<a id="op-improvestepinstruction"></a>
+
+### `g8.api.sequences.improveStepInstruction(input)`
+
+**Improve Step Instruction**
+
+- HTTP: `POST /api/v1/sequencer/content/instructions/improve`
+- operationId: `improve_step_instruction_sequencer_content_instructions_improve_post` (also callable as `g8.api.call("improve_step_instruction_sequencer_content_instructions_improve_post", input)`)
+- Tier: `billable`: spends credits; the SDK never blindly retries it; confirm cost before bulk use
+- API-key scope: `sequences:run`
+
+Rewrite a step's drafting instruction with a model. RUNS A MODEL per call.
+
+Returns the improved instruction; nothing is saved. Send the current
+instruction as `old_instruction` so the rewrite keeps its intent.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `ImproveInstructionRequest` | yes | Request body; fields below. |
+
+Body fields (`ImproveInstructionRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.user_instruction` | `string` | yes | What the drafting agent should do, in the author's own words. min length 1 |
+| `body.old_instruction` | `string \| null` | no | The instruction being replaced, so the rewrite keeps its intent. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// billable: spends credits; the SDK never blindly retries it; confirm cost before bulk use.
+const result = await g8.api.sequences.improveStepInstruction({ body: { user_instruction: "example" } });
+```
+
+---
+
+<a id="op-launchnurture"></a>
+
+### `g8.api.sequences.launchNurture(input)`
+
+**Launch Nurture**
+
+- HTTP: `POST /api/v1/nurtures/{nurture_id}/launch`
+- operationId: `launch_nurture_nurtures__nurture_id__launch_post` (also callable as `g8.api.call("launch_nurture_nurtures__nurture_id__launch_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+
+Launch a nurture. THIS SENDS REAL MESSAGES TO REAL PEOPLE.
+
+Proxies the same v2 run flow the app's Go-Live button uses, so enrollment,
+schedule and consent checks are identical.
+
+WHY THE PATH IS `/launch` AND NOT THE APP'S `/run/v2`
+-----------------------------------------------------
+Two reasons, and the second is the load-bearing one.
+
+The `v2` suffix is noise: v1 was removed on 2026-04-21, so there is nothing
+left to disambiguate from on a public surface.
+
+`launch` rather than `run` is what gets this operation the right SCOPE.
+`build_scope_policy.EXTERNAL_PATH_MARKERS` contains `/launch`, `/send` and
+`/publish` - the fragments that mean "this reaches the outside world" - and
+an external-tier operation resolves to the `run` ACTION, so the key needs
+an explicit `sequences:run` grant rather than plain `sequences:write`. As
+`/run` this endpoint classified as an ordinary write, one tier below the
+identical `POST /sequences/{id}/run`, which is external. Sending real email
+to real people is the definition of external, and the customer issuing a
+key should be able to grant "edit my nurtures" without granting "start
+sending".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.launchNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-linksequencecampaign"></a>
+
+### `g8.api.sequences.linkSequenceCampaign(input)`
+
+**Link Sequence Campaign**
+
+- HTTP: `PUT /api/v1/sequences/{sequence_id}/campaign`
+- operationId: `link_sequence_campaign_sequences__sequence_id__campaign_put` (also callable as `g8.api.call("link_sequence_campaign_sequences__sequence_id__campaign_put", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Attach this sequence to a Studio campaign.
+
+`campaign_id` is declared REQUIRED here. The app takes a bare `dict` and
+400s on a missing key - a typed model turns that into a 422 with the field
+named, which is what a contract is for.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `body` | `SequenceCampaignLinkRequest` | yes | Request body; fields below. |
+
+Body fields (`SequenceCampaignLinkRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.campaign_id` | `string` | yes | Studio campaign id to link. |
+
+**Returns** `ApiResponse_SequenceRecord_`: the envelope `{ data: SequenceRecord, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceRecord` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `associated_list_id` | `integer \| null` | no |  |
+| `campaign_builder_campaign_id` | `string \| null` | no | Linked Studio campaign, if any. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `is_shared` | `boolean \| null` | no |  |
+| `name` | `string \| null` | no |  |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `user_email` | `string \| null` | no | Owner. |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.linkSequenceCampaign({ path: { sequence_id: "id" }, body: { campaign_id: "id" } });
+```
+
+---
+
+<a id="op-listdialercontacts"></a>
+
+### `g8.api.sequences.listDialerContacts(input)`
+
+**List Dialer Contacts**
+
+- HTTP: `GET /api/v1/sequencer/dialer/sequences/{sequence_id}/contacts`
+- operationId: `list_dialer_contacts_sequencer_dialer_sequences__sequence_id__contacts_get` (also callable as `g8.api.call("list_dialer_contacts_sequencer_dialer_sequences__sequence_id__contacts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The contacts of one dialer sequence with their step progress, paged.
+
+Carries the sequence's `associated_list_id`, so a caller can go from "who
+is due a call" to the list they came from without a second lookup.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `query.limit` | `integer` | no | default `20` |
+| `query.offset` | `integer` | no | default `0` |
+| `query.sort_by` | `"created_at" \| "current_step_order" \| "state" \| "current_step_execution_at"` | no | default `"created_at"` |
+| `query.sort_order` | `"asc" \| "desc"` | no | default `"desc"` |
+| `query.state` | `string \| null` | no | Only contacts in this state. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listDialerContacts({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-listdialersequences"></a>
+
+### `g8.api.sequences.listDialerSequences(input?)`
+
+**List Dialer Sequences**
+
+- HTTP: `GET /api/v1/sequencer/dialer/sequences`
+- operationId: `list_dialer_sequences_sequencer_dialer_sequences_get` (also callable as `g8.api.call("list_dialer_sequences_sequencer_dialer_sequences_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Sequences the dialer can work, each with its steps, paged.
+
+Filtered by the key's sequence scope exactly as the in-app dropdown is, so
+a key limited to its own sequences sees only those.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.limit` | `integer` | no | default `20` |
+| `query.offset` | `integer` | no | default `0` |
+| `query.sort_by` | `"created_at" \| "updated_at" \| "name" \| "status"` | no | default `"created_at"` |
+| `query.sort_order` | `"asc" \| "desc"` | no | default `"desc"` |
+| `query.search` | `string \| null` | no | Sequence name contains. |
+| `query.status` | `string \| null` | no | Only sequences in this status, e.g. `running`. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listDialerSequences();
+```
+
+---
+
+<a id="op-listemaildraftmodels"></a>
+
+### `g8.api.sequences.listEmailDraftModels(input?)`
+
+**List Email Draft Models**
+
+- HTTP: `GET /api/v1/sequencer/content/email/models`
+- operationId: `list_email_draft_models_sequencer_content_email_models_get` (also callable as `g8.api.call("list_email_draft_models_sequencer_content_email_models_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The models an email draft can use, and which one is the default.
+
+Pass a row's `provider` and `model` to the draft and estimate routes. Never
+fails: if the catalog cannot be fetched the built-in default list is
+returned.
+
+**Input**: none.
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listEmailDraftModels();
+```
+
+---
+
+<a id="op-listlinkedinaccounts"></a>
+
+### `g8.api.sequences.listLinkedinAccounts(input?)`
+
+**List Linkedin Accounts**
+
+- HTTP: `GET /api/v1/sequencer/channels/linkedin_accounts`
+- operationId: `list_linkedin_accounts_sequencer_channels_linkedin_accounts_get` (also callable as `g8.api.call("list_linkedin_accounts_sequencer_channels_linkedin_accounts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+LinkedIn accounts a sequence can send from, bucketed by allocation status.
+
+The last missing member of the published picker family. The path keeps
+the family's underscore spelling (`/sequencer/channels/phone_numbers` and
+its siblings already ship).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.exclude_sequence_id` | `string \| null` | no | Treat accounts already allocated to THIS sequence as available. Pass the sequence being edited, or every account it already uses looks taken. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listLinkedinAccounts();
+```
+
+---
+
+<a id="op-listnurtures"></a>
+
+### `g8.api.sequences.listNurtures(input?)`
+
+**List Nurtures**
+
+- HTTP: `GET /api/v1/nurtures`
+- operationId: `list_nurtures_nurtures_get` (also callable as `g8.api.call("list_nurtures_nurtures_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Nurtures visible to this key - its own plus org-shared.
+
+No per-record gate here: a LIST is filtered by `sequence_scope` rather than
+checked row by row, which is the same shape the app uses.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.page` | `integer` | no | Page number (1-indexed). default `1` |
+| `query.limit` | `integer` | no | Items per page (max 200). default `50` |
+
+**Returns** `ApiResponse_NurtureListResponse_`: the envelope `{ data: NurtureListResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`NurtureListResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `nurtures` | `Array<NurtureResponse>` | no |  |
+| `total` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listNurtures();
+```
+
+---
+
+<a id="op-listsegvendors"></a>
+
+### `g8.api.sequences.listSegVendors(input?)`
+
+**List Seg Vendors**
+
+- HTTP: `GET /api/v1/sequencer/deliverability/seg-vendors`
+- operationId: `list_seg_vendors_sequencer_deliverability_seg_vendors_get` (also callable as `g8.api.call("list_seg_vendors_sequencer_deliverability_seg_vendors_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The secure-email-gateway vendors a vendor-scoped suppression can name.
+
+Derived from the classifier's own rule table, so every slug listed is one
+the suppression gate matches. A slug not listed here suppresses nothing.
+
+**Input**: none.
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSegVendors();
+```
+
+---
+
+<a id="op-listsequencechannels"></a>
+
+### `g8.api.sequences.listSequenceChannels(input)`
+
+**List Sequence Channels**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/channels`
+- operationId: `list_sequence_channels_sequences__sequence_id__channels_get` (also callable as `g8.api.call("list_sequence_channels_sequences__sequence_id__channels_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The mailboxes, numbers and accounts this sequence sends from.
+
+Each row's `id` is the SEQUENCE-CHANNEL id - what the detach routes take -
+not the mailbox or number id itself (that is `channel_id`).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequenceChannels({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-listsequencecontactids"></a>
+
+### `g8.api.sequences.listSequenceContactIds(input)`
+
+**List Sequence Contact Ids**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/contact-ids`
+- operationId: `list_sequence_contact_ids_sequences__sequence_id__contact_ids_get` (also callable as `g8.api.call("list_sequence_contact_ids_sequences__sequence_id__contact_ids_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+EVERY contact id in a sequence matching the filters, unpaginated.
+
+The companion to the paged `GET /sequences/{id}/contacts`, for "act on all
+of them" without walking pages. The app's AG Grid `filterModel` string is a
+UI grid's internal format and is not offered; every app parameter not
+offered here has a default (pinned by a test).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `query.search` | `string \| null` | no | Free text over name, email and phone. |
+| `query.state_filter` | `string \| null` | no | Comma-separated states to INCLUDE. |
+| `query.exclude_states` | `string \| null` | no | Comma-separated states to EXCLUDE; composes with `state_filter`. |
+| `query.mailbox_filter` | `string \| null` | no | Allocated mailbox contains. |
+| `query.phone_allocated_filter` | `string \| null` | no | Allocated phone number contains. |
+| `query.company_filter` | `string \| null` | no | Company name contains. |
+| `query.step_order_filter` | `integer \| null` | no | Currently at this step order. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequenceContactIds({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-listsequencecontacts"></a>
+
+### `g8.api.sequences.listSequenceContacts(input)`
+
+**List Sequence Contacts**
+
+- HTTP: `GET /api/v1/sequences/{sequence_id}/contacts`
+- operationId: `list_sequence_contacts_sequences__sequence_id__contacts_get` (also callable as `g8.api.call("list_sequence_contacts_sequences__sequence_id__contacts_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+- ★ Hand-written: [`g8.sequences.contacts()`](../sdk-clients.md#g8-sequences-contacts)
+
+List contacts in a sequence with pagination.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+| `query.page` | `integer` | no | Page number default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+| `query.state` | `string \| null` | no | Filter by contact state |
+
+**Returns** `ApiResponse_list_SequenceContactItem__`: the envelope `{ data: Array<SequenceContactItem>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceContactItem` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `contact_id` | `integer \| null` | no |  |
+| `created_at` | `string \| null` | no |  |
+| `current_step_order` | `integer \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `state` | `string \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequenceContacts({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-listsequencetemplates"></a>
+
+### `g8.api.sequences.listSequenceTemplates(input?)`
+
+**List Sequence Templates**
+
+- HTTP: `GET /api/v1/sequencer/templates/sequences`
+- operationId: `list_sequence_templates_sequencer_templates_sequences_get` (also callable as `g8.api.call("list_sequence_templates_sequencer_templates_sequences_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The organisation's sequence templates, INCLUDING archived ones.
+
+Each row carries `is_archived`; filter on it client-side. Org-SHARED:
+every key in the organisation sees the same list.
+
+**Input**: none.
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequenceTemplates();
+```
+
+---
+
+<a id="op-listsequencermailboxes"></a>
+
+### `g8.api.sequences.listSequencerMailboxes(input)`
+
+**List Sequencer Mailboxes**
+
+- HTTP: `GET /api/v1/sequencer/channels/mailboxes`
+- operationId: `list_sequencer_mailboxes_sequencer_channels_mailboxes_get` (also callable as `g8.api.call("list_sequencer_mailboxes_sequencer_channels_mailboxes_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Mailboxes available to send from, annotated as the app annotates them.
+
+Carries the same warming, daily-capacity, warmup-ready and SURBL-listed
+annotations the in-app picker shows, so a rebuilt builder can surface the
+same warnings rather than silently offering a mailbox that cannot send.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.email` | `string` | yes | Mailbox email to scope the picker to. |
+| `query.exclude_sequence_id` | `string \| null` | no | Hide mailboxes already attached to this sequence. |
+| `query.include_nurture` | `boolean` | no | Include nurture-only mailboxes. default `false` |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerMailboxes({ query: { email: "jane@acme.com" } });
+```
+
+---
+
+<a id="op-listsequencerphonenumbers"></a>
+
+### `g8.api.sequences.listSequencerPhoneNumbers(input?)`
+
+**List Sequencer Phone Numbers**
+
+- HTTP: `GET /api/v1/sequencer/channels/phone_numbers`
+- operationId: `list_sequencer_phone_numbers_sequencer_channels_phone_numbers_get` (also callable as `g8.api.call("list_sequencer_phone_numbers_sequencer_channels_phone_numbers_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Voice-capable numbers available to a sequence.
+
+NOTE these are the VOICE service's numbers, not the CDP `phone_numbers`
+table behind Settings -> Phone Numbers. Different tables, same word.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.exclude_sequence_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerPhoneNumbers();
+```
+
+---
+
+<a id="op-listsequencersmsnumbers"></a>
+
+### `g8.api.sequences.listSequencerSmsNumbers(input?)`
+
+**List Sequencer Sms Numbers**
+
+- HTTP: `GET /api/v1/sequencer/channels/sms_numbers`
+- operationId: `list_sequencer_sms_numbers_sequencer_channels_sms_numbers_get` (also callable as `g8.api.call("list_sequencer_sms_numbers_sequencer_channels_sms_numbers_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+SMS-capable numbers, annotated with SMS readiness.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.exclude_sequence_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerSmsNumbers();
+```
+
+---
+
+<a id="op-listsequencertextualagents"></a>
+
+### `g8.api.sequences.listSequencerTextualAgents(input?)`
+
+**List Sequencer Textual Agents**
+
+- HTTP: `GET /api/v1/sequencer/agents/textual`
+- operationId: `list_sequencer_textual_agents_sequencer_agents_textual_get` (also callable as `g8.api.call("list_sequencer_textual_agents_sequencer_agents_textual_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Textual agents that can run an email or LinkedIn step.
+
+**Input**: none.
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerTextualAgents();
+```
+
+---
+
+<a id="op-listsequencervoiceagents"></a>
+
+### `g8.api.sequences.listSequencerVoiceAgents(input?)`
+
+**List Sequencer Voice Agents**
+
+- HTTP: `GET /api/v1/sequencer/agents/voice`
+- operationId: `list_sequencer_voice_agents_sequencer_agents_voice_get` (also callable as `g8.api.call("list_sequencer_voice_agents_sequencer_agents_voice_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Voice agents that can run a call step.
+
+Raises the app's own error when the org has no voice subscription, rather
+than returning an empty list that would read as "no agents configured".
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.agent_name` | `string \| null` | no | Filter by agent name. |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerVoiceAgents();
+```
+
+---
+
+<a id="op-listsequencerwhatsappnumbers"></a>
+
+### `g8.api.sequences.listSequencerWhatsappNumbers(input?)`
+
+**List Sequencer Whatsapp Numbers**
+
+- HTTP: `GET /api/v1/sequencer/channels/whatsapp_numbers`
+- operationId: `list_sequencer_whatsapp_numbers_sequencer_channels_whatsapp_numbers_get` (also callable as `g8.api.call("list_sequencer_whatsapp_numbers_sequencer_channels_whatsapp_numbers_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+WhatsApp-enabled numbers.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.exclude_sequence_id` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerWhatsappNumbers();
+```
+
+---
+
+<a id="op-listsequencerwhatsapptemplates"></a>
+
+### `g8.api.sequences.listSequencerWhatsappTemplates(input?)`
+
+**List Sequencer Whatsapp Templates**
+
+- HTTP: `GET /api/v1/sequencer/channels/whatsapp_templates`
+- operationId: `list_sequencer_whatsapp_templates_sequencer_channels_whatsapp_templates_get` (also callable as `g8.api.call("list_sequencer_whatsapp_templates_sequencer_channels_whatsapp_templates_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+Approved WhatsApp message templates.
+
+A WhatsApp step cannot be composed freely - it must reference an approved
+template, so this is required, not decorative.
+
+**Input**: none.
+
+**Returns** `ApiResponse_Any_`: the envelope `{ data: unknown, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequencerWhatsappTemplates();
+```
+
+---
+
+<a id="op-listsequences"></a>
+
+### `g8.api.sequences.listSequences(input?)`
+
+**List Sequences**
+
+- HTTP: `GET /api/v1/sequences`
+- operationId: `list_sequences_sequences_get` (also callable as `g8.api.call("list_sequences_sequences_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+List all sequences with optional status / sequence_kind filters.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.page` | `integer` | no | Page number default `1` |
+| `query.limit` | `integer` | no | Items per page default `50` |
+| `query.status` | `string \| null` | no | Filter by status |
+| `query.sequence_kind` | `string \| null` | no | Filter by sequence kind ('cold_outbound' or 'nurture'). Omit to list all kinds. |
+
+**Returns** `ApiResponse_list_SequenceListItem__`: the envelope `{ data: Array<SequenceListItem>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceListItem` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `associated_list_id` | `integer \| null` | no |  |
+| `contact_count` | `integer \| null` | no |  |
+| `created_at` | `string \| null` | no |  |
+| `name` | `string \| null` | no |  |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `step_count` | `integer \| null` | no |  |
+| `updated_at` | `string \| null` | no |  |
+| `user_email` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listSequences();
+```
+
+---
+
+<a id="op-liststeptemplates"></a>
+
+### `g8.api.sequences.listStepTemplates(input?)`
+
+**List Step Templates**
+
+- HTTP: `GET /api/v1/sequencer/templates/steps`
+- operationId: `list_step_templates_sequencer_templates_steps_get` (also callable as `g8.api.call("list_step_templates_sequencer_templates_steps_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `sequences:read`
+
+The organisation's reusable step content, archived rows included. Org-SHARED.
+
+**Input**: none.
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.listStepTemplates();
+```
+
+---
+
+<a id="op-pausenurture"></a>
+
+### `g8.api.sequences.pauseNurture(input)`
+
+**Pause Nurture**
+
+- HTTP: `POST /api/v1/nurtures/{nurture_id}/pause`
+- operationId: `pause_nurture_nurtures__nurture_id__pause_post` (also callable as `g8.api.call("pause_nurture_nurtures__nurture_id__pause_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Pause a running nurture. Stops further sends; does not terminate it.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.pauseNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-pausesequence"></a>
+
+### `g8.api.sequences.pauseSequence(input)`
+
+**Pause Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/pause`
+- operationId: `pause_sequence_sequences__sequence_id__pause_post` (also callable as `g8.api.call("pause_sequence_sequences__sequence_id__pause_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+- ★ Hand-written: [`g8.sequences.pause()`](../sdk-clients.md#g8-sequences-pause)
+
+Pause a live sequence.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+
+**Returns** `ApiResponse_SequenceActionResponse_`: the envelope `{ data: SequenceActionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceActionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `sequence_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `contacts_affected` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.pauseSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-pausesequencecontact"></a>
+
+### `g8.api.sequences.pauseSequenceContact(input)`
+
+**Pause Sequence Contact**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/contacts/{contact_id}/pause`
+- operationId: `pause_sequence_contact_sequences__sequence_id__contacts__contact_id__pause_post` (also callable as `g8.api.call("pause_sequence_contact_sequences__sequence_id__contacts__contact_id__pause_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Pause one contact in a sequence. Everyone else keeps going.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `path.contact_id` | `integer` | yes | Contact id. |
+
+**Returns** `ApiResponse_SequenceOpsPayload_`: the envelope `{ data: SequenceOpsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.pauseSequenceContact({ path: { sequence_id: "id", contact_id: 123 } });
+```
+
+---
+
+<a id="op-placevoicetestcall"></a>
+
+### `g8.api.sequences.placeVoiceTestCall(input)`
+
+**Place Voice Test Call**
+
+- HTTP: `POST /api/v1/sequencer/content/voice/test-call`
+- operationId: `place_voice_test_call_sequencer_content_voice_test_call_post` (also callable as `g8.api.call("place_voice_test_call_sequencer_content_voice_test_call_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+
+Place ONE real test call from a voice step. A REAL PHONE RINGS.
+
+The call runs on the organisation's voice plan and is logged as a dry run,
+not against any contact or sequence enrolment. Returns the call's
+`room_name`; the outcome arrives through the call logs, not this response.
+Send an `Idempotency-Key` header so a retried request cannot ring twice.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `VoiceTestCallRequest` | yes | Request body; fields below. |
+
+Body fields (`VoiceTestCallRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.agent_id` | `string` | yes | The voice agent that runs the call. min length 1 |
+| `body.email` | `string` | yes | The test contact's email, as the agent would see it. |
+| `body.first_name` | `string` | yes | How the agent addresses the person it rings. |
+| `body.from_phone` | `string` | yes | One of the organisation's numbers to call from. min length 1 |
+| `body.last_name` | `string` | yes |  |
+| `body.to_phone` | `string` | yes | The number to ring. A REAL phone rings. min length 1 |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.placeVoiceTestCall({
+  body: {
+    agent_id: "id",
+    email: "jane@acme.com",
+    first_name: "Example",
+    from_phone: "+15555550100",
+    last_name: "Example",
+    to_phone: "+15555550100",
+  },
+});
+```
+
+---
+
+<a id="op-recorddialeroutcome"></a>
+
+### `g8.api.sequences.recordDialerOutcome(input)`
+
+**Record Dialer Outcome**
+
+- HTTP: `POST /api/v1/sequencer/dialer/sequences/{sequence_id}/contacts/{contact_id}/callback`
+- operationId: `record_dialer_outcome_sequencer_dialer_sequences__sequence_id__contacts__contact_id__callback_post` (also callable as `g8.api.call("record_dialer_outcome_sequencer_dialer_sequences__sequence_id__contacts__contact_id__callback_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Record that an SDR finished a dialer call, advancing the contact.
+
+A 400 means the contact is not in this sequence or is not waiting on a
+dialer step; the message says which.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `path.contact_id` | `integer` | yes | The contact's integer id in this sequence. |
+| `body` | `DialerCallbackRequest` | yes | Request body; fields below. |
+
+Body fields (`DialerCallbackRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.success` | `boolean` | yes | True if the call connected and the contact should advance to the next step; false records an unsuccessful attempt. |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.recordDialerOutcome({
+  path: { sequence_id: "id", contact_id: 123 },
+  body: { success: true },
+});
+```
+
+---
+
+<a id="op-removesequencechannel"></a>
+
+### `g8.api.sequences.removeSequenceChannel(input)`
+
+**Remove Sequence Channel**
+
+- HTTP: `DELETE /api/v1/sequences/{sequence_id}/channels/{sequence_channel_id}`
+- operationId: `remove_sequence_channel_sequences__sequence_id__channels__sequence_channel_id__delete` (also callable as `g8.api.call("remove_sequence_channel_sequences__sequence_id__channels__sequence_channel_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Detach one sender. Answers with the channels that remain.
+
+Scoped to THIS sequence: a channel id belonging to another sequence
+detaches nothing. Same 409 as the bulk form.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `path.sequence_channel_id` | `string` | yes | Sequence-channel id, from `GET .../channels`. |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.removeSequenceChannel({ path: { sequence_id: "id", sequence_channel_id: "id" } });
+```
+
+---
+
+<a id="op-removesequencechannels"></a>
+
+### `g8.api.sequences.removeSequenceChannels(input)`
+
+**Remove Sequence Channels**
+
+- HTTP: `DELETE /api/v1/sequences/{sequence_id}/channels`
+- operationId: `remove_sequence_channels_sequences__sequence_id__channels_delete` (also callable as `g8.api.call("remove_sequence_channels_sequences__sequence_id__channels_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Detach several senders at once. Answers with the channels that remain.
+
+A 409 means the detach would leave LinkedIn steps with no LinkedIn sender,
+which would stop the sequence on its next run - detach the steps first.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `body` | `RemoveChannelsRequest` | yes | Request body; fields below. |
+
+Body fields (`RemoveChannelsRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.channel_ids` | `Array<string>` | yes | Sequence-channel ids, from `GET .../channels`. min items 1 |
+
+**Returns** `ApiResponse_SequencerListPayload_`: the envelope `{ data: SequencerListPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequencerListPayload` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `items` | `Array<unknown>` | no |  |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.removeSequenceChannels({ path: { sequence_id: "id" }, body: { channel_ids: ["id"] } });
+```
+
+---
+
+<a id="op-resumenurture"></a>
+
+### `g8.api.sequences.resumeNurture(input)`
+
+**Resume Nurture**
+
+- HTTP: `POST /api/v1/nurtures/{nurture_id}/resume`
+- operationId: `resume_nurture_nurtures__nurture_id__resume_post` (also callable as `g8.api.call("resume_nurture_nurtures__nurture_id__resume_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Resume a paused nurture.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.resumeNurture({ path: { nurture_id: "id" } });
+```
+
+---
+
+<a id="op-resumesequence"></a>
+
+### `g8.api.sequences.resumeSequence(input)`
+
+**Resume Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/resume`
+- operationId: `resume_sequence_sequences__sequence_id__resume_post` (also callable as `g8.api.call("resume_sequence_sequences__sequence_id__resume_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+- ★ Hand-written: [`g8.sequences.resume()`](../sdk-clients.md#g8-sequences-resume)
+
+Resume a paused sequence.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+
+**Returns** `ApiResponse_SequenceActionResponse_`: the envelope `{ data: SequenceActionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceActionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `sequence_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `contacts_affected` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.resumeSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-resumesequencecontact"></a>
+
+### `g8.api.sequences.resumeSequenceContact(input)`
+
+**Resume Sequence Contact**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/contacts/{contact_id}/resume`
+- operationId: `resume_sequence_contact_sequences__sequence_id__contacts__contact_id__resume_post` (also callable as `g8.api.call("resume_sequence_contact_sequences__sequence_id__contacts__contact_id__resume_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+
+Resume a paused contact. Its next step can send.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `path.contact_id` | `integer` | yes | Contact id. |
+
+**Returns** `ApiResponse_SequenceOpsPayload_`: the envelope `{ data: SequenceOpsPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.resumeSequenceContact({ path: { sequence_id: "id", contact_id: 123 } });
+```
+
+---
+
+<a id="op-runsequence"></a>
+
+### `g8.api.sequences.runSequence(input)`
+
+**Run Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/run`
+- operationId: `run_sequence_sequences__sequence_id__run_post` (also callable as `g8.api.call("run_sequence_sequences__sequence_id__run_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+- ★ Hand-written: [`g8.sequences.run()`](../sdk-clients.md#g8-sequences-run)
+
+Run/start a drafted sequence using V2 orchestration.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence ID |
+
+**Returns** `ApiResponse_SequenceActionResponse_`: the envelope `{ data: SequenceActionResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceActionResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `sequence_id` | `string` | yes |  |
+| `status` | `string` | yes |  |
+| `contacts_affected` | `integer` | no | default `0` |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.runSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-setsequencestatus"></a>
+
+### `g8.api.sequences.setSequenceStatus(input)`
+
+**Set Sequence Status**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/status`
+- operationId: `set_sequence_status_sequences__sequence_id__status_post` (also callable as `g8.api.call("set_sequence_status_sequences__sequence_id__status_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Drive the status machine directly. PREFER THE NAMED TRANSITIONS.
+
+`/launch`, `/pause`, `/resume`, `/terminate` and `/archive` each run the
+wind-down, scheduling and event work that belongs to them. This endpoint
+only SETS THE STATUS, so a sequence moved to `terminated` this way never
+emits its termination event and its workers are never wound down. It is
+exposed because the app exposes it and a rebuilt settings panel uses it -
+not because it is the way to stop a sequence.
+
+The app's state machine rejects an illegal transition.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+| `body` | `SequenceStatusRequest` | yes | Request body; fields below. |
+
+Body fields (`SequenceStatusRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.status` | `string` | yes | Target status: drafted, scheduling, live, pausing, paused, resuming, terminating, terminated, completed or waiting. Declared as an open string rather than an enum so a status the sequencer adds is not rejected by a stale copy here - the app's own `SequenceStatus` enum is the source of truth and an unknown value comes back as a 422 that LISTS the valid set. |
+
+**Returns** `ApiResponse_SequenceRecord_`: the envelope `{ data: SequenceRecord, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceRecord` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `associated_list_id` | `integer \| null` | no |  |
+| `campaign_builder_campaign_id` | `string \| null` | no | Linked Studio campaign, if any. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `is_shared` | `boolean \| null` | no |  |
+| `name` | `string \| null` | no |  |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `user_email` | `string \| null` | no | Owner. |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.setSequenceStatus({ path: { sequence_id: "id" }, body: { status: "example" } });
+```
+
+---
+
+<a id="op-syncsequence"></a>
+
+### `g8.api.sequences.syncSequence(input)`
+
+**Sync Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/sync`
+- operationId: `sync_sequence_sequences__sequence_id__sync_post` (also callable as `g8.api.call("sync_sequence_sequences__sequence_id__sync_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `sequences:run`
+
+Re-pull the associated list so newly-matching contacts enrol.
+
+This is how a live sequence picks up people added to its list after it
+started. It enrols real recipients, so it is a write, not a refresh.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.sequences.syncSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-terminatesequence"></a>
+
+### `g8.api.sequences.terminateSequence(input)`
+
+**Terminate Sequence**
+
+- HTTP: `POST /api/v1/sequences/{sequence_id}/terminate`
+- operationId: `terminate_sequence_sequences__sequence_id__terminate_post` (also callable as `g8.api.call("terminate_sequence_sequences__sequence_id__terminate_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+End a sequence for good. Enrolled contacts stop; this is not a pause.
+
+The path drops the app's `-v2` suffix: v1 is gone, so there is nothing
+left to disambiguate from on a public surface.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_dict_`: the envelope `{ data: Record<string, unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.terminateSequence({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-unlinksequencecampaign"></a>
+
+### `g8.api.sequences.unlinkSequenceCampaign(input)`
+
+**Unlink Sequence Campaign**
+
+- HTTP: `DELETE /api/v1/sequences/{sequence_id}/campaign`
+- operationId: `unlink_sequence_campaign_sequences__sequence_id__campaign_delete` (also callable as `g8.api.call("unlink_sequence_campaign_sequences__sequence_id__campaign_delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `sequences:delete`
+
+Detach the Studio campaign. The sequence and the campaign both survive.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_id` | `string` | yes | Sequence id. |
+
+**Returns** `ApiResponse_SequenceRecord_`: the envelope `{ data: SequenceRecord, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SequenceRecord` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `associated_list_id` | `integer \| null` | no |  |
+| `campaign_builder_campaign_id` | `string \| null` | no | Linked Studio campaign, if any. |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_archived` | `boolean \| null` | no |  |
+| `is_shared` | `boolean \| null` | no |  |
+| `name` | `string \| null` | no |  |
+| `sequence_kind` | `string \| null` | no |  |
+| `status` | `string \| null` | no |  |
+| `updated_at` | `string (date-time) \| null` | no |  |
+| `user_email` | `string \| null` | no | Owner. |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.sequences.unlinkSequenceCampaign({ path: { sequence_id: "id" } });
+```
+
+---
+
+<a id="op-updatenurture"></a>
+
+### `g8.api.sequences.updateNurture(input)`
+
+**Update Nurture**
+
+- HTTP: `PATCH /api/v1/nurtures/{nurture_id}`
+- operationId: `update_nurture_nurtures__nurture_id__patch` (also callable as `g8.api.call("update_nurture_nurtures__nurture_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Patch a nurture. Omitted fields are left alone.
+
+`exclude_unset` rather than `exclude_none`: the app distinguishes "field
+absent" from "field explicitly set to null", and collapsing the two would
+make it impossible to clear an optional field such as `schedule_id`.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.nurture_id` | `string` | yes | Nurture id. |
+| `body` | `NurtureUpdateRequest` | yes | Request body; fields below. |
+
+Body fields (`NurtureUpdateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.appointment_id` | `integer \| null` | no |  |
+| `body.associated_list_id` | `integer \| null` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.finish_on_reply` | `boolean \| null` | no |  |
+| `body.include_unsubscribe_cta` | `boolean \| null` | no |  |
+| `body.is_shared` | `boolean \| null` | no | Set true to promote the nurture to org scope. Admin/Owner only - this is the one field on this model that is permission-gated. |
+| `body.name` | `string \| null` | no |  |
+| `body.schedule_id` | `string \| null` | no |  |
+| `body.send_in_same_thread` | `boolean \| null` | no |  |
+| `body.textual_agent_name` | `string \| null` | no |  |
+| `body.voice_agent_name` | `string \| null` | no |  |
+| `body.wait_for_new_contacts` | `boolean \| null` | no |  |
+
+**Returns** `ApiResponse_NurtureResponse_`: the envelope `{ data: NurtureResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`NurtureResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `created_at` | `string (date-time) \| null` | no |  |
+| `id` | `string \| null` | no |  |
+| `is_shared` | `boolean \| null` | no | True when visible org-wide. |
+| `name` | `string \| null` | no |  |
+| `status` | `string \| null` | no | draft, live, paused, completed, terminated. |
+| `updated_at` | `string (date-time) \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.updateNurture({ path: { nurture_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updateschedule"></a>
+
+### `g8.api.sequences.updateSchedule(input)`
+
+**Update Schedule**
+
+- HTTP: `PATCH /api/v1/schedules/{schedule_id}`
+- operationId: `update_schedule_schedules__schedule_id__patch` (also callable as `g8.api.call("update_schedule_schedules__schedule_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `campaigns:write`
+
+Change a schedule's name, timezone or windows. Only what you send is written.
+
+SHARED: this retimes EVERY sequence using the schedule, not one. `config`,
+when sent, replaces the whole week - a day omitted from it stops sending.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.schedule_id` | `string` | yes | Schedule id, from `GET /schedules`. |
+| `body` | `UpdateSendingScheduleRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateSendingScheduleRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.config` | `SendingWeek \| null` | no |  |
+| `body.description` | `string \| null` | no | max length 1024 |
+| `body.name` | `string \| null` | no | max length 255 |
+| `body.timezone` | `string \| null` | no | max length 128 |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.updateSchedule({ path: { schedule_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatesequencetemplate"></a>
+
+### `g8.api.sequences.updateSequenceTemplate(input)`
+
+**Update Sequence Template**
+
+- HTTP: `PATCH /api/v1/sequencer/templates/sequences/{sequence_template_id}`
+- operationId: `update_sequence_template_sequencer_templates_sequences__sequence_template_id__patch` (also callable as `g8.api.call("update_sequence_template_sequencer_templates_sequences__sequence_template_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Change a sequence template. Only what you send is written; an unknown id is a 404.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sequence_template_id` | `string` | yes | Sequence template id. |
+| `body` | `UpdateSequenceTemplateRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateSequenceTemplateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.appointment_id` | `integer \| null` | no |  |
+| `body.description` | `string \| null` | no |  |
+| `body.name` | `string \| null` | no |  |
+| `body.schedule_id` | `string \| null` | no |  |
+| `body.steps` | `Array<SequenceTemplateStep> \| null` | no |  |
+| `body.textual_agent_name` | `string \| null` | no |  |
+| `body.voice_agent_name` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.updateSequenceTemplate({ path: { sequence_template_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-updatesteptemplate"></a>
+
+### `g8.api.sequences.updateStepTemplate(input)`
+
+**Update Step Template**
+
+- HTTP: `PATCH /api/v1/sequencer/templates/steps/{step_template_id}`
+- operationId: `update_step_template_sequencer_templates_steps__step_template_id__patch` (also callable as `g8.api.call("update_step_template_sequencer_templates_steps__step_template_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `sequences:write`
+
+Change a step template. An unknown id is a 404.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.step_template_id` | `string` | yes | Step template id. |
+| `body` | `UpdateStepTemplateRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateStepTemplateRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string \| null` | no |  |
+| `body.step_data` | `Record<string, unknown> \| null` | no |  |
+| `body.step_type` | `"PHONE" \| "EMAIL" \| "MANUAL_DIALER" \| "HEYREACH" \| "NETRION" \| "SMS" \| "WHATSAPP" \| null` | no |  |
+
+**Returns** `ApiResponse_SequencerPayload_`: the envelope `{ data: SequencerPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.sequences.updateStepTemplate({ path: { step_template_id: "id" }, body: {} });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-addchannelitem"></a>
+
+### `AddChannelItem`
+
+One sender to attach. Mirrors `AddChannelPayload` minus the client `id`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel_id` | `integer` | yes | The sender's INTEGER id - a mailbox, number or account. |
+| `channel_type` | `"SMTP" \| "GMAIL" \| "INBOXKIT" \| "PHONE" \| "LINKEDIN" \| "LINKEDIN_NETRION" \| "SMS" \| "WHATSAPP"` | yes |  |
+| `channel_value` | `string` | yes | Its address: the email, phone number or profile. |
+| `channel_data` | `Record<string, unknown> \| null` | no |  |
+
+<a id="type-addstepitem"></a>
+
+### `AddStepItem`
+
+One step to add. Mirrors `CreateStepPayload` minus the client `id`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `input_type` | `"ON_DEMAND" \| "AI_GENERATED_TEMPLATE" \| "MANUAL_TEMPLATE"` | yes |  |
+| `step_data` | `Record<string, unknown>` | yes | The step's content, the same shape as `step_data` on `GET /sequences/{sequence_id}/steps`: `subject` / `body` for email, `message_body` for SMS and WhatsApp, the `linkedin_*` fields for LinkedIn, `instructions` for AI generation. |
+| `step_order` | `integer` | yes | Position in the sequence, 1-based. |
+| `step_type` | `"PHONE" \| "EMAIL" \| "MANUAL_DIALER" \| "HEYREACH" \| "NETRION" \| "SMS" \| "WHATSAPP"` | yes |  |
+| `time_interval` | `integer \| null` | no | Seconds after the previous step. |
+
+<a id="type-sendingweek"></a>
+
+### `SendingWeek`
+
+The weekly window. A day left out is a day nothing is sent.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `friday` | `SendingWindow \| null` | no |  |
+| `monday` | `SendingWindow \| null` | no |  |
+| `saturday` | `SendingWindow \| null` | no |  |
+| `sunday` | `SendingWindow \| null` | no |  |
+| `thursday` | `SendingWindow \| null` | no |  |
+| `tuesday` | `SendingWindow \| null` | no |  |
+| `wednesday` | `SendingWindow \| null` | no |  |
+
+<a id="type-sequencetemplatestep"></a>
+
+### `SequenceTemplateStep`
+
+One step of a sequence template. Mirrors `SequenceTemplateStep`.
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `input_type` | `"ON_DEMAND" \| "AI_GENERATED_TEMPLATE" \| "MANUAL_TEMPLATE"` | yes |  |
+| `name` | `string` | yes |  |
+| `step_data` | `Record<string, unknown>` | yes | The step's content: `subject` / `body` for email, `message_body` for SMS and WhatsApp, the `linkedin_*` fields for LinkedIn, `instructions` for AI generation. The same shape as `step_data` on `GET /sequences/{sequence_id}/steps`. |
+| `step_order` | `integer` | yes |  |
+| `step_type` | `"PHONE" \| "EMAIL" \| "MANUAL_DIALER" \| "HEYREACH" \| "NETRION" \| "SMS" \| "WHATSAPP"` | yes |  |
+| `time_interval` | `integer \| null` | no | Seconds after the previous step. |