@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/orgGovernance.d.ts

@@ -0,0 +1,393 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.orgGovernance` (Org Governance): 17 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"assign_security_role_org_infrastructure_security_roles__role_id__put">;
+ *
+ * Reference with examples: orgGovernance.md
+ */
+/* eslint-disable */
+
+/** `g8.api.orgGovernance.<member>` -> the operationId it calls. */
+export interface OrgGovernanceMembers {
+  assignSecurityRole: "assign_security_role_org_infrastructure_security_roles__role_id__put";
+  blockAiConnection: "block_ai_connection_org_ai_connections__user_id__blocks_post";
+  deleteAiConnectionActivity: "delete_ai_connection_activity_org_ai_connections__user_id__activity_delete";
+  getAiConnectionSummary: "get_ai_connection_summary_org_ai_connections__user_id__summary_get";
+  getAiConnectionsConfig: "get_ai_connections_config_org_ai_connections_config_get";
+  getInfrastructureProfile: "get_infrastructure_profile_org_infrastructure_get";
+  getSuppressionSettings: "get_suppression_settings_org_suppression_settings_get";
+  listAiConnectionCalls: "list_ai_connection_calls_org_ai_connections__user_id__calls_get";
+  listAiConnections: "list_ai_connections_org_ai_connections_get";
+  listRepLimits: "list_rep_limits_org_rep_limits_get";
+  listSecurityRoles: "list_security_roles_org_infrastructure_security_roles_get";
+  resumeAiConnection: "resume_ai_connection_org_ai_connections__user_id__blocks_delete";
+  setRepLimitsOverride: "set_rep_limits_override_org_rep_limits__user_id__put";
+  unassignSecurityRole: "unassign_security_role_org_infrastructure_security_roles__role_id__delete";
+  updateAiConnectionsConfig: "update_ai_connections_config_org_ai_connections_config_put";
+  updateInfrastructureProfile: "update_infrastructure_profile_org_infrastructure_put";
+  updateSuppressionSettings: "update_suppression_settings_org_suppression_settings_put";
+}
+
+/** Input and output of every `g8.api.orgGovernance` operation, keyed by operationId. */
+export interface OrgGovernanceOperations {
+  /**
+   * PUT /org/infrastructure/security-roles/{role_id}
+   * Assign Security Role
+   * tier: write · scope: account:write
+   */
+  assign_security_role_org_infrastructure_security_roles__role_id__put: {
+    input: {
+    path: {
+      /** Security role id. */
+      role_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SecurityRoleAssignRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * POST /org/ai-connections/{user_id}/blocks
+   * Block Ai Connection
+   * tier: write · scope: account:write
+   */
+  block_ai_connection_org_ai_connections__user_id__blocks_post: {
+    input: {
+    path: {
+      /** The org member's user id. */
+      user_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AiConnectionBlockRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * DELETE /org/ai-connections/{user_id}/activity
+   * Delete Ai Connection Activity
+   * tier: destructive · scope: account:delete
+   */
+  delete_ai_connection_activity_org_ai_connections__user_id__activity_delete: {
+    input: {
+    path: {
+      /** The org member's user id. */
+      user_id: string;
+    };
+    query?: {
+      /** Only this client's records. */
+      client_key?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/ai-connections/{user_id}/summary
+   * Get Ai Connection Summary
+   * tier: read · scope: account:read
+   */
+  get_ai_connection_summary_org_ai_connections__user_id__summary_get: {
+    input: {
+    path: {
+      /** The org member's user id. */
+      user_id: string;
+    };
+    query?: {
+      /** Only this AI client. */
+      client_key?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/ai-connections/config
+   * Get Ai Connections Config
+   * tier: read · scope: account:read
+   */
+  get_ai_connections_config_org_ai_connections_config_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/infrastructure
+   * Get Infrastructure Profile
+   * tier: read · scope: account:read
+   */
+  get_infrastructure_profile_org_infrastructure_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/suppression-settings
+   * Get Suppression Settings
+   * tier: read · scope: account:read
+   */
+  get_suppression_settings_org_suppression_settings_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/ai-connections/{user_id}/calls
+   * List Ai Connection Calls
+   * tier: read · scope: account:read
+   */
+  list_ai_connection_calls_org_ai_connections__user_id__calls_get: {
+    input: {
+    path: {
+      /** The org member's user id. */
+      user_id: string;
+    };
+    query?: {
+      client_key?: string | null;
+      tool_name?: string | null;
+      status?: ("success" | "error") | null;
+      /** ISO timestamp, inclusive. */
+      from?: string | null;
+      /** ISO timestamp, exclusive. */
+      to?: string | null;
+      cursor?: string | null;
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/ai-connections
+   * List Ai Connections
+   * tier: read · scope: account:read
+   */
+  list_ai_connections_org_ai_connections_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/rep-limits
+   * List Rep Limits
+   * tier: read · scope: account:read
+   */
+  list_rep_limits_org_rep_limits_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * GET /org/infrastructure/security-roles
+   * List Security Roles
+   * tier: read · scope: account:read
+   */
+  list_security_roles_org_infrastructure_security_roles_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * DELETE /org/ai-connections/{user_id}/blocks
+   * Resume Ai Connection
+   * tier: destructive · scope: account:delete
+   */
+  resume_ai_connection_org_ai_connections__user_id__blocks_delete: {
+    input: {
+    path: {
+      /** The org member's user id. */
+      user_id: string;
+    };
+    query?: {
+      /** Only this client. Omit to lift every block. */
+      client_key?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * PUT /org/rep-limits/{user_id}
+   * Set Rep Limits Override
+   * tier: write · scope: account:write
+   */
+  set_rep_limits_override_org_rep_limits__user_id__put: {
+    input: {
+    path: {
+      /** The member's user id. */
+      user_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: RepLimitsOverrideRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * DELETE /org/infrastructure/security-roles/{role_id}
+   * Unassign Security Role
+   * tier: destructive · scope: account:delete
+   */
+  unassign_security_role_org_infrastructure_security_roles__role_id__delete: {
+    input: {
+    path: {
+      /** Security role id. */
+      role_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * PUT /org/ai-connections/config
+   * Update Ai Connections Config
+   * tier: write · scope: account:write
+   */
+  update_ai_connections_config_org_ai_connections_config_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: AiConnectionsConfigRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * PUT /org/infrastructure
+   * Update Infrastructure Profile
+   * tier: write · scope: account:write
+   */
+  update_infrastructure_profile_org_infrastructure_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: InfrastructureProfileUpdateRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+  /**
+   * PUT /org/suppression-settings
+   * Update Suppression Settings
+   * tier: write · scope: account:write
+   */
+  update_suppression_settings_org_suppression_settings_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SuppressionSettingsRequest;
+  };
+    output: ApiResponse_OrgGovernancePayload_;
+  };
+}
+
+// 10 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface AiConnectionBlockRequest {
+  /** Only this client. Omit to block every client. */
+  client_key?: string | null;
+  reason?: string | null;
+}
+
+export interface AiConnectionsConfigRequest {
+  /** Record call inputs/outputs, not just counts. */
+  capture_detail?: boolean;
+  retention_days?: 30 | 90 | 365;
+}
+
+export interface ApiResponse_OrgGovernancePayload_ {
+  data: OrgGovernancePayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface InfrastructureProfileUpdateRequest {
+  /** Category id -> selection. */
+  selections: Record<string, OrgInfrastructureSelection>;
+}
+
+/** A settings view or the result of a change, as the app returns it. */
+export type OrgGovernancePayload = Record<string, unknown>;
+
+export interface OrgInfrastructureSelection {
+  /** Used when `other` is among `provider_ids`. */
+  custom_name?: string | null;
+  notes?: string | null;
+  provider_ids?: Array<string> | 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;
+}
+
+export interface RepLimitsOverrideRequest {
+  /** Null = explicitly unlimited. */
+  max_companies?: number | null;
+  /** Null = explicitly unlimited. */
+  max_contacts?: number | null;
+  /** Null = explicitly unlimited. */
+  monthly_credit_budget?: number | null;
+  /** Delete the override; the role default applies again. */
+  reset?: boolean;
+}
+
+export interface SecurityRoleAssignRequest {
+  /** Must match the `role_id` in the path. */
+  role_id: string;
+  /** Team-member id or the person's user id. */
+  team_member_id: string;
+  /** Required when this creates the team member. */
+  user_email?: string | null;
+  /** Required when this creates the team member. */
+  user_name?: string | null;
+}
+
+export interface SuppressionSettingsRequest {
+  /** `channel`: an opt-out stays on its channel. `all`: it covers all outreach. */
+  contact_optout_scope: "channel" | "all";
+}