@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/meetings.d.ts

@@ -0,0 +1,539 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.meetings` (Meetings): 17 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"acknowledge_meeting_review_meeting_transcripts__transcript_id__review_acknowledge_post">;
+ *
+ * Reference with examples: meetings.md
+ */
+/* eslint-disable */
+
+/** `g8.api.meetings.<member>` -> the operationId it calls. */
+export interface MeetingsMembers {
+  acknowledgeMeetingReview: "acknowledge_meeting_review_meeting_transcripts__transcript_id__review_acknowledge_post";
+  advanceDealStage: "advance_deal_stage_deals__deal_id__advance_stage_post";
+  deleteMeetingTranscript: "delete_meeting_transcript_meeting_transcripts__transcript_id__delete";
+  draftMeetingFollowUp: "draft_meeting_follow_up_meeting_transcripts__transcript_id__follow_up_draft_post";
+  getDealMemory: "get_deal_memory_deals__deal_id__memory_get";
+  getDealStageReadiness: "get_deal_stage_readiness_deals__deal_id__stage_readiness_get";
+  getMeeting: "get_meeting_inbox_meetings__meeting_id__get";
+  getMeetingCoachingQueue: "get_meeting_coaching_queue_meeting_transcripts_coaching_queue_get";
+  getMeetingReview: "get_meeting_review_meeting_transcripts__transcript_id__review_get";
+  getMeetingTranscript: "get_meeting_transcript_meeting_transcripts__transcript_id__get";
+  getMeetingTranscriptStats: "get_meeting_transcript_stats_meeting_transcripts_stats_get";
+  linkMeetingTranscriptAccount: "link_meeting_transcript_account_meeting_transcripts__transcript_id__account_patch";
+  listMeetingTranscripts: "list_meeting_transcripts_meeting_transcripts_get";
+  listMeetings: "list_meetings_inbox_meetings_get";
+  meetingsBooked: "meetings_booked_inbox_meetings_booked_get";
+  regenerateMeetingReview: "regenerate_meeting_review_meeting_transcripts__transcript_id__review_regenerate_post";
+  suggestDealNextBestStep: "suggest_deal_next_best_step_deals__deal_id__next_best_step_post";
+}
+
+/** Input and output of every `g8.api.meetings` operation, keyed by operationId. */
+export interface MeetingsOperations {
+  /**
+   * POST /meeting-transcripts/{transcript_id}/review/acknowledge
+   * Acknowledge Meeting Review
+   * tier: write · scope: meetings:write
+   */
+  acknowledge_meeting_review_meeting_transcripts__transcript_id__review_acknowledge_post: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /deals/{deal_id}/advance-stage
+   * Advance Deal Stage
+   * tier: write · scope: meetings:write
+   */
+  advance_deal_stage_deals__deal_id__advance_stage_post: {
+    input: {
+    path: {
+      /** Deal id (UUID). */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * DELETE /meeting-transcripts/{transcript_id}
+   * Delete Meeting Transcript
+   * tier: destructive · scope: meetings:delete
+   */
+  delete_meeting_transcript_meeting_transcripts__transcript_id__delete: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /meeting-transcripts/{transcript_id}/follow-up-draft
+   * Draft Meeting Follow Up
+   * tier: billable · scope: meetings:run
+   */
+  draft_meeting_follow_up_meeting_transcripts__transcript_id__follow_up_draft_post: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    query?: {
+      /** Write a fresh draft even when one is stored. SPENDS CREDITS. */
+      regenerate?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /deals/{deal_id}/memory
+   * Get Deal Memory
+   * tier: read · scope: meetings:read
+   */
+  get_deal_memory_deals__deal_id__memory_get: {
+    input: {
+    path: {
+      /** Deal id (UUID). */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /deals/{deal_id}/stage-readiness
+   * Get Deal Stage Readiness
+   * tier: read · scope: meetings:read
+   */
+  get_deal_stage_readiness_deals__deal_id__stage_readiness_get: {
+    input: {
+    path: {
+      /** Deal id (UUID). */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /inbox/meetings/{meeting_id}
+   * Get Meeting
+   * tier: read · scope: meetings:read
+   */
+  get_meeting_inbox_meetings__meeting_id__get: {
+    input: {
+    path: {
+      /** Meeting ID (CalendarEvent.id) */
+      meeting_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MeetingDetail_;
+  };
+  /**
+   * GET /meeting-transcripts/coaching-queue
+   * Get Meeting Coaching Queue
+   * tier: read · scope: meetings:read
+   */
+  get_meeting_coaching_queue_meeting_transcripts_coaching_queue_get: {
+    input: {
+    query?: {
+      /** Only reviews for this pipeline target. */
+      target?: string | null;
+      /** Only reviews no manager has acknowledged. */
+      only_unreviewed?: boolean;
+      /** Lowest review score to include. */
+      min_score?: number;
+      /** Highest review score to include. */
+      max_score?: number;
+      /** How many reviews. */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /meeting-transcripts/{transcript_id}/review
+   * Get Meeting Review
+   * tier: read · scope: meetings:read
+   */
+  get_meeting_review_meeting_transcripts__transcript_id__review_get: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /meeting-transcripts/{transcript_id}
+   * Get Meeting Transcript
+   * tier: read · scope: meetings:read
+   */
+  get_meeting_transcript_meeting_transcripts__transcript_id__get: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /meeting-transcripts/stats
+   * Get Meeting Transcript Stats
+   * tier: read · scope: meetings:read
+   */
+  get_meeting_transcript_stats_meeting_transcripts_stats_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * PATCH /meeting-transcripts/{transcript_id}/account
+   * Link Meeting Transcript Account
+   * tier: write · scope: meetings:write
+   */
+  link_meeting_transcript_account_meeting_transcripts__transcript_id__account_patch: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LinkTranscriptAccountRequest;
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /meeting-transcripts
+   * List Meeting Transcripts
+   * tier: read · scope: meetings:read
+   */
+  list_meeting_transcripts_meeting_transcripts_get: {
+    input: {
+    query?: {
+      /** `account`, `client` or `internal`. */
+      transcript_type?: string | null;
+      /** Only transcripts filed under this account. */
+      account_id?: string | null;
+      /** Earliest meeting date. */
+      date_from?: string | null;
+      /** Latest meeting date. */
+      date_to?: string | null;
+      /** Match in the title or the transcript text. */
+      search?: string | null;
+      /** Page size. */
+      limit?: number;
+      /** Rows to skip. */
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * GET /inbox/meetings
+   * List Meetings
+   * tier: read · scope: meetings:read
+   */
+  list_meetings_inbox_meetings_get: {
+    input: {
+    query?: {
+      /** Filter to meetings where ANY of the provided emails appears as organizer, owner, or attendee (case-insensitive, OR-matched). Repeat the param for multiple emails. */
+      participant_email?: Array<string> | null;
+      /** Visibility scope: 'my' (your meetings) or 'all' (org-wide, requires meetings:see_all) */
+      scope?: string | null;
+      /** 'all', 'upcoming', or 'past' (default: past) */
+      timeframe?: string | null;
+      /** True = transcript linked; False = no transcript */
+      has_transcript?: boolean | null;
+      /** Internal meeting visibility. 'include_internal' returns ALL meetings (team syncs, internal-only attendees). 'exclude_internal' drops any meeting with no external attendees. Omitting respects the org policy default (most orgs default to exclude_internal). Pass include_internal to see team/standup meetings the default would hide. */
+      internal_mode?: string | null;
+      /** Match title or transcript text */
+      search?: string | null;
+      /** Page number */
+      page?: number;
+      /** Items per page */
+      page_size?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_MeetingSummary__;
+  };
+  /**
+   * GET /inbox/meetings/booked
+   * Meetings Booked
+   * tier: read · scope: meetings:read
+   */
+  meetings_booked_inbox_meetings_booked_get: {
+    input: {
+    query?: {
+      /** Lookback window in days */
+      days?: number;
+      /** Max meetings per page */
+      limit?: number;
+      /** 1-based page over the booked list */
+      page?: number;
+      /** Only meetings from now forward */
+      upcoming_only?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_MeetingsBookedResult_;
+  };
+  /**
+   * POST /meeting-transcripts/{transcript_id}/review/regenerate
+   * Regenerate Meeting Review
+   * tier: billable · scope: meetings:run
+   */
+  regenerate_meeting_review_meeting_transcripts__transcript_id__review_regenerate_post: {
+    input: {
+    path: {
+      /** Transcript id. */
+      transcript_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+  /**
+   * POST /deals/{deal_id}/next-best-step
+   * Suggest Deal Next Best Step
+   * tier: billable · scope: meetings:run
+   */
+  suggest_deal_next_best_step_deals__deal_id__next_best_step_post: {
+    input: {
+    path: {
+      /** Deal id (UUID). */
+      deal_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CrmRecordPayload_;
+  };
+}
+
+// 12 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_CrmRecordPayload_ {
+  data: CrmRecordPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MeetingDetail_ {
+  data: MeetingDetail;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_MeetingsBookedResult_ {
+  data: MeetingsBookedResult;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_MeetingSummary__ {
+  data: Array<MeetingSummary>;
+  pagination?: PaginationMeta | null;
+}
+
+/** One booked calendar meeting (non-cancelled, non-private). */
+export interface BookedMeeting {
+  /** Attendee count */
+  attendees?: number;
+  end_time?: string | null;
+  id: number;
+  organizer?: string | null;
+  start_time?: string | null;
+  status?: string | null;
+  title?: string | null;
+}
+
+/**
+ * An open envelope for one record, one dashboard or one job receipt.
+ *
+ * Open because most of these reads are COMPUTED shapes - an engagement
+ * summary, a next-best-step, an intelligence status - that grow with the
+ * product, and dropping a field from an advisory read makes it say "nothing
+ * to report" rather than "we did not tell you".
+ */
+export type CrmRecordPayload = Record<string, unknown>;
+
+/** Mirrors `meeting_transcripts.LinkAccountRequest`. */
+export interface LinkTranscriptAccountRequest {
+  /** Account (company) to file the transcript under. */
+  account_id: string;
+}
+
+/** Lightweight attendee record on a meeting. */
+export interface MeetingAttendee {
+  email?: string | null;
+  name?: string | null;
+  /** True when this attendee is the meeting organizer */
+  organizer?: boolean | null;
+  /** Provider-reported RSVP: accepted, declined, tentative, needsAction */
+  response_status?: string | null;
+}
+
+/**
+ * Full meeting record returned by the detail endpoint.
+ *
+ * Bundles transcript text + structured extractions inline so a single
+ * call returns everything a UI needs to render the meeting view. When
+ * the caller lacks `meetings:see_transcripts` permission and is not a
+ * participant, `transcript_redacted=true` and transcript content is
+ * omitted (status / IDs still returned).
+ */
+export interface MeetingDetail {
+  action_items?: Array<Record<string, unknown>> | null;
+  assignees?: Array<Record<string, unknown>>;
+  attendees?: Array<MeetingAttendee>;
+  audience_type?: string | null;
+  campaign_mentions?: Array<string> | null;
+  channel?: string;
+  created_at?: string | null;
+  custom_fields?: Array<Record<string, unknown>> | null;
+  end_time?: string | null;
+  id: string;
+  is_internal_only?: boolean | null;
+  key_topics?: Array<string> | null;
+  matched_account?: Record<string, unknown> | null;
+  meeting_sensitivity?: string | null;
+  /** CRM tasks created from transcript action items */
+  meeting_tasks?: Array<Record<string, unknown>> | null;
+  meeting_url?: string | null;
+  organizer_email?: string | null;
+  organizer_team_member?: Record<string, unknown> | null;
+  owner_team_member?: Record<string, unknown> | null;
+  participant_links?: Array<Record<string, unknown>> | null;
+  start_time?: string | null;
+  subject?: string | null;
+  tags?: Array<Record<string, unknown>>;
+  transcript_id?: string | null;
+  transcript_link_source?: string | null;
+  transcript_redacted?: boolean;
+  transcript_source?: string | null;
+  transcript_status?: string | null;
+  transcript_summary?: string | null;
+  /** Full transcript body text (omitted when redacted) */
+  transcript_text?: string | null;
+  updated_at?: string | null;
+  user_email?: string | null;
+}
+
+/**
+ * Card-level meeting record returned by the list endpoint.
+ *
+ * Mirrors the UnifiedChannelItem meeting fields most clients need to
+ * render a meeting list (cards / table rows). The transcript preview
+ * is included as `transcript_summary`; full body text is only returned
+ * by the detail endpoint to keep list payloads small.
+ */
+export interface MeetingSummary {
+  assignees?: Array<Record<string, unknown>>;
+  attendees?: Array<MeetingAttendee>;
+  /** customer, prospect, internal, or unknown */
+  audience_type?: string | null;
+  channel?: string;
+  created_at?: string | null;
+  end_time?: string | null;
+  id: string;
+  is_internal_only?: boolean | null;
+  matched_account?: Record<string, unknown> | null;
+  meeting_sensitivity?: string | null;
+  meeting_url?: string | null;
+  organizer_email?: string | null;
+  /** Short conversational summary for inbox-card rendering */
+  preview?: string | null;
+  start_time?: string | null;
+  /** Meeting title */
+  subject?: string | null;
+  tags?: Array<Record<string, unknown>>;
+  transcript_id?: string | null;
+  /** True when transcript content is hidden due to lack of permissions */
+  transcript_redacted?: boolean;
+  transcript_source?: string | null;
+  /** linked, missing, or no_transcript_expected */
+  transcript_status?: string | null;
+  /** Short transcript summary (preview only) */
+  transcript_summary?: string | null;
+  updated_at?: string | null;
+  /** Calendar owner email (the user this meeting belongs to) */
+  user_email?: string | null;
+}
+
+export interface MeetingsBookedResult {
+  /** Total booked meetings in the window */
+  count?: number;
+  days: number;
+  /** Whether another page exists */
+  has_next?: boolean;
+  meetings?: Array<BookedMeeting>;
+  /** 1-based page of the booked list */
+  page?: number;
+  upcoming_only?: boolean;
+}
+
+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;
+}