@graph8/sdk 0.251.0 → 0.262.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -2
- package/dist/cli.js +216 -0
- package/dist/index.d.mts +105 -7
- package/dist/index.d.ts +105 -7
- package/dist/index.js +44 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +44 -3
- package/dist/index.mjs.map +1 -1
- package/dist/react.d.mts +103 -7
- package/dist/react.d.ts +103 -7
- package/dist/react.js +62 -11
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +53 -12
- package/dist/react.mjs.map +1 -1
- package/dist/types/README.md +7 -0
- package/dist/types/agency.d.ts +20 -0
- package/dist/types/agentSetup.d.ts +57 -0
- package/dist/types/api.d.ts +127 -0
- package/dist/types/appClient.d.ts +99 -0
- package/dist/types/appPlatform.d.ts +269 -0
- package/dist/types/appTokens.d.ts +125 -0
- package/dist/types/apps.d.ts +130 -0
- package/dist/types/audiences.d.ts +88 -0
- package/dist/types/calendar.d.ts +55 -0
- package/dist/types/campaigns.d.ts +61 -0
- package/dist/types/chat.d.ts +35 -0
- package/dist/types/cli.d.ts +14 -0
- package/dist/types/companies.d.ts +123 -0
- package/dist/types/contacts.d.ts +200 -0
- package/dist/types/copilot.d.ts +31 -0
- package/dist/types/core.d.ts +1052 -0
- package/dist/types/deals.d.ts +215 -0
- package/dist/types/enrich.d.ts +51 -0
- package/dist/types/fields.d.ts +84 -0
- package/dist/types/forms.d.ts +16 -0
- package/dist/types/http.d.ts +141 -0
- package/dist/types/inbox.d.ts +123 -0
- package/dist/types/index.d.ts +63 -0
- package/dist/types/intent.d.ts +196 -0
- package/dist/types/lists.d.ts +44 -0
- package/dist/types/mailboxes.d.ts +240 -0
- package/dist/types/marketplace.d.ts +62 -0
- package/dist/types/meetings.d.ts +70 -0
- package/dist/types/newsletter.d.ts +212 -0
- package/dist/types/notes.d.ts +57 -0
- package/dist/types/objects.d.ts +281 -0
- package/dist/types/pipelines.d.ts +135 -0
- package/dist/types/quotes.d.ts +143 -0
- package/dist/types/react.d.ts +978 -0
- package/dist/types/search.d.ts +99 -0
- package/dist/types/sequences.d.ts +255 -0
- package/dist/types/signals.d.ts +28 -0
- package/dist/types/skills.d.ts +176 -0
- package/dist/types/snippet.d.ts +24 -0
- package/dist/types/studio.d.ts +161 -0
- package/dist/types/tasks.d.ts +101 -0
- package/dist/types/types.d.ts +45 -0
- package/dist/types/utils.d.ts +21 -0
- package/dist/types/version.d.ts +10 -0
- package/dist/types/visitors.d.ts +29 -0
- package/dist/types/voice.d.ts +304 -0
- package/dist/types/webhooks.d.ts +71 -0
- package/dist/types/workflows.d.ts +229 -0
- package/docs/agents.md +748 -0
- package/docs/api/README.md +165 -0
- package/docs/api/accounts.d.ts +396 -0
- package/docs/api/accounts.md +644 -0
- package/docs/api/adCampaigns.d.ts +707 -0
- package/docs/api/adCampaigns.md +1091 -0
- package/docs/api/adCreatives.d.ts +996 -0
- package/docs/api/adCreatives.md +1708 -0
- package/docs/api/agency.d.ts +556 -0
- package/docs/api/agency.md +845 -0
- package/docs/api/agent.d.ts +330 -0
- package/docs/api/agent.md +514 -0
- package/docs/api/agents.d.ts +1622 -0
- package/docs/api/agents.md +2860 -0
- package/docs/api/aiInbox.d.ts +1984 -0
- package/docs/api/aiInbox.md +3490 -0
- package/docs/api/analytics.d.ts +1273 -0
- package/docs/api/analytics.md +2095 -0
- package/docs/api/apiKeys.d.ts +252 -0
- package/docs/api/apiKeys.md +318 -0
- package/docs/api/appDeployments.d.ts +236 -0
- package/docs/api/appDeployments.md +471 -0
- package/docs/api/appDomains.d.ts +171 -0
- package/docs/api/appDomains.md +281 -0
- package/docs/api/appLogs.d.ts +120 -0
- package/docs/api/appLogs.md +159 -0
- package/docs/api/appObjects.d.ts +415 -0
- package/docs/api/appObjects.md +568 -0
- package/docs/api/appPages.d.ts +557 -0
- package/docs/api/appPages.md +796 -0
- package/docs/api/appPlatformTokens.d.ts +123 -0
- package/docs/api/appPlatformTokens.md +172 -0
- package/docs/api/appointments.d.ts +2361 -0
- package/docs/api/appointments.md +3917 -0
- package/docs/api/apps.d.ts +822 -0
- package/docs/api/apps.md +1342 -0
- package/docs/api/assertUpsert.d.ts +286 -0
- package/docs/api/assertUpsert.md +370 -0
- package/docs/api/audienceSyncs.d.ts +259 -0
- package/docs/api/audienceSyncs.md +395 -0
- package/docs/api/brandKit.d.ts +686 -0
- package/docs/api/brandKit.md +1133 -0
- package/docs/api/bugReports.d.ts +181 -0
- package/docs/api/bugReports.md +268 -0
- package/docs/api/by-path.md +3260 -0
- package/docs/api/calendarInvites.d.ts +117 -0
- package/docs/api/calendarInvites.md +148 -0
- package/docs/api/campaignWorkflows.d.ts +152 -0
- package/docs/api/campaignWorkflows.md +200 -0
- package/docs/api/campaigns.d.ts +721 -0
- package/docs/api/campaigns.md +1236 -0
- package/docs/api/channels.d.ts +171 -0
- package/docs/api/channels.md +235 -0
- package/docs/api/cliCampaigns.d.ts +205 -0
- package/docs/api/cliCampaigns.md +256 -0
- package/docs/api/cliPipelines.d.ts +324 -0
- package/docs/api/cliPipelines.md +562 -0
- package/docs/api/clickHouse.d.ts +115 -0
- package/docs/api/clickHouse.md +138 -0
- package/docs/api/companies.d.ts +1636 -0
- package/docs/api/companies.md +2211 -0
- package/docs/api/companyIntelligence.d.ts +299 -0
- package/docs/api/companyIntelligence.md +488 -0
- package/docs/api/contacts.d.ts +2173 -0
- package/docs/api/contacts.md +3143 -0
- package/docs/api/content.d.ts +968 -0
- package/docs/api/content.md +1667 -0
- package/docs/api/contentGridSkills.d.ts +177 -0
- package/docs/api/contentGridSkills.md +271 -0
- package/docs/api/copilot.d.ts +1017 -0
- package/docs/api/copilot.md +1765 -0
- package/docs/api/crmSyncs.d.ts +215 -0
- package/docs/api/crmSyncs.md +301 -0
- package/docs/api/customerSuccess.d.ts +491 -0
- package/docs/api/customerSuccess.md +776 -0
- package/docs/api/deals.d.ts +1697 -0
- package/docs/api/deals.md +2436 -0
- package/docs/api/deliverability.d.ts +418 -0
- package/docs/api/deliverability.md +677 -0
- package/docs/api/desk.d.ts +1765 -0
- package/docs/api/desk.md +3007 -0
- package/docs/api/dialer.d.ts +1185 -0
- package/docs/api/dialer.md +2166 -0
- package/docs/api/dialerAnalytics.d.ts +187 -0
- package/docs/api/dialerAnalytics.md +257 -0
- package/docs/api/documents.d.ts +895 -0
- package/docs/api/documents.md +1440 -0
- package/docs/api/duplicates.d.ts +195 -0
- package/docs/api/duplicates.md +315 -0
- package/docs/api/eSign.d.ts +38 -0
- package/docs/api/eSign.md +54 -0
- package/docs/api/eSignature.d.ts +242 -0
- package/docs/api/eSignature.md +341 -0
- package/docs/api/enrichment.d.ts +3207 -0
- package/docs/api/enrichment.md +5225 -0
- package/docs/api/events.d.ts +115 -0
- package/docs/api/events.md +105 -0
- package/docs/api/fields.d.ts +482 -0
- package/docs/api/fields.md +566 -0
- package/docs/api/forms.d.ts +1012 -0
- package/docs/api/forms.md +1542 -0
- package/docs/api/gtmCampaigns.d.ts +662 -0
- package/docs/api/gtmCampaigns.md +1044 -0
- package/docs/api/gtmContext.d.ts +1187 -0
- package/docs/api/gtmContext.md +2112 -0
- package/docs/api/gtmDeliverability.d.ts +60 -0
- package/docs/api/gtmDeliverability.md +63 -0
- package/docs/api/gtmKnowledgeBase.d.ts +76 -0
- package/docs/api/gtmKnowledgeBase.md +91 -0
- package/docs/api/gtmLaunchHelpers.d.ts +123 -0
- package/docs/api/gtmLaunchHelpers.md +148 -0
- package/docs/api/gtmLibrary.d.ts +448 -0
- package/docs/api/gtmLibrary.md +780 -0
- package/docs/api/health.d.ts +39 -0
- package/docs/api/health.md +58 -0
- package/docs/api/imageLibrary.d.ts +341 -0
- package/docs/api/imageLibrary.md +569 -0
- package/docs/api/imports.d.ts +157 -0
- package/docs/api/imports.md +174 -0
- package/docs/api/inbox.d.ts +709 -0
- package/docs/api/inbox.md +1067 -0
- package/docs/api/install.d.ts +213 -0
- package/docs/api/install.md +317 -0
- package/docs/api/installedApps.d.ts +131 -0
- package/docs/api/installedApps.md +241 -0
- package/docs/api/integrationStatus.d.ts +142 -0
- package/docs/api/integrationStatus.md +205 -0
- package/docs/api/integrations.d.ts +2327 -0
- package/docs/api/integrations.md +3791 -0
- package/docs/api/intent.d.ts +482 -0
- package/docs/api/intent.md +858 -0
- package/docs/api/knowledge.d.ts +501 -0
- package/docs/api/knowledge.md +843 -0
- package/docs/api/knowledgeBase.d.ts +84 -0
- package/docs/api/knowledgeBase.md +96 -0
- package/docs/api/landingPages.d.ts +1411 -0
- package/docs/api/landingPages.md +2488 -0
- package/docs/api/leads.d.ts +133 -0
- package/docs/api/leads.md +180 -0
- package/docs/api/library.d.ts +217 -0
- package/docs/api/library.md +338 -0
- package/docs/api/linkedIn.d.ts +227 -0
- package/docs/api/linkedIn.md +289 -0
- package/docs/api/linkedInOutreach.d.ts +727 -0
- package/docs/api/linkedInOutreach.md +990 -0
- package/docs/api/lists.d.ts +1106 -0
- package/docs/api/lists.md +1609 -0
- package/docs/api/logs.d.ts +71 -0
- package/docs/api/logs.md +70 -0
- package/docs/api/mailboxes.d.ts +1050 -0
- package/docs/api/mailboxes.md +1690 -0
- package/docs/api/marketingIntelligence.d.ts +256 -0
- package/docs/api/marketingIntelligence.md +454 -0
- package/docs/api/marketplace.d.ts +3173 -0
- package/docs/api/marketplace.md +5953 -0
- package/docs/api/mcp.d.ts +69 -0
- package/docs/api/mcp.md +69 -0
- package/docs/api/me.d.ts +54 -0
- package/docs/api/me.md +56 -0
- package/docs/api/meetings.d.ts +539 -0
- package/docs/api/meetings.md +747 -0
- package/docs/api/newsletter.d.ts +1613 -0
- package/docs/api/newsletter.md +2746 -0
- package/docs/api/notes.d.ts +517 -0
- package/docs/api/notes.md +888 -0
- package/docs/api/notifications.d.ts +94 -0
- package/docs/api/notifications.md +105 -0
- package/docs/api/objects.d.ts +621 -0
- package/docs/api/objects.md +1098 -0
- package/docs/api/openSearch.d.ts +234 -0
- package/docs/api/openSearch.md +297 -0
- package/docs/api/ops.d.ts +299 -0
- package/docs/api/ops.md +339 -0
- package/docs/api/orgGovernance.d.ts +393 -0
- package/docs/api/orgGovernance.md +623 -0
- package/docs/api/orgVideos.d.ts +184 -0
- package/docs/api/orgVideos.md +252 -0
- package/docs/api/organizationSettings.d.ts +626 -0
- package/docs/api/organizationSettings.md +911 -0
- package/docs/api/phoneNumbers.d.ts +484 -0
- package/docs/api/phoneNumbers.md +777 -0
- package/docs/api/profile.d.ts +329 -0
- package/docs/api/profile.md +540 -0
- package/docs/api/programmaticPages.d.ts +400 -0
- package/docs/api/programmaticPages.md +626 -0
- package/docs/api/providerDomains.d.ts +866 -0
- package/docs/api/providerDomains.md +1446 -0
- package/docs/api/providerUsage.d.ts +129 -0
- package/docs/api/providerUsage.md +186 -0
- package/docs/api/public.d.ts +69 -0
- package/docs/api/public.md +78 -0
- package/docs/api/publicCopilot.d.ts +67 -0
- package/docs/api/publicCopilot.md +80 -0
- package/docs/api/publicSignals.d.ts +66 -0
- package/docs/api/publicSignals.md +71 -0
- package/docs/api/publicVisitors.d.ts +97 -0
- package/docs/api/publicVisitors.md +118 -0
- package/docs/api/quotes.d.ts +1564 -0
- package/docs/api/quotes.md +2553 -0
- package/docs/api/radar.d.ts +808 -0
- package/docs/api/radar.md +1431 -0
- package/docs/api/radarReports.d.ts +208 -0
- package/docs/api/radarReports.md +306 -0
- package/docs/api/recordRoles.d.ts +143 -0
- package/docs/api/recordRoles.md +175 -0
- package/docs/api/repos.d.ts +146 -0
- package/docs/api/repos.md +211 -0
- package/docs/api/research.d.ts +295 -0
- package/docs/api/research.md +534 -0
- package/docs/api/revenue.d.ts +402 -0
- package/docs/api/revenue.md +608 -0
- package/docs/api/revenueAnalytics.d.ts +147 -0
- package/docs/api/revenueAnalytics.md +212 -0
- package/docs/api/revenueLifecycle.d.ts +207 -0
- package/docs/api/revenueLifecycle.md +274 -0
- package/docs/api/revenueRecords.d.ts +372 -0
- package/docs/api/revenueRecords.md +563 -0
- package/docs/api/roles.d.ts +431 -0
- package/docs/api/roles.md +812 -0
- package/docs/api/salesCoach.d.ts +877 -0
- package/docs/api/salesCoach.md +1540 -0
- package/docs/api/sandbox.d.ts +210 -0
- package/docs/api/sandbox.md +380 -0
- package/docs/api/scans.d.ts +104 -0
- package/docs/api/scans.md +136 -0
- package/docs/api/scheduleBuy.d.ts +293 -0
- package/docs/api/scheduleBuy.md +431 -0
- package/docs/api/scraping.d.ts +266 -0
- package/docs/api/scraping.md +383 -0
- package/docs/api/sdrAnalytics.d.ts +138 -0
- package/docs/api/sdrAnalytics.md +246 -0
- package/docs/api/search.d.ts +598 -0
- package/docs/api/search.md +866 -0
- package/docs/api/seo.d.ts +447 -0
- package/docs/api/seo.md +660 -0
- package/docs/api/sequenceLifecycle.d.ts +439 -0
- package/docs/api/sequenceLifecycle.md +513 -0
- package/docs/api/sequences.d.ts +1936 -0
- package/docs/api/sequences.md +3232 -0
- package/docs/api/settings.d.ts +448 -0
- package/docs/api/settings.md +731 -0
- package/docs/api/signals.d.ts +1441 -0
- package/docs/api/signals.md +2526 -0
- package/docs/api/signatures.d.ts +719 -0
- package/docs/api/signatures.md +1247 -0
- package/docs/api/skills.d.ts +230 -0
- package/docs/api/skills.md +466 -0
- package/docs/api/snippet.d.ts +85 -0
- package/docs/api/snippet.md +106 -0
- package/docs/api/socialPublishing.d.ts +824 -0
- package/docs/api/socialPublishing.md +1245 -0
- package/docs/api/studioDocuments.d.ts +244 -0
- package/docs/api/studioDocuments.md +348 -0
- package/docs/api/support.d.ts +90 -0
- package/docs/api/support.md +76 -0
- package/docs/api/suppressions.d.ts +241 -0
- package/docs/api/suppressions.md +343 -0
- package/docs/api/surveys.d.ts +847 -0
- package/docs/api/surveys.md +1223 -0
- package/docs/api/tasks.d.ts +813 -0
- package/docs/api/tasks.md +1344 -0
- package/docs/api/teamMembers.d.ts +668 -0
- package/docs/api/teamMembers.md +1040 -0
- package/docs/api/teams.d.ts +784 -0
- package/docs/api/teams.md +1395 -0
- package/docs/api/usage.d.ts +277 -0
- package/docs/api/usage.md +389 -0
- package/docs/api/visitors.d.ts +690 -0
- package/docs/api/visitors.md +1075 -0
- package/docs/api/voice.d.ts +4661 -0
- package/docs/api/voice.md +7905 -0
- package/docs/api/webAnalytics.d.ts +964 -0
- package/docs/api/webAnalytics.md +1452 -0
- package/docs/api/webChat.d.ts +1704 -0
- package/docs/api/webChat.md +2048 -0
- package/docs/api/webhooks.d.ts +251 -0
- package/docs/api/webhooks.md +386 -0
- package/docs/api/websiteEditor.d.ts +324 -0
- package/docs/api/websiteEditor.md +517 -0
- package/docs/api/work.d.ts +2298 -0
- package/docs/api/work.md +3096 -0
- package/docs/api/workbench.d.ts +2962 -0
- package/docs/api/workbench.md +4884 -0
- package/docs/api/workflows.d.ts +1218 -0
- package/docs/api/workflows.md +2302 -0
- package/docs/sdk-clients.md +4339 -0
- package/package.json +10 -3
|
@@ -0,0 +1,813 @@
|
|
|
1
|
+
/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Types for `g8.api.tasks` (Tasks): 25 operations.
|
|
5
|
+
*
|
|
6
|
+
* For reading. In code, import from the package instead:
|
|
7
|
+
* import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
|
|
8
|
+
* type In = ApiInput<"assign_task_executor_tasks__task_id__assignment_put">;
|
|
9
|
+
*
|
|
10
|
+
* Reference with examples: tasks.md
|
|
11
|
+
*/
|
|
12
|
+
/* eslint-disable */
|
|
13
|
+
|
|
14
|
+
/** `g8.api.tasks.<member>` -> the operationId it calls. */
|
|
15
|
+
export interface TasksMembers {
|
|
16
|
+
assignTaskExecutor: "assign_task_executor_tasks__task_id__assignment_put";
|
|
17
|
+
createGlobalTask: "create_global_task_tasks_post";
|
|
18
|
+
createSubtask: "create_subtask_tasks__task_id__subtasks_post";
|
|
19
|
+
createTask: "create_task_contacts__contact_id__tasks_post";
|
|
20
|
+
createTaskCopies: "create_task_copies_tasks__task_id__copies_post";
|
|
21
|
+
createTaskReply: "create_task_reply_tasks__task_id__replies_post";
|
|
22
|
+
deleteSubtask: "delete_subtask_tasks__task_id__subtasks__subtask_id__delete";
|
|
23
|
+
deleteTask: "delete_task_tasks__task_id__delete";
|
|
24
|
+
deleteTaskReply: "delete_task_reply_tasks_replies__reply_id__delete";
|
|
25
|
+
getTask: "get_task_tasks__task_id__get";
|
|
26
|
+
getTaskRecord: "get_task_record_tasks_records__entity_type___entity_id__get";
|
|
27
|
+
getTaskSettings: "get_task_settings_tasks_settings_get";
|
|
28
|
+
listAllTasks: "list_all_tasks_tasks_get";
|
|
29
|
+
listContactTasks: "list_contact_tasks_contacts__contact_id__tasks_get";
|
|
30
|
+
listSubtasks: "list_subtasks_tasks__task_id__subtasks_get";
|
|
31
|
+
listTaskReplies: "list_task_replies_tasks__task_id__replies_get";
|
|
32
|
+
reopenTaskThread: "reopen_task_thread_tasks__task_id__resolve_delete";
|
|
33
|
+
resolveTaskThread: "resolve_task_thread_tasks__task_id__resolve_post";
|
|
34
|
+
snoozeTaskReminder: "snooze_task_reminder_tasks__task_id__snooze_post";
|
|
35
|
+
startTaskExecution: "start_task_execution_tasks__task_id__start_post";
|
|
36
|
+
taskExecutionHistory: "task_execution_history_tasks__task_id__execution_get";
|
|
37
|
+
updateSubtask: "update_subtask_tasks__task_id__subtasks__subtask_id__put";
|
|
38
|
+
updateTask: "update_task_tasks__task_id__patch";
|
|
39
|
+
updateTaskReply: "update_task_reply_tasks_replies__reply_id__put";
|
|
40
|
+
updateTaskSettings: "update_task_settings_tasks_settings_put";
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** Input and output of every `g8.api.tasks` operation, keyed by operationId. */
|
|
44
|
+
export interface TasksOperations {
|
|
45
|
+
/**
|
|
46
|
+
* PUT /tasks/{task_id}/assignment
|
|
47
|
+
* Assign Task Executor
|
|
48
|
+
* tier: write · scope: tasks:write
|
|
49
|
+
*/
|
|
50
|
+
assign_task_executor_tasks__task_id__assignment_put: {
|
|
51
|
+
input: {
|
|
52
|
+
path: {
|
|
53
|
+
task_id: string;
|
|
54
|
+
};
|
|
55
|
+
headers?: {
|
|
56
|
+
"X-Target-Org-Id"?: string | null;
|
|
57
|
+
};
|
|
58
|
+
body: TaskAssignmentRequest;
|
|
59
|
+
};
|
|
60
|
+
output: ApiResponse_TaskAssignmentResult_;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* POST /tasks
|
|
64
|
+
* Create Global Task
|
|
65
|
+
* tier: write · scope: tasks:write
|
|
66
|
+
*/
|
|
67
|
+
create_global_task_tasks_post: {
|
|
68
|
+
input: {
|
|
69
|
+
headers?: {
|
|
70
|
+
"idempotency-key"?: string | null;
|
|
71
|
+
"X-Target-Org-Id"?: string | null;
|
|
72
|
+
};
|
|
73
|
+
body: TaskCreateRequest;
|
|
74
|
+
};
|
|
75
|
+
output: ApiResponse_TaskResponse_;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* POST /tasks/{task_id}/subtasks
|
|
79
|
+
* Create Subtask
|
|
80
|
+
* tier: write · scope: tasks:write
|
|
81
|
+
*/
|
|
82
|
+
create_subtask_tasks__task_id__subtasks_post: {
|
|
83
|
+
input: {
|
|
84
|
+
path: {
|
|
85
|
+
/** Parent task id (UUID). */
|
|
86
|
+
task_id: string;
|
|
87
|
+
};
|
|
88
|
+
headers?: {
|
|
89
|
+
"X-Target-Org-Id"?: string | null;
|
|
90
|
+
};
|
|
91
|
+
body: SubtaskCreateRequest;
|
|
92
|
+
};
|
|
93
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* POST /contacts/{contact_id}/tasks
|
|
97
|
+
* Create Task
|
|
98
|
+
* tier: write · scope: tasks:write
|
|
99
|
+
*/
|
|
100
|
+
create_task_contacts__contact_id__tasks_post: {
|
|
101
|
+
input: {
|
|
102
|
+
path: {
|
|
103
|
+
/** Contact ID */
|
|
104
|
+
contact_id: number;
|
|
105
|
+
};
|
|
106
|
+
headers?: {
|
|
107
|
+
"X-Target-Org-Id"?: string | null;
|
|
108
|
+
};
|
|
109
|
+
body: TaskCreateRequest;
|
|
110
|
+
};
|
|
111
|
+
output: ApiResponse_TaskResponse_;
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* POST /tasks/{task_id}/copies
|
|
115
|
+
* Create Task Copies
|
|
116
|
+
* tier: write · scope: tasks:write
|
|
117
|
+
*/
|
|
118
|
+
create_task_copies_tasks__task_id__copies_post: {
|
|
119
|
+
input: {
|
|
120
|
+
path: {
|
|
121
|
+
task_id: string;
|
|
122
|
+
};
|
|
123
|
+
headers?: {
|
|
124
|
+
"X-Target-Org-Id"?: string | null;
|
|
125
|
+
};
|
|
126
|
+
body: TaskCopyRequest;
|
|
127
|
+
};
|
|
128
|
+
output: unknown;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* POST /tasks/{task_id}/replies
|
|
132
|
+
* Create Task Reply
|
|
133
|
+
* tier: write · scope: tasks:write
|
|
134
|
+
*/
|
|
135
|
+
create_task_reply_tasks__task_id__replies_post: {
|
|
136
|
+
input: {
|
|
137
|
+
path: {
|
|
138
|
+
/** Task id (UUID). */
|
|
139
|
+
task_id: string;
|
|
140
|
+
};
|
|
141
|
+
headers?: {
|
|
142
|
+
"X-Target-Org-Id"?: string | null;
|
|
143
|
+
};
|
|
144
|
+
body: TaskReplyCreateRequest;
|
|
145
|
+
};
|
|
146
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* DELETE /tasks/{task_id}/subtasks/{subtask_id}
|
|
150
|
+
* Delete Subtask
|
|
151
|
+
* tier: destructive · scope: tasks:delete
|
|
152
|
+
*/
|
|
153
|
+
delete_subtask_tasks__task_id__subtasks__subtask_id__delete: {
|
|
154
|
+
input: {
|
|
155
|
+
path: {
|
|
156
|
+
/** Parent task id (UUID). */
|
|
157
|
+
task_id: string;
|
|
158
|
+
/** Subtask id (UUID). */
|
|
159
|
+
subtask_id: string;
|
|
160
|
+
};
|
|
161
|
+
headers?: {
|
|
162
|
+
"X-Target-Org-Id"?: string | null;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
166
|
+
};
|
|
167
|
+
/**
|
|
168
|
+
* DELETE /tasks/{task_id}
|
|
169
|
+
* Delete Task
|
|
170
|
+
* tier: destructive · scope: tasks:delete
|
|
171
|
+
*/
|
|
172
|
+
delete_task_tasks__task_id__delete: {
|
|
173
|
+
input: {
|
|
174
|
+
path: {
|
|
175
|
+
/** Task ID */
|
|
176
|
+
task_id: string;
|
|
177
|
+
};
|
|
178
|
+
headers?: {
|
|
179
|
+
"X-Target-Org-Id"?: string | null;
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
output: ApiResponse_dict_;
|
|
183
|
+
};
|
|
184
|
+
/**
|
|
185
|
+
* DELETE /tasks/replies/{reply_id}
|
|
186
|
+
* Delete Task Reply
|
|
187
|
+
* tier: destructive · scope: tasks:delete
|
|
188
|
+
*/
|
|
189
|
+
delete_task_reply_tasks_replies__reply_id__delete: {
|
|
190
|
+
input: {
|
|
191
|
+
path: {
|
|
192
|
+
/** Reply id (UUID). */
|
|
193
|
+
reply_id: string;
|
|
194
|
+
};
|
|
195
|
+
headers?: {
|
|
196
|
+
"X-Target-Org-Id"?: string | null;
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
200
|
+
};
|
|
201
|
+
/**
|
|
202
|
+
* GET /tasks/{task_id}
|
|
203
|
+
* Get Task
|
|
204
|
+
* tier: read · scope: tasks:read
|
|
205
|
+
*/
|
|
206
|
+
get_task_tasks__task_id__get: {
|
|
207
|
+
input: {
|
|
208
|
+
path: {
|
|
209
|
+
task_id: string;
|
|
210
|
+
};
|
|
211
|
+
headers?: {
|
|
212
|
+
"X-Target-Org-Id"?: string | null;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
output: ApiResponse_TaskResponse_;
|
|
216
|
+
};
|
|
217
|
+
/**
|
|
218
|
+
* GET /tasks/records/{entity_type}/{entity_id}
|
|
219
|
+
* Get Task Record
|
|
220
|
+
* tier: read · scope: tasks:read
|
|
221
|
+
*/
|
|
222
|
+
get_task_record_tasks_records__entity_type___entity_id__get: {
|
|
223
|
+
input: {
|
|
224
|
+
path: {
|
|
225
|
+
/** Record type, e.g. `contact`, `company`, `deal`. */
|
|
226
|
+
entity_type: string;
|
|
227
|
+
/** Record id. */
|
|
228
|
+
entity_id: string;
|
|
229
|
+
};
|
|
230
|
+
headers?: {
|
|
231
|
+
"X-Target-Org-Id"?: string | null;
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
235
|
+
};
|
|
236
|
+
/**
|
|
237
|
+
* GET /tasks/settings
|
|
238
|
+
* Get Task Settings
|
|
239
|
+
* tier: read · scope: tasks:read
|
|
240
|
+
*/
|
|
241
|
+
get_task_settings_tasks_settings_get: {
|
|
242
|
+
input: {
|
|
243
|
+
headers?: {
|
|
244
|
+
"X-Target-Org-Id"?: string | null;
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
248
|
+
};
|
|
249
|
+
/**
|
|
250
|
+
* GET /tasks
|
|
251
|
+
* List All Tasks
|
|
252
|
+
* tier: read · scope: tasks:read
|
|
253
|
+
*/
|
|
254
|
+
list_all_tasks_tasks_get: {
|
|
255
|
+
input: {
|
|
256
|
+
query?: {
|
|
257
|
+
/** Filter by status (open, completed) */
|
|
258
|
+
status?: string | null;
|
|
259
|
+
/** Filter by priority */
|
|
260
|
+
priority?: number | null;
|
|
261
|
+
/** Filter by assignee user ID */
|
|
262
|
+
assignee_id?: string | null;
|
|
263
|
+
/** Filter by creator (email or user ID) */
|
|
264
|
+
created_by?: string | null;
|
|
265
|
+
/** Filter by task type (call, email, meeting, ...) */
|
|
266
|
+
task_type?: string | null;
|
|
267
|
+
/** Filter by linked entity type (contact, company, deal, team_member) */
|
|
268
|
+
entity_type?: string | null;
|
|
269
|
+
/** Filter by linked entity ID (pair with entity_type) */
|
|
270
|
+
entity_id?: string | null;
|
|
271
|
+
/** Filter to tasks from a specific meeting */
|
|
272
|
+
source_meeting_id?: number | null;
|
|
273
|
+
/** Search by task title */
|
|
274
|
+
search?: string | null;
|
|
275
|
+
/** Max tasks to return (default 100, max 200) */
|
|
276
|
+
limit?: number;
|
|
277
|
+
/** Number of tasks to skip */
|
|
278
|
+
offset?: number;
|
|
279
|
+
};
|
|
280
|
+
headers?: {
|
|
281
|
+
"X-Target-Org-Id"?: string | null;
|
|
282
|
+
};
|
|
283
|
+
};
|
|
284
|
+
output: ApiResponse_list_TaskResponse__;
|
|
285
|
+
};
|
|
286
|
+
/**
|
|
287
|
+
* GET /contacts/{contact_id}/tasks
|
|
288
|
+
* List Contact Tasks
|
|
289
|
+
* tier: read · scope: tasks:read
|
|
290
|
+
*/
|
|
291
|
+
list_contact_tasks_contacts__contact_id__tasks_get: {
|
|
292
|
+
input: {
|
|
293
|
+
path: {
|
|
294
|
+
/** Contact ID */
|
|
295
|
+
contact_id: number;
|
|
296
|
+
};
|
|
297
|
+
query?: {
|
|
298
|
+
/** Filter by status (open, completed) */
|
|
299
|
+
status?: string | null;
|
|
300
|
+
};
|
|
301
|
+
headers?: {
|
|
302
|
+
"X-Target-Org-Id"?: string | null;
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
output: ApiResponse_list_TaskResponse__;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* GET /tasks/{task_id}/subtasks
|
|
309
|
+
* List Subtasks
|
|
310
|
+
* tier: read · scope: tasks:read
|
|
311
|
+
*/
|
|
312
|
+
list_subtasks_tasks__task_id__subtasks_get: {
|
|
313
|
+
input: {
|
|
314
|
+
path: {
|
|
315
|
+
/** Parent task id (UUID). */
|
|
316
|
+
task_id: string;
|
|
317
|
+
};
|
|
318
|
+
headers?: {
|
|
319
|
+
"X-Target-Org-Id"?: string | null;
|
|
320
|
+
};
|
|
321
|
+
};
|
|
322
|
+
output: ApiResponse_CrmCollectionPayload_;
|
|
323
|
+
};
|
|
324
|
+
/**
|
|
325
|
+
* GET /tasks/{task_id}/replies
|
|
326
|
+
* List Task Replies
|
|
327
|
+
* tier: read · scope: tasks:read
|
|
328
|
+
*/
|
|
329
|
+
list_task_replies_tasks__task_id__replies_get: {
|
|
330
|
+
input: {
|
|
331
|
+
path: {
|
|
332
|
+
/** Task id (UUID). */
|
|
333
|
+
task_id: string;
|
|
334
|
+
};
|
|
335
|
+
headers?: {
|
|
336
|
+
"X-Target-Org-Id"?: string | null;
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
output: ApiResponse_CrmCollectionPayload_;
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* DELETE /tasks/{task_id}/resolve
|
|
343
|
+
* Reopen Task Thread
|
|
344
|
+
* tier: destructive · scope: tasks:delete
|
|
345
|
+
*/
|
|
346
|
+
reopen_task_thread_tasks__task_id__resolve_delete: {
|
|
347
|
+
input: {
|
|
348
|
+
path: {
|
|
349
|
+
/** Task id (UUID). */
|
|
350
|
+
task_id: string;
|
|
351
|
+
};
|
|
352
|
+
headers?: {
|
|
353
|
+
"X-Target-Org-Id"?: string | null;
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
357
|
+
};
|
|
358
|
+
/**
|
|
359
|
+
* POST /tasks/{task_id}/resolve
|
|
360
|
+
* Resolve Task Thread
|
|
361
|
+
* tier: write · scope: tasks:write
|
|
362
|
+
*/
|
|
363
|
+
resolve_task_thread_tasks__task_id__resolve_post: {
|
|
364
|
+
input: {
|
|
365
|
+
path: {
|
|
366
|
+
/** Task id (UUID). */
|
|
367
|
+
task_id: string;
|
|
368
|
+
};
|
|
369
|
+
headers?: {
|
|
370
|
+
"X-Target-Org-Id"?: string | null;
|
|
371
|
+
};
|
|
372
|
+
body?: ResolveThreadRequest;
|
|
373
|
+
};
|
|
374
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
375
|
+
};
|
|
376
|
+
/**
|
|
377
|
+
* POST /tasks/{task_id}/snooze
|
|
378
|
+
* Snooze Task Reminder
|
|
379
|
+
* tier: write · scope: tasks:write
|
|
380
|
+
*/
|
|
381
|
+
snooze_task_reminder_tasks__task_id__snooze_post: {
|
|
382
|
+
input: {
|
|
383
|
+
path: {
|
|
384
|
+
/** Task id (UUID). */
|
|
385
|
+
task_id: string;
|
|
386
|
+
};
|
|
387
|
+
headers?: {
|
|
388
|
+
"X-Target-Org-Id"?: string | null;
|
|
389
|
+
};
|
|
390
|
+
body: SnoozeTaskRequest;
|
|
391
|
+
};
|
|
392
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
393
|
+
};
|
|
394
|
+
/**
|
|
395
|
+
* POST /tasks/{task_id}/start
|
|
396
|
+
* Start Task Execution
|
|
397
|
+
* tier: billable · scope: tasks:run
|
|
398
|
+
*/
|
|
399
|
+
start_task_execution_tasks__task_id__start_post: {
|
|
400
|
+
input: {
|
|
401
|
+
path: {
|
|
402
|
+
task_id: string;
|
|
403
|
+
};
|
|
404
|
+
headers: {
|
|
405
|
+
"idempotency-key": string;
|
|
406
|
+
"X-Target-Org-Id"?: string | null;
|
|
407
|
+
};
|
|
408
|
+
};
|
|
409
|
+
output: ApiResponse_TaskStartResult_;
|
|
410
|
+
};
|
|
411
|
+
/**
|
|
412
|
+
* GET /tasks/{task_id}/execution
|
|
413
|
+
* Task Execution History
|
|
414
|
+
* tier: read · scope: tasks:read
|
|
415
|
+
*/
|
|
416
|
+
task_execution_history_tasks__task_id__execution_get: {
|
|
417
|
+
input: {
|
|
418
|
+
path: {
|
|
419
|
+
task_id: string;
|
|
420
|
+
};
|
|
421
|
+
headers?: {
|
|
422
|
+
"X-Target-Org-Id"?: string | null;
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
output: ApiResponse_TaskExecutionHistory_;
|
|
426
|
+
};
|
|
427
|
+
/**
|
|
428
|
+
* PUT /tasks/{task_id}/subtasks/{subtask_id}
|
|
429
|
+
* Update Subtask
|
|
430
|
+
* tier: write · scope: tasks:write
|
|
431
|
+
*/
|
|
432
|
+
update_subtask_tasks__task_id__subtasks__subtask_id__put: {
|
|
433
|
+
input: {
|
|
434
|
+
path: {
|
|
435
|
+
/** Parent task id (UUID). */
|
|
436
|
+
task_id: string;
|
|
437
|
+
/** Subtask id (UUID). */
|
|
438
|
+
subtask_id: string;
|
|
439
|
+
};
|
|
440
|
+
headers?: {
|
|
441
|
+
"X-Target-Org-Id"?: string | null;
|
|
442
|
+
};
|
|
443
|
+
body: SubtaskUpdateRequest;
|
|
444
|
+
};
|
|
445
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* PATCH /tasks/{task_id}
|
|
449
|
+
* Update Task
|
|
450
|
+
* tier: write · scope: tasks:write
|
|
451
|
+
*/
|
|
452
|
+
update_task_tasks__task_id__patch: {
|
|
453
|
+
input: {
|
|
454
|
+
path: {
|
|
455
|
+
/** Task ID */
|
|
456
|
+
task_id: string;
|
|
457
|
+
};
|
|
458
|
+
headers?: {
|
|
459
|
+
"X-Target-Org-Id"?: string | null;
|
|
460
|
+
};
|
|
461
|
+
body: TaskUpdateRequest;
|
|
462
|
+
};
|
|
463
|
+
output: ApiResponse_TaskResponse_;
|
|
464
|
+
};
|
|
465
|
+
/**
|
|
466
|
+
* PUT /tasks/replies/{reply_id}
|
|
467
|
+
* Update Task Reply
|
|
468
|
+
* tier: write · scope: tasks:write
|
|
469
|
+
*/
|
|
470
|
+
update_task_reply_tasks_replies__reply_id__put: {
|
|
471
|
+
input: {
|
|
472
|
+
path: {
|
|
473
|
+
/** Reply id (UUID). */
|
|
474
|
+
reply_id: string;
|
|
475
|
+
};
|
|
476
|
+
headers?: {
|
|
477
|
+
"X-Target-Org-Id"?: string | null;
|
|
478
|
+
};
|
|
479
|
+
body: TaskReplyUpdateRequest;
|
|
480
|
+
};
|
|
481
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* PUT /tasks/settings
|
|
485
|
+
* Update Task Settings
|
|
486
|
+
* tier: write · scope: tasks:write
|
|
487
|
+
*/
|
|
488
|
+
update_task_settings_tasks_settings_put: {
|
|
489
|
+
input: {
|
|
490
|
+
headers?: {
|
|
491
|
+
"X-Target-Org-Id"?: string | null;
|
|
492
|
+
};
|
|
493
|
+
body: TaskCompletionSettingsRequest;
|
|
494
|
+
};
|
|
495
|
+
output: ApiResponse_CrmRecordPayload_;
|
|
496
|
+
};
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
// 27 schemas referenced above (the same as G8Contract.<Name>).
|
|
500
|
+
|
|
501
|
+
export interface ApiResponse_CrmCollectionPayload_ {
|
|
502
|
+
data: CrmCollectionPayload;
|
|
503
|
+
pagination?: PaginationMeta | null;
|
|
504
|
+
}
|
|
505
|
+
|
|
506
|
+
export interface ApiResponse_CrmRecordPayload_ {
|
|
507
|
+
data: CrmRecordPayload;
|
|
508
|
+
pagination?: PaginationMeta | null;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
export interface ApiResponse_TaskAssignmentResult_ {
|
|
512
|
+
data: TaskAssignmentResult;
|
|
513
|
+
pagination?: PaginationMeta | null;
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
export interface ApiResponse_TaskExecutionHistory_ {
|
|
517
|
+
data: TaskExecutionHistory;
|
|
518
|
+
pagination?: PaginationMeta | null;
|
|
519
|
+
}
|
|
520
|
+
|
|
521
|
+
export interface ApiResponse_TaskResponse_ {
|
|
522
|
+
data: TaskResponse;
|
|
523
|
+
pagination?: PaginationMeta | null;
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
export interface ApiResponse_TaskStartResult_ {
|
|
527
|
+
data: TaskStartResult;
|
|
528
|
+
pagination?: PaginationMeta | null;
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
export interface ApiResponse_dict_ {
|
|
532
|
+
data: Record<string, unknown>;
|
|
533
|
+
pagination?: PaginationMeta | null;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
export interface ApiResponse_list_TaskResponse__ {
|
|
537
|
+
data: Array<TaskResponse>;
|
|
538
|
+
pagination?: PaginationMeta | null;
|
|
539
|
+
}
|
|
540
|
+
|
|
541
|
+
/** An open envelope for a LIST result, so a bare list keeps its shape. */
|
|
542
|
+
export interface CrmCollectionPayload {
|
|
543
|
+
items?: Array<unknown>;
|
|
544
|
+
[key: string]: unknown;
|
|
545
|
+
}
|
|
546
|
+
|
|
547
|
+
/**
|
|
548
|
+
* An open envelope for one record, one dashboard or one job receipt.
|
|
549
|
+
*
|
|
550
|
+
* Open because most of these reads are COMPUTED shapes - an engagement
|
|
551
|
+
* summary, a next-best-step, an intelligence status - that grow with the
|
|
552
|
+
* product, and dropping a field from an advisory read makes it say "nothing
|
|
553
|
+
* to report" rather than "we did not tell you".
|
|
554
|
+
*/
|
|
555
|
+
export type CrmRecordPayload = Record<string, unknown>;
|
|
556
|
+
|
|
557
|
+
export interface PaginationMeta {
|
|
558
|
+
/** Whether there are more pages */
|
|
559
|
+
has_next: boolean;
|
|
560
|
+
/** Items per page */
|
|
561
|
+
limit: number;
|
|
562
|
+
/** 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. */
|
|
563
|
+
next_cursor?: string | null;
|
|
564
|
+
/** Current page number (1-indexed) */
|
|
565
|
+
page: number;
|
|
566
|
+
/** Total number of items */
|
|
567
|
+
total: number;
|
|
568
|
+
}
|
|
569
|
+
|
|
570
|
+
/**
|
|
571
|
+
* Mark a discussion thread resolved.
|
|
572
|
+
*
|
|
573
|
+
* Distinct from completing the task: a task can be done with an unresolved
|
|
574
|
+
* thread and vice versa. Idempotent - re-resolving returns the existing row.
|
|
575
|
+
*/
|
|
576
|
+
export interface ResolveThreadRequest {
|
|
577
|
+
/** Why it was resolved. */
|
|
578
|
+
resolution_note?: string | null;
|
|
579
|
+
}
|
|
580
|
+
|
|
581
|
+
/** Push a task's reminder out by N minutes from now. */
|
|
582
|
+
export interface SnoozeTaskRequest {
|
|
583
|
+
/** Minutes from now to fire the next reminder. */
|
|
584
|
+
minutes: number;
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
/**
|
|
588
|
+
* Create a subtask under an existing task.
|
|
589
|
+
*
|
|
590
|
+
* `entity_type`/`entity_id` are the record the subtask hangs off, and they
|
|
591
|
+
* are required by the app's own model - a subtask is not implicitly attached
|
|
592
|
+
* to its parent's record.
|
|
593
|
+
*/
|
|
594
|
+
export interface SubtaskCreateRequest {
|
|
595
|
+
/** Assignee id. */
|
|
596
|
+
assignee_id?: string | null;
|
|
597
|
+
/** Assignee display name. */
|
|
598
|
+
assignee_name?: string | null;
|
|
599
|
+
/** Free-text body. */
|
|
600
|
+
description?: string | null;
|
|
601
|
+
/** ISO 8601 due date. */
|
|
602
|
+
due_date?: string | null;
|
|
603
|
+
/** Record id. */
|
|
604
|
+
entity_id: string;
|
|
605
|
+
/** Record type: contact | company | deal. */
|
|
606
|
+
entity_type: string;
|
|
607
|
+
/** Ignored - the parent is the task in the path. Present for parity. */
|
|
608
|
+
parent_task_id?: string | null;
|
|
609
|
+
/** Priority. */
|
|
610
|
+
priority?: number | null;
|
|
611
|
+
/** Additional `{entity_type, entity_id}` records to link. When set, the FIRST entry becomes the primary record. */
|
|
612
|
+
records?: Array<Record<string, unknown>> | null;
|
|
613
|
+
/** ISO 8601 UTC reminder time. Omit for no reminder. */
|
|
614
|
+
reminder_at?: string | null;
|
|
615
|
+
/** Page the subtask was raised from. */
|
|
616
|
+
source_url?: string | null;
|
|
617
|
+
/** Position among sibling subtasks. */
|
|
618
|
+
subtask_sort_order?: number | null;
|
|
619
|
+
/** Labels (max 20). */
|
|
620
|
+
tags?: Array<string> | null;
|
|
621
|
+
/** Task type. */
|
|
622
|
+
task_type?: string | null;
|
|
623
|
+
/** Subtask title. */
|
|
624
|
+
title: string;
|
|
625
|
+
/** public | team | private. Omit for the org default. */
|
|
626
|
+
visibility?: string | null;
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* Patch a subtask. Omitted fields are left alone.
|
|
631
|
+
*
|
|
632
|
+
* `records` is the exception: an EMPTY list clears every record link, while
|
|
633
|
+
* omitting it leaves the links unchanged.
|
|
634
|
+
*/
|
|
635
|
+
export interface SubtaskUpdateRequest {
|
|
636
|
+
/** Send explicit null to unassign. */
|
|
637
|
+
assignee_id?: string | null;
|
|
638
|
+
/** Assignee display name. */
|
|
639
|
+
assignee_name?: string | null;
|
|
640
|
+
/** Explicitly remove the reminder. */
|
|
641
|
+
clear_reminder?: boolean | null;
|
|
642
|
+
/** New body. */
|
|
643
|
+
description?: string | null;
|
|
644
|
+
/** ISO 8601. Send explicit null to clear. */
|
|
645
|
+
due_date?: string | null;
|
|
646
|
+
/** Optimistic-concurrency guard. When set and the stored row is newer, the update is refused instead of overwriting. */
|
|
647
|
+
expected_updated_at?: string | null;
|
|
648
|
+
/** New priority. */
|
|
649
|
+
priority?: number | null;
|
|
650
|
+
/** Replace record links. Empty list clears them; omit to leave alone. */
|
|
651
|
+
records?: Array<Record<string, unknown>> | null;
|
|
652
|
+
/** ISO 8601 UTC reminder. */
|
|
653
|
+
reminder_at?: string | null;
|
|
654
|
+
/** New status. */
|
|
655
|
+
status?: string | null;
|
|
656
|
+
/** Replace the labels. */
|
|
657
|
+
tags?: Array<string> | null;
|
|
658
|
+
/** Send explicit null to clear. */
|
|
659
|
+
task_type?: string | null;
|
|
660
|
+
/** New title. */
|
|
661
|
+
title?: string | null;
|
|
662
|
+
/** public | team | private. */
|
|
663
|
+
visibility?: string | null;
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
export interface TaskAssignmentRequest {
|
|
667
|
+
agent_id?: string | null;
|
|
668
|
+
expected_updated_at: string;
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
export interface TaskAssignmentResult {
|
|
672
|
+
assigned: boolean;
|
|
673
|
+
execution_started: boolean;
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
/** Mirrors `UpdateTaskSettingsRequest`. The app accepts exactly these three modes. */
|
|
677
|
+
export interface TaskCompletionSettingsRequest {
|
|
678
|
+
/** How a parent task completes relative to its subtasks. */
|
|
679
|
+
parent_completion_mode?: ("manual" | "auto_complete" | "require_subtasks_done") | null;
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
export interface TaskCopyRequest {
|
|
683
|
+
assignee_ids: Array<string>;
|
|
684
|
+
expected_updated_at: string;
|
|
685
|
+
request_id: string;
|
|
686
|
+
}
|
|
687
|
+
|
|
688
|
+
export interface TaskCreateRequest {
|
|
689
|
+
/** User ID to assign the task to */
|
|
690
|
+
assignee_id?: string | null;
|
|
691
|
+
/** Task description */
|
|
692
|
+
description?: string | null;
|
|
693
|
+
/** Due date (ISO 8601) */
|
|
694
|
+
due_date?: string | null;
|
|
695
|
+
entity_id?: string | null;
|
|
696
|
+
entity_type?: string | null;
|
|
697
|
+
/** Parent task UUID. When set, this task is inserted as a subtask of the parent. Subtasks cannot themselves have subtasks (one level deep). */
|
|
698
|
+
parent_task_id?: string | null;
|
|
699
|
+
/** Priority (0=none, 1=high, 2=medium, 3=low; historical 4=low is preserved) */
|
|
700
|
+
priority?: number | null;
|
|
701
|
+
/** Optional related records: contact, company, deal, lead, application, team_member, or campaign (Studio). An empty list leaves the task standalone. */
|
|
702
|
+
records?: Array<Record<string, string>> | null;
|
|
703
|
+
source_url?: string | null;
|
|
704
|
+
/** Sort position within the parent's subtasks. When omitted on a subtask create, the handler appends to the end. */
|
|
705
|
+
subtask_sort_order?: number | null;
|
|
706
|
+
tags?: Array<string> | null;
|
|
707
|
+
/** Activity type, such as call or meeting */
|
|
708
|
+
task_type?: string | null;
|
|
709
|
+
/** Task title */
|
|
710
|
+
title: string;
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
export interface TaskExecutionHistory {
|
|
714
|
+
runs: Array<TaskExecutionRun>;
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
export interface TaskExecutionRun {
|
|
718
|
+
completed_at: string | null;
|
|
719
|
+
continued_after_reply?: boolean;
|
|
720
|
+
created_at: string;
|
|
721
|
+
current_step: string | null;
|
|
722
|
+
details_available: boolean;
|
|
723
|
+
next_action: string | null;
|
|
724
|
+
session_id: string | null;
|
|
725
|
+
status: string;
|
|
726
|
+
work_item_id: string;
|
|
727
|
+
}
|
|
728
|
+
|
|
729
|
+
/** Post a reply on a task's discussion thread. Internal to the org. */
|
|
730
|
+
export interface TaskReplyCreateRequest {
|
|
731
|
+
/** Avatar to show beside the reply. */
|
|
732
|
+
author_avatar_url?: string | null;
|
|
733
|
+
/** Reply text. */
|
|
734
|
+
body: string;
|
|
735
|
+
/** Users to notify. */
|
|
736
|
+
mentioned_user_ids?: Array<string>;
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
/** Edit a reply. Author only. */
|
|
740
|
+
export interface TaskReplyUpdateRequest {
|
|
741
|
+
/** Replacement text. */
|
|
742
|
+
body: string;
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
export interface TaskResponse {
|
|
746
|
+
assignee_id?: string | null;
|
|
747
|
+
assignee_name?: string | null;
|
|
748
|
+
completed_subtask_count?: number | null;
|
|
749
|
+
created_at?: string | null;
|
|
750
|
+
created_by?: string | null;
|
|
751
|
+
description?: string | null;
|
|
752
|
+
due_date?: string | null;
|
|
753
|
+
entity_id?: string | null;
|
|
754
|
+
entity_label?: string | null;
|
|
755
|
+
entity_type?: string | null;
|
|
756
|
+
execution_id?: string | null;
|
|
757
|
+
executor_agent_id?: string | null;
|
|
758
|
+
executor_agent_name?: string | null;
|
|
759
|
+
executor_type?: "human" | "agent";
|
|
760
|
+
id: string;
|
|
761
|
+
links?: Array<Record<string, unknown>>;
|
|
762
|
+
parent_task_id?: string | null;
|
|
763
|
+
priority?: number | null;
|
|
764
|
+
reminder_at?: string | null;
|
|
765
|
+
reminder_sent_at?: string | null;
|
|
766
|
+
source_external_id?: string | null;
|
|
767
|
+
source_meeting_id?: number | null;
|
|
768
|
+
source_meeting_start_time?: string | null;
|
|
769
|
+
source_meeting_title?: string | null;
|
|
770
|
+
source_transcript_id?: string | null;
|
|
771
|
+
source_url?: string | null;
|
|
772
|
+
status?: string | null;
|
|
773
|
+
subtask_count?: number | null;
|
|
774
|
+
subtask_sort_order?: number | null;
|
|
775
|
+
tags?: Array<string>;
|
|
776
|
+
task_type?: string | null;
|
|
777
|
+
title: string;
|
|
778
|
+
updated_at?: string | null;
|
|
779
|
+
visibility?: string | null;
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
export interface TaskStartResult {
|
|
783
|
+
already_started?: boolean;
|
|
784
|
+
message?: string | null;
|
|
785
|
+
session_id?: string | null;
|
|
786
|
+
work_item_id: string;
|
|
787
|
+
workflow_started: boolean;
|
|
788
|
+
}
|
|
789
|
+
|
|
790
|
+
export interface TaskUpdateRequest {
|
|
791
|
+
/** User ID to assign the task to */
|
|
792
|
+
assignee_id?: string | null;
|
|
793
|
+
/** Task description */
|
|
794
|
+
description?: string | null;
|
|
795
|
+
/** Due date (ISO 8601) */
|
|
796
|
+
due_date?: string | null;
|
|
797
|
+
expected_updated_at?: string | null;
|
|
798
|
+
/** New parent task UUID. Re-parents this task into a subtask of the given parent. Parent must exist and must not itself be a subtask. */
|
|
799
|
+
parent_task_id?: string | null;
|
|
800
|
+
/** Priority (0=none, 1=high, 2=medium, 3=low; historical 4=low is preserved) */
|
|
801
|
+
priority?: number | null;
|
|
802
|
+
/** Replace related records; an empty list removes all links and makes the task standalone. Omit to preserve existing links. */
|
|
803
|
+
records?: Array<Record<string, string>> | null;
|
|
804
|
+
/** Task status (open, completed) */
|
|
805
|
+
status?: string | null;
|
|
806
|
+
/** New sort position within the parent's subtasks (reorder). */
|
|
807
|
+
subtask_sort_order?: number | null;
|
|
808
|
+
tags?: Array<string> | null;
|
|
809
|
+
/** Activity type; null removes the saved type */
|
|
810
|
+
task_type?: string | null;
|
|
811
|
+
/** Task title */
|
|
812
|
+
title?: string | null;
|
|
813
|
+
}
|