@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/linkedInOutreach.d.ts

@@ -0,0 +1,727 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.linkedInOutreach` (LinkedIn Outreach): 20 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"add_outreach_list_leads_integrations_linkedin_outreach_lists__list_id__leads_post">;
+ *
+ * Reference with examples: linkedInOutreach.md
+ */
+/* eslint-disable */
+
+/** `g8.api.linkedInOutreach.<member>` -> the operationId it calls. */
+export interface LinkedInOutreachMembers {
+  addOutreachListLeads: "add_outreach_list_leads_integrations_linkedin_outreach_lists__list_id__leads_post";
+  createOutreachList: "create_outreach_list_integrations_linkedin_outreach_lists_post";
+  getActiveOutreachWorkspace: "get_active_outreach_workspace_integrations_linkedin_outreach_workspaces_active_get";
+  getOutreachCampaignProgress: "get_outreach_campaign_progress_integrations_linkedin_outreach_campaigns__campaign_id__progress_get";
+  getOutreachCampaignStats: "get_outreach_campaign_stats_integrations_linkedin_outreach_campaigns__campaign_id__stats_get";
+  getOutreachConnection: "get_outreach_connection_integrations_linkedin_outreach_connection_get";
+  getOutreachSequenceMapping: "get_outreach_sequence_mapping_integrations_linkedin_outreach_sequences__sequence_id__mapping_get";
+  getOutreachSequenceProgress: "get_outreach_sequence_progress_integrations_linkedin_outreach_sequences__sequence_id__progress_get";
+  listOutreachCampaigns: "list_outreach_campaigns_integrations_linkedin_outreach_campaigns_get";
+  listOutreachLists: "list_outreach_lists_integrations_linkedin_outreach_lists_get";
+  listOutreachSenderAccounts: "list_outreach_sender_accounts_integrations_linkedin_outreach_accounts_get";
+  listOutreachSequenceStepCampaigns: "list_outreach_sequence_step_campaigns_integrations_linkedin_outreach_sequences__sequence_id__step_campaigns_get";
+  listOutreachTemplates: "list_outreach_templates_integrations_linkedin_outreach_templates_get";
+  listOutreachWorkspaces: "list_outreach_workspaces_integrations_linkedin_outreach_workspaces_get";
+  pauseOutreachCampaign: "pause_outreach_campaign_integrations_linkedin_outreach_campaigns__campaign_id__pause_post";
+  reconnectOutreach: "reconnect_outreach_integrations_linkedin_outreach_connection_reconnect_post";
+  resumeOutreachCampaign: "resume_outreach_campaign_integrations_linkedin_outreach_campaigns__campaign_id__resume_post";
+  searchOutreachCampaignLeads: "search_outreach_campaign_leads_integrations_linkedin_outreach_campaigns__campaign_id__leads_search_post";
+  selectActiveOutreachWorkspace: "select_active_outreach_workspace_integrations_linkedin_outreach_workspaces_active_put";
+  syncOutreachWorkspace: "sync_outreach_workspace_integrations_linkedin_outreach_workspaces_sync_post";
+}
+
+/** Input and output of every `g8.api.linkedInOutreach` operation, keyed by operationId. */
+export interface LinkedInOutreachOperations {
+  /**
+   * POST /integrations/linkedin-outreach/lists/{list_id}/leads
+   * Add Outreach List Leads
+   * tier: external · scope: integrations:run
+   */
+  add_outreach_list_leads_integrations_linkedin_outreach_lists__list_id__leads_post: {
+    input: {
+    path: {
+      /** The outreach lead list's id. */
+      list_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: OutreachAddLeadsRequest;
+  };
+    output: ApiResponse_OutreachLeadsAdded_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/lists
+   * Create Outreach List
+   * tier: external · scope: integrations:run
+   */
+  create_outreach_list_integrations_linkedin_outreach_lists_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: OutreachListCreateRequest;
+  };
+    output: ApiResponse_OutreachListCreated_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/workspaces/active
+   * Get Active Outreach Workspace
+   * tier: read · scope: integrations:read
+   */
+  get_active_outreach_workspace_integrations_linkedin_outreach_workspaces_active_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachWorkspaceState_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/campaigns/{campaign_id}/progress
+   * Get Outreach Campaign Progress
+   * tier: read · scope: integrations:read
+   */
+  get_outreach_campaign_progress_integrations_linkedin_outreach_campaigns__campaign_id__progress_get: {
+    input: {
+    path: {
+      /** The outreach campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaignProgress_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/campaigns/{campaign_id}/stats
+   * Get Outreach Campaign Stats
+   * tier: read · scope: integrations:read
+   */
+  get_outreach_campaign_stats_integrations_linkedin_outreach_campaigns__campaign_id__stats_get: {
+    input: {
+    path: {
+      /** The outreach campaign's id. */
+      campaign_id: number;
+    };
+    query?: {
+      /** YYYY-MM-DD. Omit both dates for all time. */
+      start_date?: string | null;
+      /** YYYY-MM-DD. */
+      end_date?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaignStats_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/connection
+   * Get Outreach Connection
+   * tier: read · scope: integrations:read
+   */
+  get_outreach_connection_integrations_linkedin_outreach_connection_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachConnectionStatus_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/sequences/{sequence_id}/mapping
+   * Get Outreach Sequence Mapping
+   * tier: read · scope: integrations:read
+   */
+  get_outreach_sequence_mapping_integrations_linkedin_outreach_sequences__sequence_id__mapping_get: {
+    input: {
+    path: {
+      /** The graph8 sequence's id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachSequenceMapping_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/sequences/{sequence_id}/progress
+   * Get Outreach Sequence Progress
+   * tier: read · scope: integrations:read
+   */
+  get_outreach_sequence_progress_integrations_linkedin_outreach_sequences__sequence_id__progress_get: {
+    input: {
+    path: {
+      /** The graph8 sequence's id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaignProgress_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/campaigns
+   * List Outreach Campaigns
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_campaigns_integrations_linkedin_outreach_campaigns_get: {
+    input: {
+    query?: {
+      /** ZERO-indexed, passed through to the platform. */
+      page?: number;
+      /** Substring match on the campaign name. */
+      keyword?: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaigns_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/lists
+   * List Outreach Lists
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_lists_integrations_linkedin_outreach_lists_get: {
+    input: {
+    query?: {
+      /** ZERO-indexed, passed through to the platform. */
+      page?: number;
+      /** Substring match on the list name. */
+      search?: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachLists_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/accounts
+   * List Outreach Sender Accounts
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_sender_accounts_integrations_linkedin_outreach_accounts_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachSenderAccounts_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/sequences/{sequence_id}/step-campaigns
+   * List Outreach Sequence Step Campaigns
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_sequence_step_campaigns_integrations_linkedin_outreach_sequences__sequence_id__step_campaigns_get: {
+    input: {
+    path: {
+      /** The graph8 sequence's id. */
+      sequence_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachStepCampaigns_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/templates
+   * List Outreach Templates
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_templates_integrations_linkedin_outreach_templates_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachTemplates_;
+  };
+  /**
+   * GET /integrations/linkedin-outreach/workspaces
+   * List Outreach Workspaces
+   * tier: read · scope: integrations:read
+   */
+  list_outreach_workspaces_integrations_linkedin_outreach_workspaces_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachWorkspaces_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/campaigns/{campaign_id}/pause
+   * Pause Outreach Campaign
+   * tier: external · scope: integrations:run
+   */
+  pause_outreach_campaign_integrations_linkedin_outreach_campaigns__campaign_id__pause_post: {
+    input: {
+    path: {
+      /** The outreach campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaignActionResult_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/connection/reconnect
+   * Reconnect Outreach
+   * tier: external · scope: integrations:run
+   */
+  reconnect_outreach_integrations_linkedin_outreach_connection_reconnect_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachReconnectResult_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/campaigns/{campaign_id}/resume
+   * Resume Outreach Campaign
+   * tier: external · scope: integrations:run
+   */
+  resume_outreach_campaign_integrations_linkedin_outreach_campaigns__campaign_id__resume_post: {
+    input: {
+    path: {
+      /** The outreach campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachCampaignActionResult_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/campaigns/{campaign_id}/leads/search
+   * Search Outreach Campaign Leads
+   * tier: read · scope: integrations:read
+   */
+  search_outreach_campaign_leads_integrations_linkedin_outreach_campaigns__campaign_id__leads_search_post: {
+    input: {
+    path: {
+      /** The outreach campaign's id. */
+      campaign_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: OutreachCampaignLeadsQuery;
+  };
+    output: ApiResponse_OutreachCampaignLeads_;
+  };
+  /**
+   * PUT /integrations/linkedin-outreach/workspaces/active
+   * Select Active Outreach Workspace
+   * tier: external · scope: integrations:run
+   */
+  select_active_outreach_workspace_integrations_linkedin_outreach_workspaces_active_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: OutreachWorkspaceSelectRequest;
+  };
+    output: ApiResponse_OutreachWorkspaceSelected_;
+  };
+  /**
+   * POST /integrations/linkedin-outreach/workspaces/sync
+   * Sync Outreach Workspace
+   * tier: external · scope: integrations:run
+   */
+  sync_outreach_workspace_integrations_linkedin_outreach_workspaces_sync_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OutreachWorkspaceState_;
+  };
+}
+
+// 49 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_OutreachCampaignActionResult_ {
+  data: OutreachCampaignActionResult;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachCampaignLeads_ {
+  data: OutreachCampaignLeads;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachCampaignProgress_ {
+  data: OutreachCampaignProgress;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachCampaignStats_ {
+  data: OutreachCampaignStats;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachCampaigns_ {
+  data: OutreachCampaigns;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachConnectionStatus_ {
+  data: OutreachConnectionStatus;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachLeadsAdded_ {
+  data: OutreachLeadsAdded;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachListCreated_ {
+  data: OutreachListCreated;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachLists_ {
+  data: OutreachLists;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachReconnectResult_ {
+  data: OutreachReconnectResult;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachSenderAccounts_ {
+  data: OutreachSenderAccounts;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachSequenceMapping_ {
+  data: OutreachSequenceMapping;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachStepCampaigns_ {
+  data: OutreachStepCampaigns;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachTemplates_ {
+  data: OutreachTemplates;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachWorkspaceSelected_ {
+  data: OutreachWorkspaceSelected;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachWorkspaceState_ {
+  data: OutreachWorkspaceState;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OutreachWorkspaces_ {
+  data: OutreachWorkspaces;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * People to add to an outreach lead list.
+ *
+ * Each object is one person. `linkedInUrl`, `firstName` and `lastName` are the
+ * fields that matter; `companyName`, `position` and similar are passed through.
+ */
+export interface OutreachAddLeadsRequest {
+  leads: Array<Record<string, unknown>>;
+}
+
+export interface OutreachCampaign {
+  created_at?: string | null;
+  finished_leads?: number;
+  id: number;
+  name: string;
+  pending_leads?: number;
+  /** DRAFT, ONGOING, PAUSED or FINISHED. */
+  status: string;
+  total_leads?: number;
+}
+
+export interface OutreachCampaignActionResult {
+  message: string;
+  success: boolean;
+}
+
+export interface OutreachCampaignLead {
+  creation_time?: string | null;
+  error_code?: string | null;
+  failed_time?: string | null;
+  id: number;
+  last_action_time?: string | null;
+  lead_campaign_status?: string | null;
+  lead_campaign_status_message?: string | null;
+  lead_connection_status?: string | null;
+  lead_message_status?: string | null;
+  linkedin_sender_full_name?: string | null;
+  linkedin_sender_id?: number | null;
+  linkedin_user_profile?: OutreachLeadProfile | null;
+  linkedin_user_profile_id?: string | null;
+}
+
+export interface OutreachCampaignLeads {
+  items: Array<OutreachCampaignLead>;
+  limit: number;
+  offset: number;
+  total_count: number;
+}
+
+/**
+ * Page through the people in one campaign. Reads only.
+ *
+ * `campaign_id` exists because the app's model has it; the PATH value is
+ * authoritative and overwrites whatever is sent here.
+ */
+export interface OutreachCampaignLeadsQuery {
+  /** Ignored; the path value is used. */
+  campaign_id?: number | null;
+  /** Page size. Values above 1000 are capped at 1000. */
+  limit?: number;
+  /** Leads to skip. */
+  offset?: number;
+  time_filter?: ("CreationTime" | "Everywhere") | null;
+  /** ISO 8601. */
+  time_from?: string | null;
+  /** ISO 8601. */
+  time_to?: string | null;
+}
+
+export interface OutreachCampaignProgress {
+  campaign_id: number;
+  campaign_name: string;
+  progress_stats: OutreachProgressFigures;
+  status?: unknown;
+}
+
+export interface OutreachCampaignStats {
+  by_day_stats?: Record<string, unknown> | null;
+  stats: OutreachCampaignStatsFigures;
+}
+
+export interface OutreachCampaignStatsFigures {
+  campaign_id: number;
+  connection_acceptance_rate?: number;
+  connections_accepted?: number;
+  connections_sent?: number;
+  follows?: number;
+  inmail_messages_sent?: number;
+  message_reply_rate?: number;
+  messages_sent?: number;
+  post_likes?: number;
+  profile_views?: number;
+  total_message_replies?: number;
+  total_message_started?: number;
+}
+
+export interface OutreachCampaigns {
+  campaigns: Array<OutreachCampaign>;
+  total_count: number;
+}
+
+/** Whether the org's outreach connection exists and its session is healthy. Never the credentials. */
+export interface OutreachConnectionStatus {
+  auto_reauth_enabled?: boolean;
+  auto_reauth_error?: string | null;
+  auto_reauth_status?: string | null;
+  connected: boolean;
+  email?: string | null;
+  failed_reauth_count?: number | null;
+  is_token_valid?: boolean;
+  last_reauth_success_at?: string | null;
+  reenable_in_seconds?: number | null;
+  requires_manual_login?: boolean | null;
+  tenant_id?: number | null;
+  time_until_expiry_seconds?: number | null;
+  token_expires_at?: string | null;
+  workspace_configured?: boolean;
+  workspace_id?: number | null;
+  workspace_name?: string | null;
+}
+
+export interface OutreachLeadProfile {
+  about?: string | null;
+  company_name?: string | null;
+  company_url?: string | null;
+  connections?: number;
+  email_address?: string | null;
+  first_name?: string | null;
+  followers?: number;
+  headline?: string | null;
+  image_url?: string | null;
+  last_name?: string | null;
+  linkedin_id?: string | null;
+  location?: string | null;
+  position?: string | null;
+  profile_url?: string | null;
+}
+
+export interface OutreachLeadsAdded {
+  added_count: number;
+}
+
+export interface OutreachList {
+  created_at?: string | null;
+  id: number;
+  leads_count?: number;
+  name: string;
+}
+
+/** A new, empty lead list on the outreach platform. */
+export interface OutreachListCreateRequest {
+  name: string;
+}
+
+export interface OutreachListCreated {
+  id: number;
+  name: string;
+}
+
+export interface OutreachLists {
+  lists: Array<OutreachList>;
+  total_count: number;
+}
+
+export interface OutreachProgressFigures {
+  total_users?: number;
+  total_users_excluded?: number;
+  total_users_failed?: number;
+  total_users_finished?: number;
+  total_users_in_progress?: number;
+  total_users_manually_stopped?: number;
+  total_users_pending?: number;
+}
+
+/** Outcome of refreshing the session. `requires_login: true` means a person must sign in again in the app. */
+export interface OutreachReconnectResult {
+  email?: string | null;
+  message: string;
+  requires_login?: boolean;
+  success: boolean;
+  token_expires_at?: string | null;
+}
+
+/** A LinkedIn account that sends outreach. */
+export interface OutreachSenderAccount {
+  email?: string | null;
+  id: number;
+  is_connected?: boolean;
+  is_premium?: boolean;
+  name: string;
+  profile_picture_url?: string | null;
+  status?: string | null;
+}
+
+export interface OutreachSenderAccounts {
+  accounts: Array<OutreachSenderAccount>;
+  total_count: number;
+}
+
+/** The outreach campaign and list a graph8 sequence runs through. */
+export interface OutreachSequenceMapping {
+  campaign_id?: number | null;
+  campaign_name?: string | null;
+  list_id?: number | null;
+  sequence_id: string;
+  status?: string | null;
+}
+
+export interface OutreachStepCampaign {
+  campaign_id: number;
+  linkedin_action_type: string;
+  status: string;
+}
+
+/** Keyed by sequence step id. Steps with no campaign are absent. */
+export interface OutreachStepCampaigns {
+  step_campaigns: Record<string, OutreachStepCampaign>;
+}
+
+export interface OutreachTemplate {
+  description?: string | null;
+  id: number;
+  is_default?: boolean;
+  name: string;
+  sequence: Record<string, unknown>;
+}
+
+export interface OutreachTemplates {
+  templates: Array<OutreachTemplate>;
+}
+
+export interface OutreachWorkspace {
+  seats_limit?: number | null;
+  used_seats?: number | null;
+  workspace_id: number;
+  workspace_name: string;
+}
+
+/** Which workspace this org sends from. ONE-TIME: it cannot be changed once set. */
+export interface OutreachWorkspaceSelectRequest {
+  /** A `workspace_id` from `GET /integrations/linkedin-outreach/workspaces`. */
+  workspace_id: number;
+}
+
+export interface OutreachWorkspaceSelected {
+  message: string;
+  success: boolean;
+  workspace_id: number;
+  workspace_name?: string | null;
+}
+
+/** The workspace this org sends from, if one is selected. */
+export interface OutreachWorkspaceState {
+  connected?: boolean | null;
+  message?: string | null;
+  success?: boolean | null;
+  workspace_configured?: boolean | null;
+  workspace_id?: number | null;
+  workspace_name?: string | null;
+}
+
+/** Selectable workspaces. Empty once one is selected - `current_workspace_id` then says which. */
+export interface OutreachWorkspaces {
+  current_workspace_id?: number | null;
+  current_workspace_name?: string | null;
+  total_count: number;
+  workspaces: Array<OutreachWorkspace>;
+}
+
+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;
+}