@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/profile.d.ts

@@ -0,0 +1,329 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.profile` (Profile): 14 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_available_mcp_tools_profile_mcp_tools_get">;
+ *
+ * Reference with examples: profile.md
+ */
+/* eslint-disable */
+
+/** `g8.api.profile.<member>` -> the operationId it calls. */
+export interface ProfileMembers {
+  getAvailableMcpTools: "get_available_mcp_tools_profile_mcp_tools_get";
+  getDealAutomations: "get_deal_automations_profile_deal_automations_get";
+  getMcpConnectionStatus: "get_mcp_connection_status_profile_mcp_status_get";
+  getMcpUsageStats: "get_mcp_usage_stats_profile_mcp_usage_get";
+  getNotificationPreferences: "get_notification_preferences_profile_notification_preferences_get";
+  getPipelineDealHints: "get_pipeline_deal_hints_profile_deal_automations_pipeline_hints_get";
+  getPreferences: "get_preferences_profile_preferences_get";
+  listMcpSessions: "list_mcp_sessions_profile_mcp_sessions_get";
+  revokeMcpSession: "revoke_mcp_session_profile_mcp_sessions__session_id__delete";
+  syncMyCalendarNow: "sync_my_calendar_now_profile_deal_automations_sync_now_post";
+  updateDealAutomations: "update_deal_automations_profile_deal_automations_put";
+  updateNotificationPreference: "update_notification_preference_profile_notification_preferences_put";
+  updatePreferences: "update_preferences_profile_preferences_put";
+  uploadProfileAvatar: "upload_profile_avatar_profile_avatar_post";
+}
+
+/** Input and output of every `g8.api.profile` operation, keyed by operationId. */
+export interface ProfileOperations {
+  /**
+   * GET /profile/mcp/tools
+   * Get Available Mcp Tools
+   * tier: read · scope: account:read
+   */
+  get_available_mcp_tools_profile_mcp_tools_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/deal-automations
+   * Get Deal Automations
+   * tier: read · scope: account:read
+   */
+  get_deal_automations_profile_deal_automations_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/mcp/status
+   * Get Mcp Connection Status
+   * tier: read · scope: account:read
+   */
+  get_mcp_connection_status_profile_mcp_status_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/mcp/usage
+   * Get Mcp Usage Stats
+   * tier: read · scope: account:read
+   */
+  get_mcp_usage_stats_profile_mcp_usage_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/notification-preferences
+   * Get Notification Preferences
+   * tier: read · scope: account:read
+   */
+  get_notification_preferences_profile_notification_preferences_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/deal-automations/pipeline-hints
+   * Get Pipeline Deal Hints
+   * tier: read · scope: account:read
+   */
+  get_pipeline_deal_hints_profile_deal_automations_pipeline_hints_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/preferences
+   * Get Preferences
+   * tier: read · scope: account:read
+   */
+  get_preferences_profile_preferences_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /profile/mcp/sessions
+   * List Mcp Sessions
+   * tier: read · scope: account:read
+   */
+  list_mcp_sessions_profile_mcp_sessions_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * DELETE /profile/mcp/sessions/{session_id}
+   * Revoke Mcp Session
+   * tier: destructive · scope: account:delete
+   */
+  revoke_mcp_session_profile_mcp_sessions__session_id__delete: {
+    input: {
+    path: {
+      /** MCP session id, from `GET /profile/mcp/sessions`. */
+      session_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /profile/deal-automations/sync-now
+   * Sync My Calendar Now
+   * tier: external · scope: integrations:run
+   */
+  sync_my_calendar_now_profile_deal_automations_sync_now_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PUT /profile/deal-automations
+   * Update Deal Automations
+   * tier: write · scope: account:write
+   */
+  update_deal_automations_profile_deal_automations_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProfileDealAutomationsUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PUT /profile/notification-preferences
+   * Update Notification Preference
+   * tier: write · scope: account:write
+   */
+  update_notification_preference_profile_notification_preferences_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProfileNotificationPreferenceUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PUT /profile/preferences
+   * Update Preferences
+   * tier: write · scope: account:write
+   */
+  update_preferences_profile_preferences_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: ProfilePreferencesUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /profile/avatar
+   * Upload Profile Avatar
+   * tier: write · scope: account:write
+   */
+  upload_profile_avatar_profile_avatar_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+}
+
+// 7 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_OrgPayload_ {
+  data: OrgPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/**
+ * An open envelope for a single role, team, member or account record.
+ *
+ * Open on purpose. The app's own response models on this surface grow with
+ * the product - `RoleResponse` gained `rep_limits` and `manages_role_slugs`,
+ * `TeamResponse` gained channel counts and a campaign count - and a pinned
+ * mirror would SILENTLY DROP whatever it had not caught up on. A dropped
+ * permission in a role read is the worst possible kind of stale: it reads as
+ * "they do not have it".
+ */
+export type OrgPayload = Record<string, unknown>;
+
+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;
+}
+
+/**
+ * Mirrors `user_profile.DealAutomationsUpdateRequest`.
+ *
+ * `sync_interval_minutes` is closed to `SYNC_INTERVAL_CHOICES`. The app's own
+ * validator raises a ValueError for anything else, which - raised while the
+ * proxy builds the app model - would escape as a 500.
+ */
+export interface ProfileDealAutomationsUpdateRequest {
+  /** Rules per pipeline id. Only the pipelines sent are changed; the others, and other people's rules, are never touched. */
+  pipelines?: Record<string, ProfilePipelineAutomationBlock> | null;
+  /** How often the calendar is pulled, in minutes. */
+  sync_interval_minutes?: (10 | 30 | 60 | 180 | 360 | 1440) | null;
+}
+
+/**
+ * Mirrors `user_profile.NotificationPreferenceUpdateRequest`.
+ *
+ * Updates ONE event type per call - `event_type` is required and names it.
+ * `routing` and `urgency` are closed to the app's `VALID_ROUTING` /
+ * `VALID_URGENCY` vocabulary (a parity test pins them).
+ */
+export interface ProfileNotificationPreferenceUpdateRequest {
+  bridge_email?: boolean | null;
+  bridge_imessage?: boolean | null;
+  bridge_roam?: boolean | null;
+  bridge_slack?: boolean | null;
+  bridge_whatsapp?: boolean | null;
+  copilot_bridge?: boolean | null;
+  copilot_proactive?: boolean | null;
+  enabled?: boolean | null;
+  /** The event to configure, as listed by `GET /profile/notification-preferences`. An unknown one is refused with the valid list. */
+  event_type: string;
+  hot_override?: boolean | null;
+  routing?: ("conversation" | "notify_only" | "off") | null;
+  urgency?: ("interrupt_now" | "fold_into_brief") | null;
+}
+
+/**
+ * Mirrors `user_profile.PipelineAutomationBlock`.
+ *
+ * `dry_run` is the safety switch: with it on, the automation reports what it
+ * WOULD do and creates nothing.
+ */
+export interface ProfilePipelineAutomationBlock {
+  auto_advance_deal_on_quote_send?: boolean;
+  auto_close_deal_on_acceptance?: boolean;
+  auto_draft_quote?: boolean;
+  dry_run?: boolean;
+  enabled?: boolean;
+  generate_scope_of_work?: boolean;
+  /** Meeting-title keywords that count. At most 10; each is trimmed to 100 characters and duplicates are dropped case-insensitively. */
+  title_keywords?: Array<string>;
+}
+
+/**
+ * Mirrors `user_profile.PreferencesUpdateRequest`.
+ *
+ * Every field optional; omitted fields are left alone.
+ */
+export interface ProfilePreferencesUpdateRequest {
+  default_view?: string | null;
+  locale?: string | null;
+  mcp_default_client?: string | null;
+  /** An id from `GET /profile/mcp/tools` (a `groups[].value` or a `toolboxes[].id`). Anything else is a 422 that lists the valid ids. */
+  mcp_tool_group?: string | null;
+  mcp_widgets_enabled?: boolean | null;
+  notifications_email?: boolean | null;
+  notifications_in_app?: boolean | null;
+  notifications_slack?: boolean | null;
+  theme?: string | null;
+  timezone?: string | null;
+  whatsapp_number?: string | null;
+}