@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/salesCoach.d.ts

@@ -0,0 +1,877 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.salesCoach` (Sales Coach): 37 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"add_interview_member_sales_coach_interviews__interview_id__members_post">;
+ *
+ * Reference with examples: salesCoach.md
+ */
+/* eslint-disable */
+
+/** `g8.api.salesCoach.<member>` -> the operationId it calls. */
+export interface SalesCoachMembers {
+  addInterviewMember: "add_interview_member_sales_coach_interviews__interview_id__members_post";
+  assignTeamRole: "assign_team_role_sales_coach_team_users__user_id__role_put";
+  createCall: "create_call_sales_coach_calls_post";
+  createInterview: "create_interview_sales_coach_interviews_post";
+  createInterviewAttempt: "create_interview_attempt_sales_coach_interview_attempts_post";
+  createInterviewAttemptByCode: "create_interview_attempt_by_code_sales_coach_interview_attempts_by_code__code__post";
+  createTeamLeaderboard: "create_team_leaderboard_sales_coach_team_leaderboards_post";
+  createTeamSet: "create_team_set_sales_coach_team_sets_post";
+  deleteCall: "delete_call_sales_coach_calls__call_id__delete";
+  deleteInterview: "delete_interview_sales_coach_interviews__interview_id__delete";
+  deleteTeamLeaderboard: "delete_team_leaderboard_sales_coach_team_leaderboards__lb_id__delete";
+  deleteTeamSet: "delete_team_set_sales_coach_team_sets__set_id__delete";
+  getCall: "get_call_sales_coach_calls__call_id__get";
+  getCallAudioUrl: "get_call_audio_url_sales_coach_calls__call_id__audio_url_get";
+  getCallTranscript: "get_call_transcript_sales_coach_calls__call_id__transcript_get";
+  getInterview: "get_interview_sales_coach_interviews__interview_id__get";
+  getInterviewByCode: "get_interview_by_code_sales_coach_interviews_by_code__code__get";
+  getSalesCoachLeaderboard: "get_sales_coach_leaderboard_sales_coach_leaderboard_get";
+  getTeamActiveUsersSummary: "get_team_active_users_summary_sales_coach_team_active_users_summary_get";
+  getTeamBootstrap: "get_team_bootstrap_sales_coach_team_bootstrap_get";
+  getTeamConfig: "get_team_config_sales_coach_team_config_get";
+  getTeamKpiCatalog: "get_team_kpi_catalog_sales_coach_team_kpi_catalog_get";
+  getTeamLeaderboardData: "get_team_leaderboard_data_sales_coach_team_leaderboards__lb_id__data_get";
+  getTeamSetData: "get_team_set_data_sales_coach_team_sets__set_id__data_get";
+  listCalls: "list_calls_sales_coach_calls_get";
+  listCoachContactLists: "list_coach_contact_lists_sales_coach_contact_lists_get";
+  listInterviewAttempts: "list_interview_attempts_sales_coach_interview_attempts_get";
+  listInterviews: "list_interviews_sales_coach_interviews_get";
+  listTeamLeaderboards: "list_team_leaderboards_sales_coach_team_leaderboards_get";
+  listTeamRoles: "list_team_roles_sales_coach_team_roles_get";
+  listTeamSets: "list_team_sets_sales_coach_team_sets_get";
+  searchCoachProspects: "search_coach_prospects_sales_coach_prospects_search_get";
+  sendInterviewInvite: "send_interview_invite_sales_coach_interviews__interview_id__members__member_id__send_invite_post";
+  updateCall: "update_call_sales_coach_calls__call_id__put";
+  updateTeamConfig: "update_team_config_sales_coach_team_config_put";
+  updateTeamLeaderboard: "update_team_leaderboard_sales_coach_team_leaderboards__lb_id__put";
+  updateTeamSet: "update_team_set_sales_coach_team_sets__set_id__put";
+}
+
+/** Input and output of every `g8.api.salesCoach` operation, keyed by operationId. */
+export interface SalesCoachOperations {
+  /**
+   * POST /sales-coach/interviews/{interview_id}/members
+   * Add Interview Member
+   * tier: external · scope: team:run
+   */
+  add_interview_member_sales_coach_interviews__interview_id__members_post: {
+    input: {
+    path: {
+      /** Interview round id (UUID). */
+      interview_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AddInterviewMemberRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * PUT /sales-coach/team/users/{user_id}/role
+   * Assign Team Role
+   * tier: destructive · scope: team:delete
+   */
+  assign_team_role_sales_coach_team_users__user_id__role_put: {
+    input: {
+    path: {
+      /** The member to re-role. */
+      user_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AssignTeamRoleRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * POST /sales-coach/calls
+   * Create Call
+   * tier: write · scope: team:write
+   */
+  create_call_sales_coach_calls_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateCallRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * POST /sales-coach/interviews
+   * Create Interview
+   * tier: write · scope: team:write
+   */
+  create_interview_sales_coach_interviews_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateInterviewRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * POST /sales-coach/interview-attempts
+   * Create Interview Attempt
+   * tier: write · scope: team:write
+   */
+  create_interview_attempt_sales_coach_interview_attempts_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateInterviewAttemptRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * POST /sales-coach/interview-attempts/by-code/{code}
+   * Create Interview Attempt By Code
+   * tier: write · scope: team:write
+   */
+  create_interview_attempt_by_code_sales_coach_interview_attempts_by_code__code__post: {
+    input: {
+    path: {
+      /** The member's invite code. Matched case-insensitively. */
+      code: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CreateInterviewAttemptByCodeRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * POST /sales-coach/team/leaderboards
+   * Create Team Leaderboard
+   * tier: write · scope: team:write
+   */
+  create_team_leaderboard_sales_coach_team_leaderboards_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LeaderboardConfigRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * POST /sales-coach/team/sets
+   * Create Team Set
+   * tier: write · scope: team:write
+   */
+  create_team_set_sales_coach_team_sets_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SetConfigRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * DELETE /sales-coach/calls/{call_id}
+   * Delete Call
+   * tier: destructive · scope: team:delete
+   */
+  delete_call_sales_coach_calls__call_id__delete: {
+    input: {
+    path: {
+      /** Call id (UUID). */
+      call_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * DELETE /sales-coach/interviews/{interview_id}
+   * Delete Interview
+   * tier: destructive · scope: team:delete
+   */
+  delete_interview_sales_coach_interviews__interview_id__delete: {
+    input: {
+    path: {
+      /** Interview round id (UUID). */
+      interview_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * DELETE /sales-coach/team/leaderboards/{lb_id}
+   * Delete Team Leaderboard
+   * tier: destructive · scope: team:delete
+   */
+  delete_team_leaderboard_sales_coach_team_leaderboards__lb_id__delete: {
+    input: {
+    path: {
+      /** Leaderboard id. */
+      lb_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * DELETE /sales-coach/team/sets/{set_id}
+   * Delete Team Set
+   * tier: destructive · scope: team:delete
+   */
+  delete_team_set_sales_coach_team_sets__set_id__delete: {
+    input: {
+    path: {
+      /** Set id. */
+      set_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/calls/{call_id}
+   * Get Call
+   * tier: read · scope: team:read
+   */
+  get_call_sales_coach_calls__call_id__get: {
+    input: {
+    path: {
+      /** Call id (UUID). */
+      call_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * GET /sales-coach/calls/{call_id}/audio-url
+   * Get Call Audio Url
+   * tier: read · scope: team:read
+   */
+  get_call_audio_url_sales_coach_calls__call_id__audio_url_get: {
+    input: {
+    path: {
+      /** Call id (UUID). */
+      call_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * GET /sales-coach/calls/{call_id}/transcript
+   * Get Call Transcript
+   * tier: read · scope: team:read
+   */
+  get_call_transcript_sales_coach_calls__call_id__transcript_get: {
+    input: {
+    path: {
+      /** Call id (UUID). */
+      call_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * GET /sales-coach/interviews/{interview_id}
+   * Get Interview
+   * tier: read · scope: team:read
+   */
+  get_interview_sales_coach_interviews__interview_id__get: {
+    input: {
+    path: {
+      /** Interview round id (UUID). */
+      interview_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * GET /sales-coach/interviews/by-code/{code}
+   * Get Interview By Code
+   * tier: read · scope: team:read
+   */
+  get_interview_by_code_sales_coach_interviews_by_code__code__get: {
+    input: {
+    path: {
+      /** A member's invite code. */
+      code: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * GET /sales-coach/leaderboard
+   * Get Sales Coach Leaderboard
+   * tier: read · scope: team:read
+   */
+  get_sales_coach_leaderboard_sales_coach_leaderboard_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamListPayload_;
+  };
+  /**
+   * GET /sales-coach/team/active-users-summary
+   * Get Team Active Users Summary
+   * tier: read · scope: team:read
+   */
+  get_team_active_users_summary_sales_coach_team_active_users_summary_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/team/bootstrap
+   * Get Team Bootstrap
+   * tier: read · scope: team:read
+   */
+  get_team_bootstrap_sales_coach_team_bootstrap_get: {
+    input: {
+    query?: {
+      /** Window to score over. `today` is the app's default; the values a given org accepts come back in `visible_periods` from `GET /sales-coach/team/config`, because the set is configurable. */
+      period?: string;
+      /** Leaderboard to open on. */
+      lb?: string | null;
+      /** Rotation to open on. The wire name is `set`, matching the app's `?set=` query parameter; `set` is a Python builtin, so the handler parameter is `set_id` and the alias keeps the wire name identical to the app's. */
+      set?: string | null;
+      /** Legacy fallback when neither `lb` nor `set` is given. */
+      role?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/team/config
+   * Get Team Config
+   * tier: read · scope: team:read
+   */
+  get_team_config_sales_coach_team_config_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/team/kpi-catalog
+   * Get Team Kpi Catalog
+   * tier: read · scope: team:read
+   */
+  get_team_kpi_catalog_sales_coach_team_kpi_catalog_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamListPayload_;
+  };
+  /**
+   * GET /sales-coach/team/leaderboards/{lb_id}/data
+   * Get Team Leaderboard Data
+   * tier: read · scope: team:read
+   */
+  get_team_leaderboard_data_sales_coach_team_leaderboards__lb_id__data_get: {
+    input: {
+    path: {
+      /** Leaderboard id. */
+      lb_id: string;
+    };
+    query?: {
+      /** Window to score over. `today` is the app's default; the values a given org accepts come back in `visible_periods` from `GET /sales-coach/team/config`, because the set is configurable. */
+      period?: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/team/sets/{set_id}/data
+   * Get Team Set Data
+   * tier: read · scope: team:read
+   */
+  get_team_set_data_sales_coach_team_sets__set_id__data_get: {
+    input: {
+    path: {
+      /** Set id. */
+      set_id: string;
+    };
+    query?: {
+      /** Window to score over. `today` is the app's default; the values a given org accepts come back in `visible_periods` from `GET /sales-coach/team/config`, because the set is configurable. */
+      period?: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * GET /sales-coach/calls
+   * List Calls
+   * tier: read · scope: team:read
+   */
+  list_calls_sales_coach_calls_get: {
+    input: {
+    query?: {
+      /** Whose calls to read. Omit for the key owner's own. Naming SOMEBODY ELSE is manager-only and comes back 403 otherwise - calls carry transcripts and scores. */
+      email?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * GET /sales-coach/contact-lists
+   * List Coach Contact Lists
+   * tier: read · scope: team:read
+   */
+  list_coach_contact_lists_sales_coach_contact_lists_get: {
+    input: {
+    query?: {
+      /** Only lists tagged for coaching, rather than every audience. */
+      only_tagged?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * GET /sales-coach/interview-attempts
+   * List Interview Attempts
+   * tier: read · scope: team:read
+   */
+  list_interview_attempts_sales_coach_interview_attempts_get: {
+    input: {
+    query?: {
+      /** Only attempts made of this call. */
+      call_id?: string | null;
+      /** Only this member's attempts. */
+      member_id?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * GET /sales-coach/interviews
+   * List Interviews
+   * tier: read · scope: team:read
+   */
+  list_interviews_sales_coach_interviews_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * GET /sales-coach/team/leaderboards
+   * List Team Leaderboards
+   * tier: read · scope: team:read
+   */
+  list_team_leaderboards_sales_coach_team_leaderboards_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamListPayload_;
+  };
+  /**
+   * GET /sales-coach/team/roles
+   * List Team Roles
+   * tier: read · scope: team:read
+   */
+  list_team_roles_sales_coach_team_roles_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamListPayload_;
+  };
+  /**
+   * GET /sales-coach/team/sets
+   * List Team Sets
+   * tier: read · scope: team:read
+   */
+  list_team_sets_sales_coach_team_sets_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_TeamListPayload_;
+  };
+  /**
+   * GET /sales-coach/prospects/search
+   * Search Coach Prospects
+   * tier: read · scope: team:read
+   */
+  search_coach_prospects_sales_coach_prospects_search_get: {
+    input: {
+    query: {
+      /** Audience to search within. */
+      audience_id: string;
+      /** Free text over the prospect's name and company. */
+      q?: string;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachListPayload_;
+  };
+  /**
+   * POST /sales-coach/interviews/{interview_id}/members/{member_id}/send-invite
+   * Send Interview Invite
+   * tier: external · scope: team:run
+   */
+  send_interview_invite_sales_coach_interviews__interview_id__members__member_id__send_invite_post: {
+    input: {
+    path: {
+      /** Interview round id (UUID). */
+      interview_id: string;
+      /** Member id (UUID). */
+      member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * PUT /sales-coach/calls/{call_id}
+   * Update Call
+   * tier: write · scope: team:write
+   */
+  update_call_sales_coach_calls__call_id__put: {
+    input: {
+    path: {
+      /** Call id (UUID). */
+      call_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: UpdateCallRequest;
+  };
+    output: ApiResponse_CoachPayload_;
+  };
+  /**
+   * PUT /sales-coach/team/config
+   * Update Team Config
+   * tier: write · scope: team:write
+   */
+  update_team_config_sales_coach_team_config_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: TeamConfigUpdateRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * PUT /sales-coach/team/leaderboards/{lb_id}
+   * Update Team Leaderboard
+   * tier: write · scope: team:write
+   */
+  update_team_leaderboard_sales_coach_team_leaderboards__lb_id__put: {
+    input: {
+    path: {
+      /** Leaderboard id. */
+      lb_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: LeaderboardConfigRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+  /**
+   * PUT /sales-coach/team/sets/{set_id}
+   * Update Team Set
+   * tier: write · scope: team:write
+   */
+  update_team_set_sales_coach_team_sets__set_id__put: {
+    input: {
+    path: {
+      /** Set id. */
+      set_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SetConfigRequest;
+  };
+    output: ApiResponse_TeamPayload_;
+  };
+}
+
+// 21 schemas referenced above (the same as G8Contract.<Name>).
+
+/**
+ * Add someone to an interview round.
+ *
+ * `send_invite=true` EMAILS THAT PERSON immediately. It defaults to false, so
+ * adding a member is a plain write unless the caller asks for the mail.
+ */
+export interface AddInterviewMemberRequest {
+  email: string;
+  name: string;
+  /** Send the invite email now. TRUE REACHES A REAL PERSON. */
+  send_invite?: boolean;
+}
+
+export interface ApiResponse_CoachListPayload_ {
+  data: CoachListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_CoachPayload_ {
+  data: CoachPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_TeamListPayload_ {
+  data: TeamListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_TeamPayload_ {
+  data: TeamPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * Grant one Team HQ role to an existing member of the caller's org.
+ *
+ * A role REPLACES the person's whole permission set - `cb_user_roles` has a
+ * composite primary key on (user_id, org_id), so there is exactly one row per
+ * person per org. This is a privilege grant, not a label.
+ */
+export interface AssignTeamRoleRequest {
+  /** The role to grant. `admin` is not assignable here - it belongs to Settings -> Roles, behind the full RBAC admin gate. */
+  slug: "ae" | "sdr" | "csm" | "campaign_manager" | "sales_manager";
+}
+
+/** An open envelope for a LIST result, so a bare list keeps its shape. */
+export interface CoachListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** An open envelope for a call, an interview round or an attempt. */
+export type CoachPayload = Record<string, unknown>;
+
+/**
+ * Start a practice call record.
+ *
+ * `call_mode` is CLOSED to the app's two values. The app validates it in a
+ * field validator that raises inside the proxy rather than at the request
+ * boundary, so an open string here would be a 500 instead of a 422 naming
+ * both modes.
+ */
+export interface CreateCallRequest {
+  /** `compete` is the rep alone against the AI prospect; `assisted` is the coached variant. */
+  call_mode: "compete" | "assisted";
+  persona_type?: string | null;
+  prospect_company?: string | null;
+  prospect_name?: string | null;
+}
+
+/** Record an attempt identified by the member's invite CODE rather than their id. */
+export interface CreateInterviewAttemptByCodeRequest {
+  /** The practice call this attempt is made of. */
+  call_id: string;
+}
+
+/** Record an attempt at an interview round, against a call that already exists. */
+export interface CreateInterviewAttemptRequest {
+  /** The practice call this attempt is made of. */
+  call_id: string;
+  /** Which member attempted it. Omit for an unattributed attempt. */
+  member_id?: string | null;
+}
+
+/** Create an interview round - a scripted practice call a candidate is invited to. */
+export interface CreateInterviewRequest {
+  /** Audience the prospect is drawn from. */
+  audience_id: string;
+  /** How the AI prospect behaves. Free-form: the app does not close this set. */
+  behavior?: string;
+  /** How long an invite code stays valid. Omit for the app default of 14 days. */
+  code_ttl_days?: number | null;
+  /** How many times a member may try. */
+  max_attempts?: number;
+  /** What the round is called. */
+  name: string;
+  /** The contact the AI will play. */
+  prospect_id: string;
+  prospect_name?: string | null;
+}
+
+/**
+ * A leaderboard: who is on it, what it measures, and what it is aiming at.
+ *
+ * `id` is REQUIRED and client-supplied, matching the app - these are
+ * config rows keyed by a slug the caller chooses, not server-generated
+ * records. Sending an existing id through `POST` is how the app upserts.
+ */
+export interface LeaderboardConfigRequest {
+  goal?: LeaderboardGoal | null;
+  /** Caller-chosen id. Reusing one upserts, matching the app. */
+  id: string;
+  /** Marks a board the product ships rather than one a customer made. Accepted because the app's model has it; leave it False for your own boards. */
+  is_system?: boolean;
+  kpis: Array<LeaderboardKpi>;
+  name: string;
+  /** Which team roles appear on this board. */
+  roles: Array<string>;
+}
+
+/** The target a leaderboard is measured against. */
+export interface LeaderboardGoal {
+  metric: string;
+  period: string;
+  target: number;
+}
+
+/** One metric on a leaderboard, with its weight and visibility. */
+export interface LeaderboardKpi {
+  /** KPI id from `GET /sales-coach/team/kpi-catalog`. */
+  id: string;
+  visible?: boolean;
+  /** How much this KPI counts toward the ranking. */
+  weight: number;
+}
+
+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;
+}
+
+/** A ROTATION of leaderboards - what a wall display cycles through. */
+export interface SetConfigRequest {
+  /** Whether the display plays a sound on a change. */
+  audio_enabled?: boolean;
+  /** Caller-chosen id. */
+  id: string;
+  is_default?: boolean;
+  /** The boards to rotate through, in order. */
+  leaderboard_ids: Array<string>;
+  name: string;
+  /** Seconds per board. The app's default is 30. */
+  rotation_seconds?: number;
+}
+
+/**
+ * Team Command Center settings.
+ *
+ * OPEN (`extra="allow"`), mirroring the app's `TeamFloorConfigUpdate`, which
+ * carries the same and says in its own docstring that it is an INTENTIONAL
+ * deviation from the `extra="forbid"` rule its sibling JSONB endpoints
+ * follow. Closing it here would reject a key the app itself stores.
+ *
+ * Every field is optional; only what you send is written.
+ */
+export interface TeamConfigUpdateRequest {
+  default_period?: string | null;
+  goals?: Record<string, Record<string, unknown>> | null;
+  team_command_center_enabled?: boolean | null;
+  tv_rotation_seconds?: number | null;
+  visible_columns?: Record<string, Array<string>> | null;
+  visible_periods?: Array<string> | null;
+  [key: string]: unknown;
+}
+
+/** An open envelope for a LIST result, so a bare list keeps its shape. */
+export interface TeamListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * An open envelope for a config, a bootstrap or a data response.
+ *
+ * Open because the leaderboard and set DATA responses carry one key per KPI
+ * and the KPI catalogue is org-configurable: a closed model would drop a
+ * customer's own metric, and a leaderboard missing a column reads as a rep
+ * having scored nothing.
+ */
+export type TeamPayload = Record<string, unknown>;
+
+/** Amend a call record. Every field is optional and only what you send is written. */
+export interface UpdateCallRequest {
+  /** Where the recording lives. */
+  audio_url?: string | null;
+  /** New status for the call. */
+  call_status?: string | null;
+  /** Call length in milliseconds. */
+  duration_ms?: number | null;
+  /** Score for the call. */
+  final_score?: number | null;
+}