@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/teamMembers.d.ts

@@ -0,0 +1,668 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.teamMembers` (Team members): 21 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"clone_team_member_team_members__team_member_id__clone_post">;
+ *
+ * Reference with examples: teamMembers.md
+ */
+/* eslint-disable */
+
+/** `g8.api.teamMembers.<member>` -> the operationId it calls. */
+export interface TeamMembersMembers {
+  cloneTeamMember: "clone_team_member_team_members__team_member_id__clone_post";
+  createTeamMember: "create_team_member_team_members_post";
+  createTeamMemberNote: "create_team_member_note_team_members__team_member_id__notes_post";
+  deleteTeamMember: "delete_team_member_team_members__team_member_id__delete";
+  deleteTeamMemberNote: "delete_team_member_note_team_members__team_member_id__notes__note_id__delete";
+  enrichMyProfileFromLinkedin: "enrich_my_profile_from_linkedin_team_members_me_enrich_linkedin_post";
+  enrichTeamMemberFromLinkedin: "enrich_team_member_from_linkedin_team_members__team_member_id__enrich_linkedin_post";
+  generateMemberPost: "generate_member_post_team_members__team_member_id__generate_post_post";
+  getMyTeamMember: "get_my_team_member_team_members_me_get";
+  getTeamMember: "get_team_member_team_members__team_member_id__get";
+  getTeamMemberCompanies: "get_team_member_companies_team_members__team_member_id__companies_get";
+  getTeamMemberContent: "get_team_member_content_team_members__team_member_id__content_get";
+  getTeamMemberDeals: "get_team_member_deals_team_members__team_member_id__deals_get";
+  importMySocialProfile: "import_my_social_profile_team_members_me_import_social_post";
+  listTeamMemberNotes: "list_team_member_notes_team_members__team_member_id__notes_get";
+  listTeamMembers: "list_team_members_team_members_get";
+  syncMyDesktopProfile: "sync_my_desktop_profile_team_members_me_sync_desktop_profile_post";
+  syncTeamMembers: "sync_team_members_team_members_sync_post";
+  updateMyTeamMember: "update_my_team_member_team_members_me_patch";
+  updateTeamMember: "update_team_member_team_members__team_member_id__patch";
+  updateTeamMemberNote: "update_team_member_note_team_members__team_member_id__notes__note_id__put";
+}
+
+/** Input and output of every `g8.api.teamMembers` operation, keyed by operationId. */
+export interface TeamMembersOperations {
+  /**
+   * POST /team-members/{team_member_id}/clone
+   * Clone Team Member
+   * tier: write · scope: team:write
+   */
+  clone_team_member_team_members__team_member_id__clone_post: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberCloneRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members
+   * Create Team Member
+   * tier: write · scope: team:write
+   */
+  create_team_member_team_members_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberCreateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members/{team_member_id}/notes
+   * Create Team Member Note
+   * tier: write · scope: team:write
+   */
+  create_team_member_note_team_members__team_member_id__notes_post: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberNoteCreateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * DELETE /team-members/{team_member_id}
+   * Delete Team Member
+   * tier: destructive · scope: team:delete
+   */
+  delete_team_member_team_members__team_member_id__delete: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * DELETE /team-members/{team_member_id}/notes/{note_id}
+   * Delete Team Member Note
+   * tier: destructive · scope: team:delete
+   */
+  delete_team_member_note_team_members__team_member_id__notes__note_id__delete: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+      /** Note id. */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members/me/enrich-linkedin
+   * Enrich My Profile From Linkedin
+   * tier: billable · scope: team:run
+   */
+  enrich_my_profile_from_linkedin_team_members_me_enrich_linkedin_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberLinkedInEnrichRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members/{team_member_id}/enrich-linkedin
+   * Enrich Team Member From Linkedin
+   * tier: billable · scope: team:run
+   */
+  enrich_team_member_from_linkedin_team_members__team_member_id__enrich_linkedin_post: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberLinkedInEnrichRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members/{team_member_id}/generate-post
+   * Generate Member Post
+   * tier: billable · scope: team:run
+   */
+  generate_member_post_team_members__team_member_id__generate_post_post: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /team-members/me
+   * Get My Team Member
+   * tier: read · scope: team:read
+   */
+  get_my_team_member_team_members_me_get: {
+    input: {
+    query?: {
+      /** Include the member's preferences blob. */
+      include_preferences?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /team-members/{team_member_id}
+   * Get Team Member
+   * tier: read · scope: team:read
+   */
+  get_team_member_team_members__team_member_id__get: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    query?: {
+      /** Include the member's preferences blob. */
+      include_preferences?: boolean;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /team-members/{team_member_id}/companies
+   * Get Team Member Companies
+   * tier: read · scope: team:read
+   */
+  get_team_member_companies_team_members__team_member_id__companies_get: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /team-members/{team_member_id}/content
+   * Get Team Member Content
+   * tier: read · scope: team:read
+   */
+  get_team_member_content_team_members__team_member_id__content_get: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /team-members/{team_member_id}/deals
+   * Get Team Member Deals
+   * tier: read · scope: team:read
+   */
+  get_team_member_deals_team_members__team_member_id__deals_get: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    query?: {
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * POST /team-members/me/import-social
+   * Import My Social Profile
+   * tier: write · scope: team:write
+   */
+  import_my_social_profile_team_members_me_import_social_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberSocialImportRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * GET /team-members/{team_member_id}/notes
+   * List Team Member Notes
+   * tier: read · scope: team:read
+   */
+  list_team_member_notes_team_members__team_member_id__notes_get: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * GET /team-members
+   * List Team Members
+   * tier: read · scope: team:read
+   */
+  list_team_members_team_members_get: {
+    input: {
+    query?: {
+      /** Filter by status. */
+      status?: string | null;
+      /** Filter by how the record was created: `propelauth`, `manual` or `clone`. */
+      source?: string | null;
+      /** Match on name or email. */
+      search?: string | null;
+      /** Include AI clone records. */
+      include_clones?: boolean;
+      /** Pull the identity provider's membership list before answering. Slower, and it WRITES: it creates a member row for anyone in the organisation who has none yet. */
+      sync?: boolean;
+      limit?: number;
+      offset?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgListPayload_;
+  };
+  /**
+   * POST /team-members/me/sync-desktop-profile
+   * Sync My Desktop Profile
+   * tier: write · scope: team:write
+   */
+  sync_my_desktop_profile_team_members_me_sync_desktop_profile_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberDesktopProfileSyncRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * POST /team-members/sync
+   * Sync Team Members
+   * tier: external · scope: team:run
+   */
+  sync_team_members_team_members_sync_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /team-members/me
+   * Update My Team Member
+   * tier: write · scope: team:write
+   */
+  update_my_team_member_team_members_me_patch: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PATCH /team-members/{team_member_id}
+   * Update Team Member
+   * tier: write · scope: team:write
+   */
+  update_team_member_team_members__team_member_id__patch: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+  /**
+   * PUT /team-members/{team_member_id}/notes/{note_id}
+   * Update Team Member Note
+   * tier: write · scope: team:write
+   */
+  update_team_member_note_team_members__team_member_id__notes__note_id__put: {
+    input: {
+    path: {
+      /** Team member id. */
+      team_member_id: string;
+      /** Note id. */
+      note_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: MemberNoteUpdateRequest;
+  };
+    output: ApiResponse_OrgPayload_;
+  };
+}
+
+// 19 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_OrgListPayload_ {
+  data: OrgListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_OrgPayload_ {
+  data: OrgPayload;
+  pagination?: PaginationMeta | null;
+}
+
+/** Mirrors `team_members.CloneRequest`. */
+export interface MemberCloneRequest {
+  /** Name for the clone. Defaults to '<Original Name> (AI Clone)'. */
+  name?: string | null;
+}
+
+/**
+ * Mirrors `team_members.TeamMemberCreateRequest`.
+ *
+ * `email` is an `EmailStr`, as the app's is. As a plain string a malformed
+ * address would pass this layer and fail the app model built inside the
+ * proxy - a bare ValidationError, which is a 500.
+ */
+export interface MemberCreateRequest {
+  /** Department. */
+  department?: string | null;
+  /** Email address. */
+  email?: string | null;
+  /** LinkedIn profile URL. */
+  linkedin_url?: string | null;
+  /** Full name. */
+  name: string;
+  /** Phone number. */
+  phone?: string | null;
+  /** Job title. */
+  title?: string | null;
+}
+
+/** Mirrors `team_members.DesktopEducationItem`. */
+export interface MemberDesktopEducationItem {
+  dates?: string | null;
+  degree?: string | null;
+  field?: string | null;
+  school?: string | null;
+}
+
+/** Mirrors `team_members.DesktopExperienceItem`. */
+export interface MemberDesktopExperienceItem {
+  company?: string | null;
+  companyUrl?: string | null;
+  /** `<start> - <end>`; an end of `Present` marks the current role. */
+  dates?: string | null;
+  description?: string | null;
+  duration?: string | null;
+  employment_type?: string | null;
+  location?: string | null;
+  title?: string | null;
+}
+
+/** Mirrors `team_members.DesktopInterestItem`. */
+export interface MemberDesktopInterestItem {
+  name: string;
+  type?: string | null;
+}
+
+/** Mirrors `team_members.DesktopProfileSyncRequest`, field for field. */
+export interface MemberDesktopProfileSyncRequest {
+  about?: string | null;
+  accomplishments_json?: Array<Record<string, unknown>> | null;
+  banner_photo_url?: string | null;
+  captured_at?: string | null;
+  connection_count?: number | null;
+  education_json?: Array<MemberDesktopEducationItem> | null;
+  experiences_json?: Array<MemberDesktopExperienceItem> | null;
+  first_name?: string | null;
+  follower_count?: number | null;
+  full_name?: string | null;
+  headline?: string | null;
+  interests_json?: Array<MemberDesktopInterestItem> | null;
+  is_hiring?: boolean | null;
+  is_open_to_work?: boolean | null;
+  last_name?: string | null;
+  linkedin_id?: string | null;
+  location?: string | null;
+  profile_photo_url?: string | null;
+  profile_url?: string | null;
+  recommendations_json?: Array<Record<string, unknown>> | null;
+  skills_json?: Array<MemberDesktopSkillItem> | null;
+}
+
+/** Mirrors `team_members.DesktopSkillItem`. */
+export interface MemberDesktopSkillItem {
+  endorsements?: number | null;
+  name: string;
+}
+
+/** Mirrors `team_members.JobHistoryItem`. */
+export interface MemberJobHistoryItem {
+  company?: string | null;
+  description?: string | null;
+  duration?: string | null;
+  end_date?: string | null;
+  is_current?: boolean;
+  location?: string | null;
+  start_date?: string | null;
+  title?: string | null;
+}
+
+/** Mirrors `team_members.LinkedInEnrichRequest`. SPENDS ENRICHMENT CREDIT. */
+export interface MemberLinkedInEnrichRequest {
+  /** LinkedIn profile URL to enrich from. */
+  linkedin_url: string;
+  /** Replace fields the person has already filled. Default fills empty fields only. */
+  overwrite?: boolean;
+}
+
+/** Mirrors `team_members.TeamMemberNoteCreateRequest`. */
+export interface MemberNoteCreateRequest {
+  /** Note content. */
+  content: string;
+  mentioned_users?: Array<MemberNoteMention>;
+}
+
+/** Mirrors `team_members.TeamMemberMentionedUserDto`. */
+export interface MemberNoteMention {
+  email?: string | null;
+  id: string;
+  name: string;
+}
+
+/** Mirrors `team_members.TeamMemberNoteUpdateRequest`. */
+export interface MemberNoteUpdateRequest {
+  /** Updated note content. */
+  content: string;
+  mentioned_users?: Array<MemberNoteMention>;
+}
+
+/**
+ * Mirrors `team_members.SocialImportRequest`.
+ *
+ * `platform` is closed here. The app takes a free string and silently does
+ * NOTHING platform-specific for any value other than `linkedin` or `twitter`
+ * - it still commits and answers 200, so a typo would read as success.
+ */
+export interface MemberSocialImportRequest {
+  /** Full bio / about section. */
+  about?: string | null;
+  /** Profile picture URL. */
+  avatar_url?: string | null;
+  /** Twitter bio. */
+  bio?: string | null;
+  /** Current company name. */
+  current_company?: string | null;
+  /** Current job title. */
+  current_title?: string | null;
+  /** Follower count. */
+  followers?: string | null;
+  /** Following count. */
+  following?: string | null;
+  /** LinkedIn headline or Twitter bio. */
+  headline?: string | null;
+  /** Full job history. REPLACES the stored history when sent. */
+  job_history?: Array<MemberJobHistoryItem> | null;
+  /** Location. */
+  location?: string | null;
+  /** Display name. */
+  name?: string | null;
+  /** Where the profile came from. */
+  platform: "linkedin" | "twitter";
+  /** Profile URL. */
+  profile_url: string;
+  /** Recent posts, used as writing samples. Each needs `text`; `scraped_at` is optional. At most three are taken per call. */
+  recent_posts?: Array<Record<string, unknown>> | null;
+  /** Skills / expertise list. */
+  skills?: Array<string> | null;
+  /** Twitter username. */
+  username?: string | null;
+  /** Personal website URL. */
+  website?: string | null;
+}
+
+/**
+ * Mirrors `team_members.TeamMemberUpdateRequest`, field for field.
+ *
+ * Every field is optional and an omitted field is LEFT ALONE - this is a
+ * PATCH, not a replacement.
+ */
+export interface MemberUpdateRequest {
+  achievements?: Array<string> | null;
+  avatar_url?: string | null;
+  bio_full?: string | null;
+  bio_short?: string | null;
+  certifications?: Array<string> | null;
+  company?: string | null;
+  custom_notes?: string | null;
+  department?: string | null;
+  expertise_areas?: Array<string> | null;
+  languages?: Array<string> | null;
+  linkedin_url?: string | null;
+  name?: string | null;
+  personal_interests?: Array<string> | null;
+  personal_website?: string | null;
+  phone?: string | null;
+  /** Merged into the member's preferences blob, key by key. */
+  preferences?: Record<string, unknown> | null;
+  responsibilities?: string | null;
+  timezone?: string | null;
+  title?: string | null;
+  tools_platforms?: Array<string> | null;
+  topics_of_interest?: Array<string> | null;
+  twitter_url?: string | null;
+  voice_tone?: string | null;
+}
+
+/**
+ * An open envelope for a LIST result, so a bare list keeps its shape.
+ *
+ * Most of these handlers return a bare `list[...]`; a few return a named
+ * envelope (`{"team_members": [...], "total": n}`). Both are reachable as
+ * `items`, and a named envelope KEEPS its own key as well so a caller
+ * already reading the app's shape is not broken by the wrapper.
+ */
+export interface OrgListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/**
+ * 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;
+}