@leadpoet/client 0.1.3 → 0.1.5

package/types/shared/workspace-tool-metadata.d.ts

@@ -0,0 +1,1083 @@
+/**
+ * What a call does, so Claude and ChatGPT can label it and ask before acting.
+ * - read: reads, or previews that save nothing.
+ * - create: adds a new record or draft at no cost.
+ * - modify: changes, moves or archives existing records.
+ * - spend: reserves or spends credits.
+ * - send: can start, resume, speed up, widen or change outreach to people.
+ */
+export type ToolEffect = "read" | "create" | "modify" | "spend" | "send";
+export type ToolMetadata = {
+    /** Short human-readable name hosts show in place of the operation id. */
+    title: string;
+    /** What the call does and returns, in plain words, for the model and reviewers. */
+    description: string;
+    effect: ToolEffect;
+    /** True when the call reaches beyond Leadpoet: outreach to people, web research or a connected CRM. */
+    openWorld: boolean;
+};
+/** One entry per published operation; the type check fails when one is missing. */
+export declare const TOOL_METADATA: {
+    createRequest: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    listLeadSearches: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    changeLeadSearch: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getContactAllowance: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listRequests: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getRequest: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getPipeline: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateCompany: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getContactReadiness: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    requestContacts: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    enrichContact: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    findPerson: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    lookupContact: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    addContact: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    getContactRequest: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getLatestContactRequest: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listSignals: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getAccountWatch: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    watchAccounts: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    setWatchStatus: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    markSignals: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listIcps: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createIcp: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    getIcp: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listIcpProducts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listIcpVersions: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createIcpDraft: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    updateIcpDraft: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    publishIcp: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    archiveIcp: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listPipelineContacts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    moveContact: {
+        title: string;
+        effect: "modify";
+        openWorld: true;
+        description: string;
+    };
+    pinContact: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listDeals: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createDeal: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    updateDeal: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    moveDeal: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getPipelineConfiguration: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCompanyNotes: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCompanyObservations: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getIcpFitInsights: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCreditBalance: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCreditHistory: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCompanyFitRatings: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    rateCompanyFit: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listDealCandidates: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createCompanyNote: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    listSendingAccounts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listConversations: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getOutreachProfile: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateOutreachProfile: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listAudienceSources: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listAudienceContacts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    checkAudienceAvailability: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    previewAudience: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    createAudience: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    listCampaigns: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCampaignProductDescriptions: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createCampaign: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    getCampaign: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    previewCampaign: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    proposeCampaignContract: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    launchCampaign: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    pauseCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    resumeCampaign: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    getCampaignResumeSummary: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listReview: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getReviewSummary: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    denyMessage: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    skipMessage: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listReplies: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getOutreachAnalytics: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    approveMessages: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    replyToConversation: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    archiveCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listSequenceTemplates: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getSequenceTemplate: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCampaignSequence: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createSequenceTemplate: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    duplicateSequenceTemplate: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    archiveSequenceTemplate: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getCampaignMessaging: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateCampaignMessaging: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    listRecurringRequests: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getRecurringRequestOptions: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createRecurringRequest: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    updateRecurringSetup: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    updateRecurringRequest: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    listAgentSchedules: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createAgentSchedule: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    updateAgentSchedule: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listAgentScheduleRuns: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listAgentMemories: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createAgentMemory: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    updateAgentMemory: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listQueuedMessages: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getQueuedMessage: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getMessageOutcome: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    prioritizeMessages: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    cancelQueuedMessage: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    returnQueuedMessageToReview: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getQueuedMessageEditSession: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    resumeQueuedMessageUnchanged: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    sendQueuedMessageNow: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    sendQueuedMessageSooner: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    renameCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    restoreCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    previewSenderAllocations: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateCampaignSchedule: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    getCampaignActivity: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCampaignDecisions: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCampaignReviews: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listAudiences: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getAudienceFunnel: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getAudiencePreflight: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    previewCampaignMessage: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    checkMessageDelivery: {
+        title: string;
+        effect: "modify";
+        openWorld: true;
+        description: string;
+    };
+    createManualIcp: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    getIcpUsage: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCampaignDescription: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateCampaignDescription: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    getAnalyticsFilters: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getAnalyticsReport: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    saveLeadEngineAudience: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    createIcpFromScan: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    previewIcpApplication: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    promoteIcpOverrides: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getDealSummaries: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getRevenueInsights: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCompanyDeals: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCompanyCalls: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCallThemes: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listUpcomingMeetings: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    pinDeal: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    updateDealAttribution: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    moveDeals: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    moveContacts: {
+        title: string;
+        effect: "modify";
+        openWorld: true;
+        description: string;
+    };
+    undoContactQualification: {
+        title: string;
+        effect: "modify";
+        openWorld: true;
+        description: string;
+    };
+    getCompanyNoteCounts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    archiveCompanyNotes: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    listContactTasks: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createContactTask: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    updateContactTask: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    previewCampaignAudience: {
+        title: string;
+        effect: "create";
+        openWorld: false;
+        description: string;
+    };
+    addCampaignAudience: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    listCampaignContacts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    removePendingCampaignContact: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    getUnmessagedCampaignContacts: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    removeUnmessagedCampaignContacts: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    previewCampaignAudienceSegment: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    updateConversationSequence: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    updateCampaignContactCap: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    updateSenderAllocations: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    updateSendingDays: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    changeCampaignMode: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    discardCampaign: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    restoreCampaignDrafts: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    resolveUnknownDelivery: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    bulkApproveMessages: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    bulkDenyMessages: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    bulkSkipMessages: {
+        title: string;
+        effect: "modify";
+        openWorld: false;
+        description: string;
+    };
+    recheckMessageAutopilot: {
+        title: string;
+        effect: "send";
+        openWorld: true;
+        description: string;
+    };
+    getPricing: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getApiIdentity: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getCredits: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCountries: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listStates: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCities: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listCompanySizes: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listLeadTypes: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    getPlaybook: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    listLeadRequests: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createLeadRequest: {
+        title: string;
+        effect: "spend";
+        openWorld: true;
+        description: string;
+    };
+    getLeadRequest: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+    createCompanyRequest: {
+        title: string;
+        effect: "create";
+        openWorld: true;
+        description: string;
+    };
+    getCompanyRequest: {
+        title: string;
+        effect: "read";
+        openWorld: false;
+        description: string;
+    };
+};