@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/sequences.d.ts

@@ -0,0 +1,1936 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.sequences` (Sequences): 71 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"add_contacts_to_sequence_sequences__sequence_id__contacts_post">;
+ *
+ * Reference with examples: sequences.md
+ */
+/* eslint-disable */
+
+/** `g8.api.sequences.<member>` -> the operationId it calls. */
+export interface SequencesMembers {
+  addContactsToSequence: "add_contacts_to_sequence_sequences__sequence_id__contacts_post";
+  addSequenceChannels: "add_sequence_channels_sequences__sequence_id__channels_post";
+  addSequenceSteps: "add_sequence_steps_sequences__sequence_id__steps_post";
+  archiveSchedule: "archive_schedule_schedules__schedule_id__archive_patch";
+  archiveSequence: "archive_sequence_sequences__sequence_id__archive_post";
+  archiveSequenceTemplate: "archive_sequence_template_sequencer_templates_sequences__sequence_template_id__archive_patch";
+  archiveStepTemplate: "archive_step_template_sequencer_templates_steps__step_template_id__archive_patch";
+  createNurture: "create_nurture_nurtures_post";
+  createSchedule: "create_schedule_schedules_post";
+  createSequenceTemplate: "create_sequence_template_sequencer_templates_sequences_post";
+  createStepTemplate: "create_step_template_sequencer_templates_steps_post";
+  deleteNurture: "delete_nurture_nurtures__nurture_id__delete";
+  deleteSequenceStep: "delete_sequence_step_sequences__sequence_id__steps__step_id__delete";
+  draftEmail: "draft_email_sequencer_content_email_generate_post";
+  draftLinkedinMessage: "draft_linkedin_message_sequencer_content_linkedin_generate_post";
+  duplicateNurture: "duplicate_nurture_nurtures__nurture_id__duplicate_post";
+  duplicateSequence: "duplicate_sequence_sequences__sequence_id__duplicate_post";
+  estimateEmailDraft: "estimate_email_draft_sequencer_content_email_estimate_post";
+  generateSequenceSpintax: "generate_sequence_spintax_sequences_generate_spintax_post";
+  generateStepTemplates: "generate_step_templates_sequencer_templates_steps_generate_post";
+  getNurture: "get_nurture_nurtures__nurture_id__get";
+  getProviderSizing: "get_provider_sizing_sequencer_deliverability_provider_sizing_get";
+  getSchedule: "get_schedule_schedules__schedule_id__get";
+  getSequence: "get_sequence_sequences__sequence_id__get";
+  getSequenceJob: "get_sequence_job_sequence_jobs__job_id__get";
+  getSequenceReports: "get_sequence_reports_sequences__sequence_id__reports_get";
+  getSequenceRoutingSummary: "get_sequence_routing_summary_sequences__sequence_id__routing_summary_get";
+  getSequenceStats: "get_sequence_stats_sequences__sequence_id__stats_get";
+  getSequencerCapacityEstimate: "get_sequencer_capacity_estimate_sequencer_channels_capacity_estimate_get";
+  getSequencesOverview: "get_sequences_overview_sequencer_stats_get";
+  improveStepInstruction: "improve_step_instruction_sequencer_content_instructions_improve_post";
+  launchNurture: "launch_nurture_nurtures__nurture_id__launch_post";
+  linkSequenceCampaign: "link_sequence_campaign_sequences__sequence_id__campaign_put";
+  listDialerContacts: "list_dialer_contacts_sequencer_dialer_sequences__sequence_id__contacts_get";
+  listDialerSequences: "list_dialer_sequences_sequencer_dialer_sequences_get";
+  listEmailDraftModels: "list_email_draft_models_sequencer_content_email_models_get";
+  listLinkedinAccounts: "list_linkedin_accounts_sequencer_channels_linkedin_accounts_get";
+  listNurtures: "list_nurtures_nurtures_get";
+  listSegVendors: "list_seg_vendors_sequencer_deliverability_seg_vendors_get";
+  listSequenceChannels: "list_sequence_channels_sequences__sequence_id__channels_get";
+  listSequenceContactIds: "list_sequence_contact_ids_sequences__sequence_id__contact_ids_get";
+  listSequenceContacts: "list_sequence_contacts_sequences__sequence_id__contacts_get";
+  listSequenceTemplates: "list_sequence_templates_sequencer_templates_sequences_get";
+  listSequencerMailboxes: "list_sequencer_mailboxes_sequencer_channels_mailboxes_get";
+  listSequencerPhoneNumbers: "list_sequencer_phone_numbers_sequencer_channels_phone_numbers_get";
+  listSequencerSmsNumbers: "list_sequencer_sms_numbers_sequencer_channels_sms_numbers_get";
+  listSequencerTextualAgents: "list_sequencer_textual_agents_sequencer_agents_textual_get";
+  listSequencerVoiceAgents: "list_sequencer_voice_agents_sequencer_agents_voice_get";
+  listSequencerWhatsappNumbers: "list_sequencer_whatsapp_numbers_sequencer_channels_whatsapp_numbers_get";
+  listSequencerWhatsappTemplates: "list_sequencer_whatsapp_templates_sequencer_channels_whatsapp_templates_get";
+  listSequences: "list_sequences_sequences_get";
+  listStepTemplates: "list_step_templates_sequencer_templates_steps_get";
+  pauseNurture: "pause_nurture_nurtures__nurture_id__pause_post";
+  pauseSequence: "pause_sequence_sequences__sequence_id__pause_post";
+  pauseSequenceContact: "pause_sequence_contact_sequences__sequence_id__contacts__contact_id__pause_post";
+  placeVoiceTestCall: "place_voice_test_call_sequencer_content_voice_test_call_post";
+  recordDialerOutcome: "record_dialer_outcome_sequencer_dialer_sequences__sequence_id__contacts__contact_id__callback_post";
+  removeSequenceChannel: "remove_sequence_channel_sequences__sequence_id__channels__sequence_channel_id__delete";
+  removeSequenceChannels: "remove_sequence_channels_sequences__sequence_id__channels_delete";
+  resumeNurture: "resume_nurture_nurtures__nurture_id__resume_post";
+  resumeSequence: "resume_sequence_sequences__sequence_id__resume_post";
+  resumeSequenceContact: "resume_sequence_contact_sequences__sequence_id__contacts__contact_id__resume_post";
+  runSequence: "run_sequence_sequences__sequence_id__run_post";
+  setSequenceStatus: "set_sequence_status_sequences__sequence_id__status_post";
+  syncSequence: "sync_sequence_sequences__sequence_id__sync_post";
+  terminateSequence: "terminate_sequence_sequences__sequence_id__terminate_post";
+  unlinkSequenceCampaign: "unlink_sequence_campaign_sequences__sequence_id__campaign_delete";
+  updateNurture: "update_nurture_nurtures__nurture_id__patch";
+  updateSchedule: "update_schedule_schedules__schedule_id__patch";
+  updateSequenceTemplate: "update_sequence_template_sequencer_templates_sequences__sequence_template_id__patch";
+  updateStepTemplate: "update_step_template_sequencer_templates_steps__step_template_id__patch";
+}
+
+/** Input and output of every `g8.api.sequences` operation, keyed by operationId. */
+export interface SequencesOperations {
+  /**
+   * POST /sequences/{sequence_id}/contacts
+   * Add Contacts To Sequence
+   * tier: external · scope: sequences:run
+   */
+  add_contacts_to_sequence_sequences__sequence_id__contacts_post: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AddSequenceContactsRequest;
+  };
+    output: ApiResponse_SequenceActionResponse_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/channels
+   * Add Sequence Channels
+   * tier: write · scope: sequences:write
+   */
+  add_sequence_channels_sequences__sequence_id__channels_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AddChannelsRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/steps
+   * Add Sequence Steps
+   * tier: write · scope: sequences:write
+   */
+  add_sequence_steps_sequences__sequence_id__steps_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AddStepsRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * PATCH /schedules/{schedule_id}/archive
+   * Archive Schedule
+   * tier: destructive · scope: campaigns:delete
+   */
+  archive_schedule_schedules__schedule_id__archive_patch: {
+    input: {
+    path: {
+      /** Schedule id, from `GET /schedules`. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ArchiveRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/archive
+   * Archive Sequence
+   * tier: destructive · scope: sequences:delete
+   */
+  archive_sequence_sequences__sequence_id__archive_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * PATCH /sequencer/templates/sequences/{sequence_template_id}/archive
+   * Archive Sequence Template
+   * tier: destructive · scope: sequences:delete
+   */
+  archive_sequence_template_sequencer_templates_sequences__sequence_template_id__archive_patch: {
+    input: {
+    path: {
+      /** Sequence template id. */
+      sequence_template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ArchiveRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * PATCH /sequencer/templates/steps/{step_template_id}/archive
+   * Archive Step Template
+   * tier: destructive · scope: sequences:delete
+   */
+  archive_step_template_sequencer_templates_steps__step_template_id__archive_patch: {
+    input: {
+    path: {
+      /** Step template id. */
+      step_template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ArchiveRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /nurtures
+   * Create Nurture
+   * tier: write · scope: sequences:write
+   */
+  create_nurture_nurtures_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NurtureCreateRequest;
+  };
+    output: ApiResponse_NurtureResponse_;
+  };
+  /**
+   * POST /schedules
+   * Create Schedule
+   * tier: write · scope: campaigns:write
+   */
+  create_schedule_schedules_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateSendingScheduleRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequencer/templates/sequences
+   * Create Sequence Template
+   * tier: write · scope: sequences:write
+   */
+  create_sequence_template_sequencer_templates_sequences_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateSequenceTemplateRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * POST /sequencer/templates/steps
+   * Create Step Template
+   * tier: write · scope: sequences:write
+   */
+  create_step_template_sequencer_templates_steps_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateStepTemplateRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * DELETE /nurtures/{nurture_id}
+   * Delete Nurture
+   * tier: destructive · scope: sequences:delete
+   */
+  delete_nurture_nurtures__nurture_id__delete: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * DELETE /sequences/{sequence_id}/steps/{step_id}
+   * Delete Sequence Step
+   * tier: destructive · scope: sequences:delete
+   */
+  delete_sequence_step_sequences__sequence_id__steps__step_id__delete: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+      /** Step id. */
+      step_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceOpsPayload_;
+  };
+  /**
+   * POST /sequencer/content/email/generate
+   * Draft Email
+   * tier: billable · scope: sequences:run
+   */
+  draft_email_sequencer_content_email_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DraftEmailRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequencer/content/linkedin/generate
+   * Draft Linkedin Message
+   * tier: billable · scope: sequences:run
+   */
+  draft_linkedin_message_sequencer_content_linkedin_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DraftLinkedInRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /nurtures/{nurture_id}/duplicate
+   * Duplicate Nurture
+   * tier: write · scope: sequences:write
+   */
+  duplicate_nurture_nurtures__nurture_id__duplicate_post: {
+    input: {
+    path: {
+      /** Nurture id to copy. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: NurtureDuplicateRequest;
+  };
+    output: ApiResponse_NurtureResponse_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/duplicate
+   * Duplicate Sequence
+   * tier: write · scope: sequences:write
+   */
+  duplicate_sequence_sequences__sequence_id__duplicate_post: {
+    input: {
+    path: {
+      /** Sequence id to copy. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: SequenceDuplicateRequest;
+  };
+    output: ApiResponse_SequenceRecord_;
+  };
+  /**
+   * POST /sequencer/content/email/estimate
+   * Estimate Email Draft
+   * tier: read · scope: sequences:read
+   */
+  estimate_email_draft_sequencer_content_email_estimate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DraftEmailRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequences/generate-spintax
+   * Generate Sequence Spintax
+   * tier: external · scope: sequences:run
+   */
+  generate_sequence_spintax_sequences_generate_spintax_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateSpintaxRequest;
+  };
+    output: ApiResponse_GenerateSpintaxResponse_;
+  };
+  /**
+   * POST /sequencer/templates/steps/generate
+   * Generate Step Templates
+   * tier: billable · scope: sequences:run
+   */
+  generate_step_templates_sequencer_templates_steps_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: GenerateStepTemplatesRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * GET /nurtures/{nurture_id}
+   * Get Nurture
+   * tier: read · scope: sequences:read
+   */
+  get_nurture_nurtures__nurture_id__get: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_NurtureResponse_;
+  };
+  /**
+   * GET /sequencer/deliverability/provider-sizing
+   * Get Provider Sizing
+   * tier: read · scope: sequences:read
+   */
+  get_provider_sizing_sequencer_deliverability_provider_sizing_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /schedules/{schedule_id}
+   * Get Schedule
+   * tier: read · scope: campaigns:read
+   */
+  get_schedule_schedules__schedule_id__get: {
+    input: {
+    path: {
+      /** Schedule id, from `GET /schedules`. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}
+   * Get Sequence
+   * tier: read · scope: sequences:read
+   */
+  get_sequence_sequences__sequence_id__get: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceDetailResponse_;
+  };
+  /**
+   * GET /sequence-jobs/{job_id}
+   * Get Sequence Job
+   * tier: read · scope: sequences:read
+   */
+  get_sequence_job_sequence_jobs__job_id__get: {
+    input: {
+    path: {
+      /** Background job id. */
+      job_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceOpsPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/reports
+   * Get Sequence Reports
+   * tier: read · scope: sequences:read
+   */
+  get_sequence_reports_sequences__sequence_id__reports_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceOpsPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/routing-summary
+   * Get Sequence Routing Summary
+   * tier: read · scope: sequences:read
+   */
+  get_sequence_routing_summary_sequences__sequence_id__routing_summary_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceRoutingSummary_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/stats
+   * Get Sequence Stats
+   * tier: read · scope: sequences:read
+   */
+  get_sequence_stats_sequences__sequence_id__stats_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceStats_;
+  };
+  /**
+   * GET /sequencer/channels/capacity-estimate
+   * Get Sequencer Capacity Estimate
+   * tier: read · scope: sequences:read
+   */
+  get_sequencer_capacity_estimate_sequencer_channels_capacity_estimate_get: {
+    input: {
+    query: {
+      /** Target contacts to reach per month. */
+      contacts_per_month: number;
+      /** False = cold start (25/day); True = warmed (100/day). */
+      warmed?: boolean;
+      /** TLD for the per-domain USD cost estimate. */
+      domain_tld?: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/stats
+   * Get Sequences Overview
+   * tier: read · scope: sequences:read
+   */
+  get_sequences_overview_sequencer_stats_get: {
+    input: {
+    query?: {
+      /** True: sequences the key owner created. False: the team's SHARED sequences. An organisation key owns none, so `true` answers empty. */
+      is_personal?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequencer/content/instructions/improve
+   * Improve Step Instruction
+   * tier: billable · scope: sequences:run
+   */
+  improve_step_instruction_sequencer_content_instructions_improve_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ImproveInstructionRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /nurtures/{nurture_id}/launch
+   * Launch Nurture
+   * tier: external · scope: sequences:run
+   */
+  launch_nurture_nurtures__nurture_id__launch_post: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * PUT /sequences/{sequence_id}/campaign
+   * Link Sequence Campaign
+   * tier: write · scope: sequences:write
+   */
+  link_sequence_campaign_sequences__sequence_id__campaign_put: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SequenceCampaignLinkRequest;
+  };
+    output: ApiResponse_SequenceRecord_;
+  };
+  /**
+   * GET /sequencer/dialer/sequences/{sequence_id}/contacts
+   * List Dialer Contacts
+   * tier: read · scope: sequences:read
+   */
+  list_dialer_contacts_sequencer_dialer_sequences__sequence_id__contacts_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+      sort_by?: "created_at" | "current_step_order" | "state" | "current_step_execution_at";
+      sort_order?: "asc" | "desc";
+      /** Only contacts in this state. */
+      state?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequencer/dialer/sequences
+   * List Dialer Sequences
+   * tier: read · scope: sequences:read
+   */
+  list_dialer_sequences_sequencer_dialer_sequences_get: {
+    input: {
+    query?: {
+      limit?: number;
+      offset?: number;
+      sort_by?: "created_at" | "updated_at" | "name" | "status";
+      sort_order?: "asc" | "desc";
+      /** Sequence name contains. */
+      search?: string | null;
+      /** Only sequences in this status, e.g. `running`. */
+      status?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequencer/content/email/models
+   * List Email Draft Models
+   * tier: read · scope: sequences:read
+   */
+  list_email_draft_models_sequencer_content_email_models_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequencer/channels/linkedin_accounts
+   * List Linkedin Accounts
+   * tier: read · scope: sequences:read
+   */
+  list_linkedin_accounts_sequencer_channels_linkedin_accounts_get: {
+    input: {
+    query?: {
+      /** Treat accounts already allocated to THIS sequence as available. Pass the sequence being edited, or every account it already uses looks taken. */
+      exclude_sequence_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /nurtures
+   * List Nurtures
+   * tier: read · scope: sequences:read
+   */
+  list_nurtures_nurtures_get: {
+    input: {
+    query?: {
+      /** Page number (1-indexed). */
+      page?: number;
+      /** Items per page (max 200). */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_NurtureListResponse_;
+  };
+  /**
+   * GET /sequencer/deliverability/seg-vendors
+   * List Seg Vendors
+   * tier: read · scope: sequences:read
+   */
+  list_seg_vendors_sequencer_deliverability_seg_vendors_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/channels
+   * List Sequence Channels
+   * tier: read · scope: sequences:read
+   */
+  list_sequence_channels_sequences__sequence_id__channels_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/contact-ids
+   * List Sequence Contact Ids
+   * tier: read · scope: sequences:read
+   */
+  list_sequence_contact_ids_sequences__sequence_id__contact_ids_get: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    query?: {
+      /** Free text over name, email and phone. */
+      search?: string | null;
+      /** Comma-separated states to INCLUDE. */
+      state_filter?: string | null;
+      /** Comma-separated states to EXCLUDE; composes with `state_filter`. */
+      exclude_states?: string | null;
+      /** Allocated mailbox contains. */
+      mailbox_filter?: string | null;
+      /** Allocated phone number contains. */
+      phone_allocated_filter?: string | null;
+      /** Company name contains. */
+      company_filter?: string | null;
+      /** Currently at this step order. */
+      step_order_filter?: number | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * GET /sequences/{sequence_id}/contacts
+   * List Sequence Contacts
+   * tier: read · scope: sequences:read
+   */
+  list_sequence_contacts_sequences__sequence_id__contacts_get: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    query?: {
+      /** Page number */
+      page?: number;
+      /** Items per page */
+      limit?: number;
+      /** Filter by contact state */
+      state?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SequenceContactItem__;
+  };
+  /**
+   * GET /sequencer/templates/sequences
+   * List Sequence Templates
+   * tier: read · scope: sequences:read
+   */
+  list_sequence_templates_sequencer_templates_sequences_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * GET /sequencer/channels/mailboxes
+   * List Sequencer Mailboxes
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_mailboxes_sequencer_channels_mailboxes_get: {
+    input: {
+    query: {
+      /** Mailbox email to scope the picker to. */
+      email: string;
+      /** Hide mailboxes already attached to this sequence. */
+      exclude_sequence_id?: string | null;
+      /** Include nurture-only mailboxes. */
+      include_nurture?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/channels/phone_numbers
+   * List Sequencer Phone Numbers
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_phone_numbers_sequencer_channels_phone_numbers_get: {
+    input: {
+    query?: {
+      exclude_sequence_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/channels/sms_numbers
+   * List Sequencer Sms Numbers
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_sms_numbers_sequencer_channels_sms_numbers_get: {
+    input: {
+    query?: {
+      exclude_sequence_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/agents/textual
+   * List Sequencer Textual Agents
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_textual_agents_sequencer_agents_textual_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/agents/voice
+   * List Sequencer Voice Agents
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_voice_agents_sequencer_agents_voice_get: {
+    input: {
+    query?: {
+      /** Filter by agent name. */
+      agent_name?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/channels/whatsapp_numbers
+   * List Sequencer Whatsapp Numbers
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_whatsapp_numbers_sequencer_channels_whatsapp_numbers_get: {
+    input: {
+    query?: {
+      exclude_sequence_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequencer/channels/whatsapp_templates
+   * List Sequencer Whatsapp Templates
+   * tier: read · scope: sequences:read
+   */
+  list_sequencer_whatsapp_templates_sequencer_channels_whatsapp_templates_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_Any_;
+  };
+  /**
+   * GET /sequences
+   * List Sequences
+   * tier: read · scope: sequences:read
+   */
+  list_sequences_sequences_get: {
+    input: {
+    query?: {
+      /** Page number */
+      page?: number;
+      /** Items per page */
+      limit?: number;
+      /** Filter by status */
+      status?: string | null;
+      /** Filter by sequence kind ('cold_outbound' or 'nurture'). Omit to list all kinds. */
+      sequence_kind?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SequenceListItem__;
+  };
+  /**
+   * GET /sequencer/templates/steps
+   * List Step Templates
+   * tier: read · scope: sequences:read
+   */
+  list_step_templates_sequencer_templates_steps_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * POST /nurtures/{nurture_id}/pause
+   * Pause Nurture
+   * tier: write · scope: sequences:write
+   */
+  pause_nurture_nurtures__nurture_id__pause_post: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/pause
+   * Pause Sequence
+   * tier: external · scope: sequences:run
+   */
+  pause_sequence_sequences__sequence_id__pause_post: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceActionResponse_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/contacts/{contact_id}/pause
+   * Pause Sequence Contact
+   * tier: write · scope: sequences:write
+   */
+  pause_sequence_contact_sequences__sequence_id__contacts__contact_id__pause_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+      /** Contact id. */
+      contact_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceOpsPayload_;
+  };
+  /**
+   * POST /sequencer/content/voice/test-call
+   * Place Voice Test Call
+   * tier: external · scope: sequences:run
+   */
+  place_voice_test_call_sequencer_content_voice_test_call_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: VoiceTestCallRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * POST /sequencer/dialer/sequences/{sequence_id}/contacts/{contact_id}/callback
+   * Record Dialer Outcome
+   * tier: write · scope: sequences:write
+   */
+  record_dialer_outcome_sequencer_dialer_sequences__sequence_id__contacts__contact_id__callback_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+      /** The contact's integer id in this sequence. */
+      contact_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: DialerCallbackRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * DELETE /sequences/{sequence_id}/channels/{sequence_channel_id}
+   * Remove Sequence Channel
+   * tier: destructive · scope: sequences:delete
+   */
+  remove_sequence_channel_sequences__sequence_id__channels__sequence_channel_id__delete: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+      /** Sequence-channel id, from `GET .../channels`. */
+      sequence_channel_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * DELETE /sequences/{sequence_id}/channels
+   * Remove Sequence Channels
+   * tier: destructive · scope: sequences:delete
+   */
+  remove_sequence_channels_sequences__sequence_id__channels_delete: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: RemoveChannelsRequest;
+  };
+    output: ApiResponse_SequencerListPayload_;
+  };
+  /**
+   * POST /nurtures/{nurture_id}/resume
+   * Resume Nurture
+   * tier: write · scope: sequences:write
+   */
+  resume_nurture_nurtures__nurture_id__resume_post: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/resume
+   * Resume Sequence
+   * tier: external · scope: sequences:run
+   */
+  resume_sequence_sequences__sequence_id__resume_post: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceActionResponse_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/contacts/{contact_id}/resume
+   * Resume Sequence Contact
+   * tier: external · scope: sequences:run
+   */
+  resume_sequence_contact_sequences__sequence_id__contacts__contact_id__resume_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+      /** Contact id. */
+      contact_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceOpsPayload_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/run
+   * Run Sequence
+   * tier: external · scope: sequences:run
+   */
+  run_sequence_sequences__sequence_id__run_post: {
+    input: {
+    path: {
+      /** Sequence ID */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceActionResponse_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/status
+   * Set Sequence Status
+   * tier: write · scope: sequences:write
+   */
+  set_sequence_status_sequences__sequence_id__status_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SequenceStatusRequest;
+  };
+    output: ApiResponse_SequenceRecord_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/sync
+   * Sync Sequence
+   * tier: external · scope: sequences:run
+   */
+  sync_sequence_sequences__sequence_id__sync_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /sequences/{sequence_id}/terminate
+   * Terminate Sequence
+   * tier: write · scope: sequences:write
+   */
+  terminate_sequence_sequences__sequence_id__terminate_post: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * DELETE /sequences/{sequence_id}/campaign
+   * Unlink Sequence Campaign
+   * tier: destructive · scope: sequences:delete
+   */
+  unlink_sequence_campaign_sequences__sequence_id__campaign_delete: {
+    input: {
+    path: {
+      /** Sequence id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SequenceRecord_;
+  };
+  /**
+   * PATCH /nurtures/{nurture_id}
+   * Update Nurture
+   * tier: write · scope: sequences:write
+   */
+  update_nurture_nurtures__nurture_id__patch: {
+    input: {
+    path: {
+      /** Nurture id. */
+      nurture_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: NurtureUpdateRequest;
+  };
+    output: ApiResponse_NurtureResponse_;
+  };
+  /**
+   * PATCH /schedules/{schedule_id}
+   * Update Schedule
+   * tier: write · scope: campaigns:write
+   */
+  update_schedule_schedules__schedule_id__patch: {
+    input: {
+    path: {
+      /** Schedule id, from `GET /schedules`. */
+      schedule_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateSendingScheduleRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * PATCH /sequencer/templates/sequences/{sequence_template_id}
+   * Update Sequence Template
+   * tier: write · scope: sequences:write
+   */
+  update_sequence_template_sequencer_templates_sequences__sequence_template_id__patch: {
+    input: {
+    path: {
+      /** Sequence template id. */
+      sequence_template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateSequenceTemplateRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+  /**
+   * PATCH /sequencer/templates/steps/{step_template_id}
+   * Update Step Template
+   * tier: write · scope: sequences:write
+   */
+  update_step_template_sequencer_templates_steps__step_template_id__patch: {
+    input: {
+    path: {
+      /** Step template id. */
+      step_template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateStepTemplateRequest;
+  };
+    output: ApiResponse_SequencerPayload_;
+  };
+}
+
+// 58 schemas referenced above (the same as G8Contract.<Name>).
+
+/** One sender to attach. Mirrors `AddChannelPayload` minus the client `id`. */
+export interface AddChannelItem {
+  channel_data?: Record<string, unknown> | null;
+  /** The sender's INTEGER id - a mailbox, number or account. */
+  channel_id: number;
+  channel_type: "SMTP" | "GMAIL" | "INBOXKIT" | "PHONE" | "LINKEDIN" | "LINKEDIN_NETRION" | "SMS" | "WHATSAPP";
+  /** Its address: the email, phone number or profile. */
+  channel_value: string;
+}
+
+/** Attach senders to a sequence. Mirrors `AddChannelParams`. */
+export interface AddChannelsRequest {
+  channels: Array<AddChannelItem>;
+}
+
+export interface AddSequenceContactsRequest {
+  /** Contact IDs to add to the sequence */
+  contact_ids: Array<number>;
+  /** List ID the contacts belong to */
+  list_id: number;
+}
+
+/** One step to add. Mirrors `CreateStepPayload` minus the client `id`. */
+export interface AddStepItem {
+  input_type: "ON_DEMAND" | "AI_GENERATED_TEMPLATE" | "MANUAL_TEMPLATE";
+  /** 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_data: Record<string, unknown>;
+  /** Position in the sequence, 1-based. */
+  step_order: number;
+  step_type: "PHONE" | "EMAIL" | "MANUAL_DIALER" | "HEYREACH" | "NETRION" | "SMS" | "WHATSAPP";
+  /** Seconds after the previous step. */
+  time_interval?: number | null;
+}
+
+/** Append steps to a sequence. Mirrors `CreateStepParams`. */
+export interface AddStepsRequest {
+  steps: Array<AddStepItem>;
+}
+
+export interface ApiResponse_Any_ {
+  data: unknown;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_GenerateSpintaxResponse_ {
+  data: GenerateSpintaxResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_NurtureListResponse_ {
+  data: NurtureListResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_NurtureResponse_ {
+  data: NurtureResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceActionResponse_ {
+  data: SequenceActionResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceDetailResponse_ {
+  data: SequenceDetailResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceOpsPayload_ {
+  data: SequenceOpsPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceRecord_ {
+  data: SequenceRecord;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceRoutingSummary_ {
+  data: SequenceRoutingSummary;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequenceStats_ {
+  data: SequenceStats;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequencerListPayload_ {
+  data: SequencerListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SequencerPayload_ {
+  data: SequencerPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SequenceContactItem__ {
+  data: Array<SequenceContactItem>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SequenceListItem__ {
+  data: Array<SequenceListItem>;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * Archive or UN-archive.
+ *
+ * An explicit flag rather than a toggle, so a retried request is idempotent
+ * instead of flipping the state back - and it is what makes the same route
+ * the un-archive route.
+ */
+export interface ArchiveRequest {
+  is_archived: boolean;
+}
+
+/** A sending schedule. Mirrors `CreateSchedulePayload` minus the client `id`. */
+export interface CreateSendingScheduleRequest {
+  config: SendingWeek;
+  description?: string | null;
+  name: string;
+  /** IANA timezone. */
+  timezone?: string;
+}
+
+/** A reusable sequence skeleton. Mirrors `CreateSequenceTemplatePayload`. */
+export interface CreateSequenceTemplateRequest {
+  /** Event type id for the booking link. */
+  appointment_id?: number | null;
+  description?: string | null;
+  name: string;
+  /** Sending schedule, from `GET /schedules`. */
+  schedule_id?: string | null;
+  steps?: Array<SequenceTemplateStep> | null;
+  /** Agent for email / social steps. */
+  textual_agent_name?: string | null;
+  /** Agent for phone / SMS steps. */
+  voice_agent_name?: string | null;
+}
+
+/**
+ * A reusable piece of step content. Mirrors `CreateStepTemplatePayload`
+ * minus the client-supplied `id` (see the module docstring).
+ */
+export interface CreateStepTemplateRequest {
+  input_type: "ON_DEMAND" | "AI_GENERATED_TEMPLATE" | "MANUAL_TEMPLATE";
+  name: string;
+  /** 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_data: Record<string, unknown>;
+  step_type: "PHONE" | "EMAIL" | "MANUAL_DIALER" | "HEYREACH" | "NETRION" | "SMS" | "WHATSAPP";
+}
+
+/** The outcome of a dialer call. Mirrors `DialerCallbackPayload`. */
+export interface DialerCallbackRequest {
+  /** True if the call connected and the contact should advance to the next step; false records an unsuccessful attempt. */
+  success: boolean;
+}
+
+/** Draft one contact's email. Mirrors `OnDemandPayload` field for field. */
+export interface DraftEmailRequest {
+  /** The textual agent whose voice and context are used. */
+  agent_name: string;
+  contact_id: number;
+  contact_work_email: string;
+  first_name: string;
+  /** What the email should do - the step's prompt. */
+  instructions: string;
+  last_name: string;
+  /** What is known about the contact, as free text. */
+  lead_info: string;
+  /** Model slug, from `GET /sequencer/content/email/models`. */
+  model?: string | null;
+  /** Model provider, from `GET /sequencer/content/email/models`. */
+  provider?: ("openai" | "anthropic" | "openrouter") | null;
+  /** Draft in the context of this sequence's linked campaign. */
+  sequence_id?: string | null;
+  step_order?: number | null;
+  /** Draft in this campaign's context; wins over `sequence_id`. */
+  studio_campaign_id?: string | null;
+}
+
+/** Draft one contact's LinkedIn message. Mirrors `OnDemandLinkedInPayload`. */
+export interface DraftLinkedInRequest {
+  agent_name?: string;
+  contact_id: number;
+  first_name: string;
+  instructions: string;
+  last_name: string;
+  lead_info: string;
+  /** The LinkedIn step kind the message is for, e.g. a connection request or a message. */
+  linkedin_action_type: string;
+  /** What earlier steps already said, so the draft does not repeat it. */
+  step_history?: string | null;
+  studio_campaign_id?: string | null;
+}
+
+/**
+ * One-time AI generation: rewrite a manual email into spintax.
+ *
+ * Field types intentionally mirror the internal
+ * ``sequencer.interfaces.voice.email_generation.GenerateSpintaxPayload``
+ * (same Literals) so outer/inner validation cannot drift. The legacy
+ * ``target_combinations`` knob is deliberately NOT exposed on the public
+ * surface; ``strength`` supersedes it.
+ */
+export interface GenerateSpintaxRequest {
+  /** Email body to rewrite into spintax */
+  body: string;
+  /** Body format. 'html' preserves every <a href> link and all {{variables}} in the rewrite. */
+  email_type?: "plain" | "html";
+  /** 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. */
+  strength?: "light" | "balanced" | "maximum";
+  /** Email subject to rewrite into spintax */
+  subject: string;
+  /** Optional tone/style guidance applied during the rewrite (e.g. 'casual, no exclamation marks'). */
+  tone_instructions?: string | null;
+}
+
+/** Spintax-encoded email plus its distinct-rendering counts. */
+export interface GenerateSpintaxResponse {
+  /** Body rewritten with (possibly nested) spintax blocks */
+  body: string;
+  /** Distinct renderings the body can produce */
+  body_combinations: number;
+  /** Subject rewritten with {{option a|option b}} spintax blocks */
+  subject: string;
+  /** Distinct renderings the subject can produce */
+  subject_combinations: number;
+  /** Distinct full-email renderings (subject x body) */
+  total_combinations: number;
+}
+
+/** Ask an agent to draft step content. Mirrors `GetContentTemplatesParams`. */
+export interface GenerateStepTemplatesRequest {
+  /** The agent whose voice and context the drafts use. */
+  agent_name: string;
+}
+
+/** Rewrite a step's drafting instruction. Mirrors `PromptImprovementPayload`. */
+export interface ImproveInstructionRequest {
+  /** The instruction being replaced, so the rewrite keeps its intent. */
+  old_instruction?: string | null;
+  /** What the drafting agent should do, in the author's own words. */
+  user_instruction: string;
+}
+
+/**
+ * Create a nurture.
+ *
+ * `sequence_kind` is NOT accepted: the app pins it to `nurture` server-side
+ * and re-validates, which is what makes the nurture-specific channel rules
+ * fire. A client-supplied kind would either be ignored or, worse, look
+ * honoured.
+ */
+export interface NurtureCreateRequest {
+  /** Audience list whose contacts this nurture engages. */
+  associated_list_id?: number | null;
+  /** Studio campaign to link this nurture to. */
+  campaign_builder_campaign_id?: string | null;
+  /** Sending channels to attach. */
+  channels?: Array<Record<string, unknown>>;
+  description?: string | null;
+  /** Stop nurturing a contact once they reply. */
+  finish_on_reply?: boolean;
+  /** Append the visible reply-opt-out CTA to email bodies. */
+  include_unsubscribe_cta?: boolean;
+  /** True makes the nurture visible org-wide. Requires an Admin or Owner role; see this router's note on org-scope promotion. */
+  is_shared?: boolean;
+  /** Nurture name. */
+  name: string;
+  /** 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. */
+  pinned_mailbox_id: number;
+  schedule_id?: string | null;
+  /** Keep follow-ups in the original email thread. */
+  send_in_same_thread?: boolean;
+  /** Initial status. Nurtures start drafted. */
+  status?: string;
+  /** Sequence steps, in order. */
+  steps?: Array<Record<string, unknown>>;
+  textual_agent_name?: string | null;
+  /** 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. */
+  user_email?: string | null;
+  voice_agent_name?: string | null;
+  wait_for_new_contacts?: boolean;
+}
+
+/**
+ * Copy a nurture. The copy is always owned by the caller and starts drafted.
+ *
+ * `user_email` is deliberately absent: the app pins the copy's owner to the
+ * caller regardless of what is sent, so accepting the field would advertise
+ * control the endpoint does not grant.
+ */
+export interface NurtureDuplicateRequest {
+  /** Give the copy a fresh contacts list instead of reusing the source's. */
+  is_new_list?: boolean | null;
+  /** 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. */
+  is_shared?: boolean | null;
+  /** Name for the copy. Defaults to the source name with ' (Copy)' appended. */
+  name?: string | null;
+  /** Existing list for the copy. Ignored unless `is_new_list` is true. */
+  new_list_id?: number | null;
+}
+
+/** A page of nurtures the caller may see - their own plus org-shared. */
+export interface NurtureListResponse {
+  nurtures?: Array<NurtureResponse>;
+  total?: number;
+  [key: string]: unknown;
+}
+
+/** One nurture sequence. */
+export interface NurtureResponse {
+  created_at?: string | null;
+  id?: string | null;
+  /** True when visible org-wide. */
+  is_shared?: boolean | null;
+  name?: string | null;
+  /** draft, live, paused, completed, terminated. */
+  status?: string | null;
+  updated_at?: string | null;
+  [key: string]: unknown;
+}
+
+/** Patch a nurture. Every field optional; omit one to leave it unchanged. */
+export interface NurtureUpdateRequest {
+  appointment_id?: number | null;
+  associated_list_id?: number | null;
+  description?: string | null;
+  finish_on_reply?: boolean | null;
+  include_unsubscribe_cta?: boolean | null;
+  /** Set true to promote the nurture to org scope. Admin/Owner only - this is the one field on this model that is permission-gated. */
+  is_shared?: boolean | null;
+  name?: string | null;
+  schedule_id?: string | null;
+  send_in_same_thread?: boolean | null;
+  textual_agent_name?: string | null;
+  voice_agent_name?: string | null;
+  wait_for_new_contacts?: boolean | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/** Detach senders from a sequence. Mirrors `BulkArchiveChannelParams`. */
+export interface RemoveChannelsRequest {
+  /** Sequence-channel ids, from `GET .../channels`. */
+  channel_ids: Array<string>;
+}
+
+/** The weekly window. A day left out is a day nothing is sent. */
+export interface SendingWeek {
+  friday?: SendingWindow | null;
+  monday?: SendingWindow | null;
+  saturday?: SendingWindow | null;
+  sunday?: SendingWindow | null;
+  thursday?: SendingWindow | null;
+  tuesday?: SendingWindow | null;
+  wednesday?: SendingWindow | null;
+}
+
+/**
+ * One day's sending window. `start` must be EARLIER than `end`.
+ *
+ * Overnight windows are not supported - model them as two days. The app
+ * rejects an inverted or zero-length window, and so does this.
+ */
+export interface SendingWindow {
+  /** `HH:MM`, 24-hour. */
+  end: string;
+  /** `HH:MM`, 24-hour. */
+  start: string;
+}
+
+export interface SequenceActionResponse {
+  contacts_affected?: number;
+  sequence_id: string;
+  status: string;
+}
+
+/** Link a sequence to a Studio campaign. */
+export interface SequenceCampaignLinkRequest {
+  /** Studio campaign id to link. */
+  campaign_id: string;
+}
+
+export interface SequenceContactItem {
+  contact_id?: number | null;
+  created_at?: string | null;
+  current_step_order?: number | null;
+  id?: string | null;
+  state?: string | null;
+  updated_at?: string | null;
+}
+
+export interface SequenceDetailResponse {
+  appointment_id?: number | null;
+  associated_list_id?: number | null;
+  created_at?: string | null;
+  description?: string | null;
+  finish_on_reply?: boolean;
+  id: string;
+  name?: string | null;
+  paused_at?: string | null;
+  pinned_mailbox_id?: number | null;
+  resumed_at?: string | null;
+  schedule_id?: string | null;
+  send_in_same_thread?: boolean;
+  sequence_kind?: string | null;
+  status?: string | null;
+  textual_agent_name?: string | null;
+  updated_at?: string | null;
+  user_email?: string | null;
+  voice_agent_name?: string | null;
+  wait_for_new_contacts?: boolean;
+}
+
+/**
+ * Copy a sequence. The copy is owned by the caller and starts drafted.
+ *
+ * `user_email` is deliberately absent: the app pins the copy's owner to the
+ * caller, so accepting the field would advertise control it does not grant.
+ */
+export interface SequenceDuplicateRequest {
+  /** Give the copy a fresh contacts list instead of the source's. */
+  is_new_list?: boolean | null;
+  /** 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. */
+  is_shared?: boolean | null;
+  /** Name for the copy. Defaults to the source name with ' (Copy)' appended. */
+  name?: string | null;
+  /** Existing list for the copy. Ignored unless `is_new_list` is true. */
+  new_list_id?: number | null;
+}
+
+export interface SequenceListItem {
+  associated_list_id?: number | null;
+  contact_count?: number | null;
+  created_at?: string | null;
+  id: string;
+  name?: string | null;
+  sequence_kind?: string | null;
+  status?: string | null;
+  step_count?: number | null;
+  updated_at?: string | null;
+  user_email?: string | null;
+}
+
+/** A sequence contact, report, step list or job status, as the app returns it. */
+export type SequenceOpsPayload = Record<string, unknown>;
+
+/** One sequence, as the lifecycle endpoints return it. */
+export interface SequenceRecord {
+  associated_list_id?: number | null;
+  /** Linked Studio campaign, if any. */
+  campaign_builder_campaign_id?: string | null;
+  created_at?: string | null;
+  id?: string | null;
+  is_archived?: boolean | null;
+  is_shared?: boolean | null;
+  name?: string | null;
+  sequence_kind?: string | null;
+  status?: string | null;
+  updated_at?: string | null;
+  /** Owner. */
+  user_email?: string | null;
+  [key: string]: unknown;
+}
+
+/**
+ * Approximate provider-routing and suppression breakdown for the list.
+ *
+ * Two properties a caller must not lose:
+ *
+ *   * APPROXIMATE - computed by scanning 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 counts toward exactly ONE bucket, suppression taking
+ * precedence over routing (bounce > seg > personal), so the buckets are a
+ * partition and must not be summed alongside each other as if they overlap.
+ */
+export interface SequenceRoutingSummary {
+  bounce_suppressed_count?: number;
+  google_count?: number;
+  m365_count?: number;
+  other_count?: number;
+  personal_suppressed_count?: number;
+  /** How many recipients were actually scanned (capped at 10,000). */
+  scanned_count?: number | null;
+  seg_suppressed_count?: number;
+  [key: string]: unknown;
+}
+
+/**
+ * Per-step delivery and engagement counts for a sequence.
+ *
+ * `skip_reason_breakdown` is SEQUENCE-level and counted ONCE per contact, so
+ * its total can be LESS than the sum of the per-step `skipped` tiles: the
+ * durable-LinkedIn-skip cascade writes one receipt per contiguous LinkedIn
+ * step, and a skip with no recorded reason is omitted entirely. Presenting
+ * the two as if they must reconcile is wrong.
+ */
+export interface SequenceStats {
+  /** Distinct terminal-skipped contacts by raw skip-reason token, e.g. `skipped_too_distant`. Sequence-level, counted once per contact. */
+  skip_reason_breakdown?: Record<string, number>;
+  step_stats?: Array<Record<string, unknown>>;
+  total_contacts?: number;
+  [key: string]: unknown;
+}
+
+/**
+ * Drive the sequence status machine directly.
+ *
+ * Prefer the named transitions (`/launch`, `/pause`, `/resume`,
+ * `/terminate`, `/archive`) - each runs the wind-down, scheduling and event
+ * work that belongs to it. This endpoint SETS THE STATUS, and the app's
+ * state machine is what rejects an illegal transition.
+ */
+export interface SequenceStatusRequest {
+  /** 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. */
+  status: string;
+}
+
+/** One step of a sequence template. Mirrors `SequenceTemplateStep`. */
+export interface SequenceTemplateStep {
+  input_type: "ON_DEMAND" | "AI_GENERATED_TEMPLATE" | "MANUAL_TEMPLATE";
+  name: string;
+  /** 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_data: Record<string, unknown>;
+  step_order: number;
+  step_type: "PHONE" | "EMAIL" | "MANUAL_DIALER" | "HEYREACH" | "NETRION" | "SMS" | "WHATSAPP";
+  /** Seconds after the previous step. */
+  time_interval?: number | null;
+}
+
+/** An open envelope around a LIST of sequencer records, as `items`. */
+export interface SequencerListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope around one sequencer record.
+ *
+ * Open because templates, schedules and channels carry nested step data and
+ * configuration that grows as channels are added.
+ */
+export type SequencerPayload = Record<string, unknown>;
+
+/** Change a sending schedule. Mirrors `PatchScheduleParams`. */
+export interface UpdateSendingScheduleRequest {
+  config?: SendingWeek | null;
+  description?: string | null;
+  name?: string | null;
+  timezone?: string | null;
+}
+
+/**
+ * Change a sequence template. Mirrors `PatchSequenceTemplatePayload`.
+ *
+ * `steps`, when sent, REPLACES the template's steps rather than merging.
+ */
+export interface UpdateSequenceTemplateRequest {
+  appointment_id?: number | null;
+  description?: string | null;
+  name?: string | null;
+  schedule_id?: string | null;
+  steps?: Array<SequenceTemplateStep> | null;
+  textual_agent_name?: string | null;
+  voice_agent_name?: string | null;
+}
+
+/**
+ * Change a step template. Mirrors `PatchStepTemplatePayload`.
+ *
+ * There is no `input_type` here because the app's patch has none: a
+ * template's input type is fixed at creation.
+ */
+export interface UpdateStepTemplateRequest {
+  name?: string | null;
+  step_data?: Record<string, unknown> | null;
+  step_type?: ("PHONE" | "EMAIL" | "MANUAL_DIALER" | "HEYREACH" | "NETRION" | "SMS" | "WHATSAPP") | null;
+}
+
+/** Place one test call from a voice step. Mirrors `DryRunCallPayload`. */
+export interface VoiceTestCallRequest {
+  /** The voice agent that runs the call. */
+  agent_id: string;
+  /** The test contact's email, as the agent would see it. */
+  email: string;
+  /** How the agent addresses the person it rings. */
+  first_name: string;
+  /** One of the organisation's numbers to call from. */
+  from_phone: string;
+  last_name: string;
+  /** The number to ring. A REAL phone rings. */
+  to_phone: string;
+}