@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/gtmLibrary.d.ts

@@ -0,0 +1,448 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.gtmLibrary` (GTM Library): 20 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"create_committee_committees_post">;
+ *
+ * Reference with examples: gtmLibrary.md
+ */
+/* eslint-disable */
+
+/** `g8.api.gtmLibrary.<member>` -> the operationId it calls. */
+export interface GtmLibraryMembers {
+  createCommittee: "create_committee_committees_post";
+  deleteCommittee: "delete_committee_committees__committee_id__delete";
+  deletePersona: "delete_persona_personas__persona_id__delete";
+  deleteTam: "delete_tam_tam_delete";
+  fillPersonasFromGlobalDoc: "fill_personas_from_global_doc_personas_from_global_doc_post";
+  generateIcps: "generate_icps_icps_generate_post";
+  generatePersonas: "generate_personas_personas_generate_post";
+  generateTam: "generate_tam_tam_generate_post";
+  getCommittee: "get_committee_committees__committee_id__get";
+  getPersona: "get_persona_personas__persona_id__get";
+  getTam: "get_tam_tam_get";
+  listCommittees: "list_committees_committees_get";
+  pinIcp: "pin_icp_icps__icp_id__pin_post";
+  pinPersona: "pin_persona_personas__persona_id__pin_post";
+  regenerateTam: "regenerate_tam_tam_regenerate_post";
+  replaceCommitteeMembers: "replace_committee_members_committees__committee_id__members_put";
+  unpinIcp: "unpin_icp_icps__icp_id__unpin_post";
+  unpinPersona: "unpin_persona_personas__persona_id__unpin_post";
+  updateCommittee: "update_committee_committees__committee_id__patch";
+  updateTam: "update_tam_tam_patch";
+}
+
+/** Input and output of every `g8.api.gtmLibrary` operation, keyed by operationId. */
+export interface GtmLibraryOperations {
+  /**
+   * POST /committees
+   * Create Committee
+   * tier: write · scope: campaigns:write
+   */
+  create_committee_committees_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CommitteeCreateRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * DELETE /committees/{committee_id}
+   * Delete Committee
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_committee_committees__committee_id__delete: {
+    input: {
+    path: {
+      /** Committee id. */
+      committee_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * DELETE /personas/{persona_id}
+   * Delete Persona
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_persona_personas__persona_id__delete: {
+    input: {
+    path: {
+      /** Persona id. */
+      persona_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * DELETE /tam
+   * Delete Tam
+   * tier: destructive · scope: campaigns:delete
+   */
+  delete_tam_tam_delete: {
+    input: {
+    query?: {
+      /** Which website's TAM to delete. */
+      website_url?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * POST /personas/from-global-doc
+   * Fill Personas From Global Doc
+   * tier: write · scope: campaigns:write
+   */
+  fill_personas_from_global_doc_personas_from_global_doc_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body?: PersonaFillFromDocRequest | null;
+  };
+    output: ApiResponse_GtmLibraryListPayload_;
+  };
+  /**
+   * POST /icps/generate
+   * Generate Icps
+   * tier: billable · scope: campaigns:run
+   */
+  generate_icps_icps_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: IcpGenerateRequest;
+  };
+    output: ApiResponse_GtmLibraryListPayload_;
+  };
+  /**
+   * POST /personas/generate
+   * Generate Personas
+   * tier: billable · scope: campaigns:run
+   */
+  generate_personas_personas_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: PersonaGenerateRequest;
+  };
+    output: ApiResponse_GtmLibraryListPayload_;
+  };
+  /**
+   * POST /tam/generate
+   * Generate Tam
+   * tier: billable · scope: campaigns:run
+   */
+  generate_tam_tam_generate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: TamGenerateRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * GET /committees/{committee_id}
+   * Get Committee
+   * tier: read · scope: campaigns:read
+   */
+  get_committee_committees__committee_id__get: {
+    input: {
+    path: {
+      /** Committee id. */
+      committee_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * GET /personas/{persona_id}
+   * Get Persona
+   * tier: read · scope: campaigns:read
+   */
+  get_persona_personas__persona_id__get: {
+    input: {
+    path: {
+      /** Persona id. */
+      persona_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * GET /tam
+   * Get Tam
+   * tier: read · scope: campaigns:read
+   */
+  get_tam_tam_get: {
+    input: {
+    query?: {
+      /** Which website's TAM. Omit for the org's latest. */
+      website_url?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * GET /committees
+   * List Committees
+   * tier: read · scope: campaigns:read
+   */
+  list_committees_committees_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryListPayload_;
+  };
+  /**
+   * POST /icps/{icp_id}/pin
+   * Pin Icp
+   * tier: write · scope: campaigns:write
+   */
+  pin_icp_icps__icp_id__pin_post: {
+    input: {
+    path: {
+      /** ICP id. */
+      icp_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * POST /personas/{persona_id}/pin
+   * Pin Persona
+   * tier: write · scope: campaigns:write
+   */
+  pin_persona_personas__persona_id__pin_post: {
+    input: {
+    path: {
+      /** Persona id. */
+      persona_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * POST /tam/regenerate
+   * Regenerate Tam
+   * tier: billable · scope: campaigns:run
+   */
+  regenerate_tam_tam_regenerate_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: TamGenerateRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * PUT /committees/{committee_id}/members
+   * Replace Committee Members
+   * tier: write · scope: campaigns:write
+   */
+  replace_committee_members_committees__committee_id__members_put: {
+    input: {
+    path: {
+      /** Committee id. */
+      committee_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CommitteeMembersRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * POST /icps/{icp_id}/unpin
+   * Unpin Icp
+   * tier: write · scope: campaigns:write
+   */
+  unpin_icp_icps__icp_id__unpin_post: {
+    input: {
+    path: {
+      /** ICP id. */
+      icp_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * POST /personas/{persona_id}/unpin
+   * Unpin Persona
+   * tier: write · scope: campaigns:write
+   */
+  unpin_persona_personas__persona_id__unpin_post: {
+    input: {
+    path: {
+      /** Persona id. */
+      persona_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * PATCH /committees/{committee_id}
+   * Update Committee
+   * tier: write · scope: campaigns:write
+   */
+  update_committee_committees__committee_id__patch: {
+    input: {
+    path: {
+      /** Committee id. */
+      committee_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: CommitteeUpdateRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+  /**
+   * PATCH /tam
+   * Update Tam
+   * tier: write · scope: campaigns:write
+   */
+  update_tam_tam_patch: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: TamUpdateRequest;
+  };
+    output: ApiResponse_GtmLibraryPayload_;
+  };
+}
+
+// 14 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_GtmLibraryListPayload_ {
+  data: GtmLibraryListPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_GtmLibraryPayload_ {
+  data: GtmLibraryPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface CommitteeCreateRequest {
+  description?: string | null;
+  /** Make this the org's default committee (unsets the previous one). */
+  is_default?: boolean | null;
+  name: string;
+}
+
+export interface CommitteeMemberAssignment {
+  /** The role slot. Null keeps the persona on the committee with no role. */
+  abm_category?: ("economic_buyer" | "champion" | "end_user" | "technical") | null;
+  persona_id: string;
+}
+
+export interface CommitteeMembersRequest {
+  /** The FULL roster. Personas left out are removed from the committee. */
+  members: Array<CommitteeMemberAssignment>;
+}
+
+export interface CommitteeUpdateRequest {
+  description?: string | null;
+  is_default?: boolean | null;
+  name?: string | null;
+}
+
+/** A list of personas, ICPs or committees under `items`. */
+export interface GtmLibraryListPayload {
+  items?: Array<unknown>;
+  [key: string]: unknown;
+}
+
+/** A persona, ICP, TAM definition or buying committee, as the app returns it. */
+export type GtmLibraryPayload = Record<string, unknown>;
+
+export interface IcpGenerateRequest {
+  /** Persist the generated ICPs. */
+  save_to_database?: boolean | null;
+  /** The website the ICPs are researched from. */
+  website_url: string;
+}
+
+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 PersonaFillFromDocRequest {
+  /** Stored on any persona row this creates. Optional: the committees view is org-wide and does not filter on it. */
+  website_url?: string | null;
+}
+
+export interface PersonaGenerateRequest {
+  /** Persist the generated personas. False returns a preview only. */
+  save_to_database?: boolean | null;
+  /** The website the personas are researched from. */
+  website_url: string;
+}
+
+export interface TamGenerateRequest {
+  /** The website the TAM is defined for. */
+  website_url: string;
+}
+
+export interface TamUpdateRequest {
+  /** A note recorded with the new version. */
+  change_summary?: string | null;
+  /** The full TAM definition to store. */
+  definition: Record<string, unknown>;
+  /** The website whose TAM definition is edited. */
+  website_url: string;
+}