@utdk/posthog 1.0.0-20260712.5-dev.e2949a6
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/LICENSE +373 -0
- package/README.md +172 -0
- package/docs/account_relationship_definitions.md +194 -0
- package/docs/accounts.md +380 -0
- package/docs/actions.md +274 -0
- package/docs/activity_logs.md +144 -0
- package/docs/advanced_activity_logs.md +101 -0
- package/docs/agent_platform.md +2525 -0
- package/docs/ai-observability.md +514 -0
- package/docs/alerts.md +444 -0
- package/docs/annotations.md +200 -0
- package/docs/batch_exports.md +2118 -0
- package/docs/business_knowledge.md +468 -0
- package/docs/code-invites.md +72 -0
- package/docs/cohorts.md +412 -0
- package/docs/comments.md +321 -0
- package/docs/conversations.md +695 -0
- package/docs/custom_property_definitions.md +442 -0
- package/docs/custom_property_sources.md +194 -0
- package/docs/customer_analytics.md +442 -0
- package/docs/customer_journeys.md +380 -0
- package/docs/customer_profile_configs.md +380 -0
- package/docs/dashboard_templates.md +258 -0
- package/docs/dashboards.md +1896 -0
- package/docs/data_color_themes.md +380 -0
- package/docs/data_modeling_jobs.md +264 -0
- package/docs/data_warehouse.md +928 -0
- package/docs/dataset_items.md +382 -0
- package/docs/datasets.md +382 -0
- package/docs/desktop_file_system.md +753 -0
- package/docs/desktop_file_system_shortcut.md +244 -0
- package/docs/docs.md +72 -0
- package/docs/early_access_feature.md +194 -0
- package/docs/elements.md +510 -0
- package/docs/endpoints.md +1030 -0
- package/docs/engineering_analytics.md +712 -0
- package/docs/environments.md +881 -0
- package/docs/error_tracking.md +5108 -0
- package/docs/evaluation_runs.md +78 -0
- package/docs/evaluations.md +446 -0
- package/docs/event_definitions.md +425 -0
- package/docs/event_filter.md +280 -0
- package/docs/event_schemas.md +163 -0
- package/docs/events.md +208 -0
- package/docs/experiment_holdouts.md +194 -0
- package/docs/experiment_saved_metrics.md +194 -0
- package/docs/experiments.md +1088 -0
- package/docs/exports.md +256 -0
- package/docs/external_data_schemas.md +752 -0
- package/docs/external_data_sources.md +2296 -0
- package/docs/feature_flags.md +808 -0
- package/docs/field_notes.md +206 -0
- package/docs/file_system.md +880 -0
- package/docs/file_system_shortcut.md +444 -0
- package/docs/flag_value.md +46 -0
- package/docs/groups.md +514 -0
- package/docs/groups_types.md +349 -0
- package/docs/health_issues.md +386 -0
- package/docs/heatmap_screenshots.md +72 -0
- package/docs/heatmaps.md +136 -0
- package/docs/hog_flows.md +1576 -0
- package/docs/hog_function_templates.md +101 -0
- package/docs/hog_functions.md +974 -0
- package/docs/ingestion_warnings_v2.md +40 -0
- package/docs/insight_variables.md +380 -0
- package/docs/insights.md +1722 -0
- package/docs/integrations.md +1954 -0
- package/docs/js-snippet.md +104 -0
- package/docs/live_debugger_breakpoints.md +264 -0
- package/docs/llm_analytics.md +3373 -0
- package/docs/llm_prompts.md +442 -0
- package/docs/llm_skills.md +952 -0
- package/docs/logs.md +2446 -0
- package/docs/managed_viewsets.md +140 -0
- package/docs/marketing_analytics.md +518 -0
- package/docs/max.md +772 -0
- package/docs/max_tools.md +70 -0
- package/docs/mcp_analytics.md +712 -0
- package/docs/mcp_server_installations.md +970 -0
- package/docs/mcp_servers.md +78 -0
- package/docs/mcp_tools.md +82 -0
- package/docs/messaging_templates.md +444 -0
- package/docs/metrics.md +462 -0
- package/docs/notebooks.md +838 -0
- package/docs/object_media_previews.md +228 -0
- package/docs/organizations.md +2958 -0
- package/docs/persons.md +1514 -0
- package/docs/platform_features.md +700 -0
- package/docs/plugin_configs.md +70 -0
- package/docs/product_enablement.md +39 -0
- package/docs/product_tours.md +357 -0
- package/docs/project_secret_api_keys.md +444 -0
- package/docs/property_access_controls.md +200 -0
- package/docs/property_definitions.md +244 -0
- package/docs/query.md +560 -0
- package/docs/quota_limits.md +40 -0
- package/docs/reminders.md +194 -0
- package/docs/replay.md +1020 -0
- package/docs/reverse_proxy.md +200 -0
- package/docs/sandbox-custom-images.md +209 -0
- package/docs/sandbox-environments.md +168 -0
- package/docs/saved.md +392 -0
- package/docs/saved_query_column_annotations.md +224 -0
- package/docs/scheduled_changes.md +200 -0
- package/docs/schema_property_groups.md +194 -0
- package/docs/sdk_health.md +40 -0
- package/docs/session_group_summaries.md +200 -0
- package/docs/session_recordings.md +260 -0
- package/docs/session_summaries.md +200 -0
- package/docs/sessions.md +132 -0
- package/docs/signals.md +1428 -0
- package/docs/single_session_summaries.md +72 -0
- package/docs/streamlit_apps.md +456 -0
- package/docs/subscriptions.md +634 -0
- package/docs/surveys.md +731 -0
- package/docs/taggers.md +446 -0
- package/docs/task-automations.md +200 -0
- package/docs/task-runs.md +654 -0
- package/docs/task_channels.md +136 -0
- package/docs/task_mentions.md +40 -0
- package/docs/tasks.md +776 -0
- package/docs/tracing.md +1186 -0
- package/docs/uploaded_media.md +44 -0
- package/docs/user_home_settings.md +72 -0
- package/docs/user_interview_topics.md +1288 -0
- package/docs/user_interviews.md +444 -0
- package/docs/users.md +1267 -0
- package/docs/vision.md +2022 -0
- package/docs/visual_review.md +816 -0
- package/docs/warehouse_column_annotations.md +224 -0
- package/docs/warehouse_column_statistics.md +80 -0
- package/docs/warehouse_dag.md +40 -0
- package/docs/warehouse_model_paths.md +70 -0
- package/docs/warehouse_saved_queries.md +1056 -0
- package/docs/warehouse_saved_query_folders.md +318 -0
- package/docs/warehouse_tables.md +584 -0
- package/docs/warehouse_view_link.md +456 -0
- package/docs/warehouse_view_links.md +456 -0
- package/docs/web_analytics.md +136 -0
- package/docs/web_analytics_achievements.md +200 -0
- package/docs/web_experiments.md +194 -0
- package/docs/web_vitals.md +74 -0
- package/docs/wizard.md +170 -0
- package/index.ts +22 -0
- package/metadata.ts +41419 -0
- package/openapi.json +297382 -0
- package/overlay.yaml +23 -0
- package/package.json +34 -0
- package/provenance.json +24 -0
- package/research.json +80 -0
- package/types/index.ts +17547 -0
package/docs/tasks.md
ADDED
|
@@ -0,0 +1,776 @@
|
|
|
1
|
+
# Tasks
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.tasksList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/`
|
|
8
|
+
- **What it does**: List tasks
|
|
9
|
+
- **OpenAPI operationId**: `tasks_list`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `archived`, `channel`, `created_by`, `internal`, `limit`, `offset`, `organization`, `origin_product`, `repository`, `search`, `stage`, `status`
|
|
12
|
+
- **Response codes**: `200`
|
|
13
|
+
- **Transport options**: None
|
|
14
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
15
|
+
|
|
16
|
+
**Inputs**
|
|
17
|
+
|
|
18
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
19
|
+
- Client transport options: None
|
|
20
|
+
|
|
21
|
+
**Outputs**
|
|
22
|
+
|
|
23
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string;...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type TasksListInput = Parameters<typeof posthog.tasksList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type TasksListOutput = Awaited<ReturnType<typeof posthog.tasksList>>;
|
|
31
|
+
|
|
32
|
+
const result: TasksListOutput = await posthog.tasksList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string;...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.tasksCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/`
|
|
40
|
+
- **What it does**: API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
|
|
41
|
+
- **OpenAPI operationId**: `tasks_create`
|
|
42
|
+
- **Path params**: None
|
|
43
|
+
- **Query params**: None
|
|
44
|
+
- **Response codes**: `201`
|
|
45
|
+
- **Transport options**: None
|
|
46
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
47
|
+
|
|
48
|
+
**Inputs**
|
|
49
|
+
|
|
50
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
51
|
+
- Client transport options: None
|
|
52
|
+
|
|
53
|
+
**Outputs**
|
|
54
|
+
|
|
55
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
56
|
+
- OpenAPI response codes: `201`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type TasksCreateInput = Parameters<typeof posthog.tasksCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type TasksCreateOutput = Awaited<ReturnType<typeof posthog.tasksCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: TasksCreateOutput = await posthog.tasksCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.tasksDestroy`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/tasks/{id}/`
|
|
72
|
+
- **What it does**: API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
|
|
73
|
+
- **OpenAPI operationId**: `tasks_destroy`
|
|
74
|
+
- **Path params**: `id`
|
|
75
|
+
- **Query params**: None
|
|
76
|
+
- **Response codes**: `204`
|
|
77
|
+
- **Transport options**: None
|
|
78
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
79
|
+
|
|
80
|
+
**Inputs**
|
|
81
|
+
|
|
82
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
83
|
+
- Client transport options: None
|
|
84
|
+
|
|
85
|
+
**Outputs**
|
|
86
|
+
|
|
87
|
+
- Client return type: `unknown`
|
|
88
|
+
- OpenAPI response codes: `204`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type TasksDestroyInput = Parameters<typeof posthog.tasksDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type TasksDestroyOutput = Awaited<ReturnType<typeof posthog.tasksDestroy>>;
|
|
95
|
+
|
|
96
|
+
const result: TasksDestroyOutput = await posthog.tasksDestroy();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): unknown
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.tasksRetrieve`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{id}/`
|
|
104
|
+
- **What it does**: Get task
|
|
105
|
+
- **OpenAPI operationId**: `tasks_retrieve`
|
|
106
|
+
- **Path params**: `id`
|
|
107
|
+
- **Query params**: None
|
|
108
|
+
- **Response codes**: `200`
|
|
109
|
+
- **Transport options**: None
|
|
110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
111
|
+
|
|
112
|
+
**Inputs**
|
|
113
|
+
|
|
114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
115
|
+
- Client transport options: None
|
|
116
|
+
|
|
117
|
+
**Outputs**
|
|
118
|
+
|
|
119
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
120
|
+
- OpenAPI response codes: `200`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type TasksRetrieveInput = Parameters<typeof posthog.tasksRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type TasksRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRetrieve>>;
|
|
127
|
+
|
|
128
|
+
const result: TasksRetrieveOutput = await posthog.tasksRetrieve();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.tasksPartialUpdate`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/tasks/{id}/`
|
|
136
|
+
- **What it does**: API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
|
|
137
|
+
- **OpenAPI operationId**: `tasks_partial_update`
|
|
138
|
+
- **Path params**: `id`
|
|
139
|
+
- **Query params**: None
|
|
140
|
+
- **Response codes**: `200`
|
|
141
|
+
- **Transport options**: None
|
|
142
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
143
|
+
|
|
144
|
+
**Inputs**
|
|
145
|
+
|
|
146
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
147
|
+
- Client transport options: None
|
|
148
|
+
|
|
149
|
+
**Outputs**
|
|
150
|
+
|
|
151
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
152
|
+
- OpenAPI response codes: `200`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type TasksPartialUpdateInput = Parameters<typeof posthog.tasksPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type TasksPartialUpdateOutput = Awaited<ReturnType<typeof posthog.tasksPartialUpdate>>;
|
|
159
|
+
|
|
160
|
+
const result: TasksPartialUpdateOutput = await posthog.tasksPartialUpdate();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.tasksUpdate`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `PUT /api/projects/{project_id}/tasks/{id}/`
|
|
168
|
+
- **What it does**: API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
|
|
169
|
+
- **OpenAPI operationId**: `tasks_update`
|
|
170
|
+
- **Path params**: `id`
|
|
171
|
+
- **Query params**: None
|
|
172
|
+
- **Response codes**: `200`
|
|
173
|
+
- **Transport options**: None
|
|
174
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
175
|
+
|
|
176
|
+
**Inputs**
|
|
177
|
+
|
|
178
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
179
|
+
- Client transport options: None
|
|
180
|
+
|
|
181
|
+
**Outputs**
|
|
182
|
+
|
|
183
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
184
|
+
- OpenAPI response codes: `200`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type TasksUpdateInput = Parameters<typeof posthog.tasksUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type TasksUpdateOutput = Awaited<ReturnType<typeof posthog.tasksUpdate>>;
|
|
191
|
+
|
|
192
|
+
const result: TasksUpdateOutput = await posthog.tasksUpdate();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### `posthog.tasksPresenceDestroy`
|
|
198
|
+
|
|
199
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/tasks/{id}/presence/`
|
|
200
|
+
- **What it does**: Beacon presence for a device watching this task
|
|
201
|
+
- **OpenAPI operationId**: `tasks_presence_destroy`
|
|
202
|
+
- **Path params**: `id`
|
|
203
|
+
- **Query params**: None
|
|
204
|
+
- **Response codes**: `204`, `404`
|
|
205
|
+
- **Transport options**: None
|
|
206
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
207
|
+
|
|
208
|
+
**Inputs**
|
|
209
|
+
|
|
210
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
211
|
+
- Client transport options: None
|
|
212
|
+
|
|
213
|
+
**Outputs**
|
|
214
|
+
|
|
215
|
+
- Client return type: `unknown`
|
|
216
|
+
- OpenAPI response codes: `204`, `404`
|
|
217
|
+
|
|
218
|
+
```ts
|
|
219
|
+
import posthog from "@utdk/posthog";
|
|
220
|
+
|
|
221
|
+
type TasksPresenceDestroyInput = Parameters<typeof posthog.tasksPresenceDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
222
|
+
type TasksPresenceDestroyOutput = Awaited<ReturnType<typeof posthog.tasksPresenceDestroy>>;
|
|
223
|
+
|
|
224
|
+
const result: TasksPresenceDestroyOutput = await posthog.tasksPresenceDestroy();
|
|
225
|
+
|
|
226
|
+
// Result shape (from schema): unknown
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### `posthog.tasksPresenceCreate`
|
|
230
|
+
|
|
231
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{id}/presence/`
|
|
232
|
+
- **What it does**: Beacon presence for a device watching this task
|
|
233
|
+
- **OpenAPI operationId**: `tasks_presence_create`
|
|
234
|
+
- **Path params**: `id`
|
|
235
|
+
- **Query params**: None
|
|
236
|
+
- **Response codes**: `204`, `404`
|
|
237
|
+
- **Transport options**: None
|
|
238
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
239
|
+
|
|
240
|
+
**Inputs**
|
|
241
|
+
|
|
242
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
243
|
+
- Client transport options: None
|
|
244
|
+
|
|
245
|
+
**Outputs**
|
|
246
|
+
|
|
247
|
+
- Client return type: `unknown`
|
|
248
|
+
- OpenAPI response codes: `204`, `404`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type TasksPresenceCreateInput = Parameters<typeof posthog.tasksPresenceCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type TasksPresenceCreateOutput = Awaited<ReturnType<typeof posthog.tasksPresenceCreate>>;
|
|
255
|
+
|
|
256
|
+
const result: TasksPresenceCreateOutput = await posthog.tasksPresenceCreate();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): unknown
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.tasksRunCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{id}/run/`
|
|
264
|
+
- **What it does**: Run task
|
|
265
|
+
- **OpenAPI operationId**: `tasks_run_create`
|
|
266
|
+
- **Path params**: `id`
|
|
267
|
+
- **Query params**: None
|
|
268
|
+
- **Response codes**: `200`, `400`, `404`, `429`
|
|
269
|
+
- **Transport options**: None
|
|
270
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
271
|
+
|
|
272
|
+
**Inputs**
|
|
273
|
+
|
|
274
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
275
|
+
- Client transport options: None
|
|
276
|
+
|
|
277
|
+
**Outputs**
|
|
278
|
+
|
|
279
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
280
|
+
- OpenAPI response codes: `200`, `400`, `404`, `429`
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import posthog from "@utdk/posthog";
|
|
284
|
+
|
|
285
|
+
type TasksRunCreateInput = Parameters<typeof posthog.tasksRunCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type TasksRunCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunCreate>>;
|
|
287
|
+
|
|
288
|
+
const result: TasksRunCreateOutput = await posthog.tasksRunCreate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.tasksStagedArtifactsFinalizeUploadCreate`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{id}/staged_artifacts/finalize_upload/`
|
|
296
|
+
- **What it does**: Finalize staged direct uploads for task attachments
|
|
297
|
+
- **OpenAPI operationId**: `tasks_staged_artifacts_finalize_upload_create`
|
|
298
|
+
- **Path params**: `id`
|
|
299
|
+
- **Query params**: None
|
|
300
|
+
- **Response codes**: `200`, `400`, `404`
|
|
301
|
+
- **Transport options**: None
|
|
302
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
303
|
+
|
|
304
|
+
**Inputs**
|
|
305
|
+
|
|
306
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
307
|
+
- Client transport options: None
|
|
308
|
+
|
|
309
|
+
**Outputs**
|
|
310
|
+
|
|
311
|
+
- Client return type: `{ artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...`
|
|
312
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import posthog from "@utdk/posthog";
|
|
316
|
+
|
|
317
|
+
type TasksStagedArtifactsFinalizeUploadCreateInput = Parameters<typeof posthog.tasksStagedArtifactsFinalizeUploadCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
318
|
+
type TasksStagedArtifactsFinalizeUploadCreateOutput = Awaited<ReturnType<typeof posthog.tasksStagedArtifactsFinalizeUploadCreate>>;
|
|
319
|
+
|
|
320
|
+
const result: TasksStagedArtifactsFinalizeUploadCreateOutput = await posthog.tasksStagedArtifactsFinalizeUploadCreate();
|
|
321
|
+
|
|
322
|
+
// Result shape (from schema): { artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### `posthog.tasksStagedArtifactsPrepareUploadCreate`
|
|
326
|
+
|
|
327
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{id}/staged_artifacts/prepare_upload/`
|
|
328
|
+
- **What it does**: Prepare staged direct uploads for task attachments
|
|
329
|
+
- **OpenAPI operationId**: `tasks_staged_artifacts_prepare_upload_create`
|
|
330
|
+
- **Path params**: `id`
|
|
331
|
+
- **Query params**: None
|
|
332
|
+
- **Response codes**: `200`, `400`, `404`
|
|
333
|
+
- **Transport options**: None
|
|
334
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
335
|
+
|
|
336
|
+
**Inputs**
|
|
337
|
+
|
|
338
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
339
|
+
- Client transport options: None
|
|
340
|
+
|
|
341
|
+
**Outputs**
|
|
342
|
+
|
|
343
|
+
- Client return type: `{ artifacts: ({ id: string; name: string; type: string; source?: string; size: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: str...`
|
|
344
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
import posthog from "@utdk/posthog";
|
|
348
|
+
|
|
349
|
+
type TasksStagedArtifactsPrepareUploadCreateInput = Parameters<typeof posthog.tasksStagedArtifactsPrepareUploadCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
350
|
+
type TasksStagedArtifactsPrepareUploadCreateOutput = Awaited<ReturnType<typeof posthog.tasksStagedArtifactsPrepareUploadCreate>>;
|
|
351
|
+
|
|
352
|
+
const result: TasksStagedArtifactsPrepareUploadCreateOutput = await posthog.tasksStagedArtifactsPrepareUploadCreate();
|
|
353
|
+
|
|
354
|
+
// Result shape (from schema): { artifacts: ({ id: string; name: string; type: string; source?: string; size: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: str...
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `posthog.tasksRunsLivingArtifactsList`
|
|
358
|
+
|
|
359
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{run_id}/living_artifacts/`
|
|
360
|
+
- **What it does**: List living artifacts for a task run
|
|
361
|
+
- **OpenAPI operationId**: `tasks_runs_living_artifacts_list`
|
|
362
|
+
- **Path params**: `run_id`, `task_id`
|
|
363
|
+
- **Query params**: None
|
|
364
|
+
- **Response codes**: `200`, `404`
|
|
365
|
+
- **Transport options**: None
|
|
366
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
367
|
+
|
|
368
|
+
**Inputs**
|
|
369
|
+
|
|
370
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
371
|
+
- Client transport options: None
|
|
372
|
+
|
|
373
|
+
**Outputs**
|
|
374
|
+
|
|
375
|
+
- Client return type: `({ artifacts: ({ id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "s...`
|
|
376
|
+
- OpenAPI response codes: `200`, `404`
|
|
377
|
+
|
|
378
|
+
```ts
|
|
379
|
+
import posthog from "@utdk/posthog";
|
|
380
|
+
|
|
381
|
+
type TasksRunsLivingArtifactsListInput = Parameters<typeof posthog.tasksRunsLivingArtifactsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
382
|
+
type TasksRunsLivingArtifactsListOutput = Awaited<ReturnType<typeof posthog.tasksRunsLivingArtifactsList>>;
|
|
383
|
+
|
|
384
|
+
const result: TasksRunsLivingArtifactsListOutput = await posthog.tasksRunsLivingArtifactsList();
|
|
385
|
+
|
|
386
|
+
// Result shape (from schema): ({ artifacts: ({ id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "s...
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### `posthog.tasksRunsLivingArtifactsCreate`
|
|
390
|
+
|
|
391
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{run_id}/living_artifacts/`
|
|
392
|
+
- **What it does**: Create a living artifact for a task run
|
|
393
|
+
- **OpenAPI operationId**: `tasks_runs_living_artifacts_create`
|
|
394
|
+
- **Path params**: `run_id`, `task_id`
|
|
395
|
+
- **Query params**: None
|
|
396
|
+
- **Response codes**: `200`, `400`, `404`
|
|
397
|
+
- **Transport options**: None
|
|
398
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
399
|
+
|
|
400
|
+
**Inputs**
|
|
401
|
+
|
|
402
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
403
|
+
- Client transport options: None
|
|
404
|
+
|
|
405
|
+
**Outputs**
|
|
406
|
+
|
|
407
|
+
- Client return type: `{ id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...`
|
|
408
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type TasksRunsLivingArtifactsCreateInput = Parameters<typeof posthog.tasksRunsLivingArtifactsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type TasksRunsLivingArtifactsCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsLivingArtifactsCreate>>;
|
|
415
|
+
|
|
416
|
+
const result: TasksRunsLivingArtifactsCreateOutput = await posthog.tasksRunsLivingArtifactsCreate();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): { id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.tasksRunsLivingArtifactsOpen`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{run_id}/living_artifacts/{id}/`
|
|
424
|
+
- **What it does**: Open a living artifact for a task run
|
|
425
|
+
- **OpenAPI operationId**: `tasks_runs_living_artifacts_open`
|
|
426
|
+
- **Path params**: `id`, `run_id`, `task_id`
|
|
427
|
+
- **Query params**: None
|
|
428
|
+
- **Response codes**: `200`, `404`
|
|
429
|
+
- **Transport options**: None
|
|
430
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
431
|
+
|
|
432
|
+
**Inputs**
|
|
433
|
+
|
|
434
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
435
|
+
- Client transport options: None
|
|
436
|
+
|
|
437
|
+
**Outputs**
|
|
438
|
+
|
|
439
|
+
- Client return type: `{ id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...`
|
|
440
|
+
- OpenAPI response codes: `200`, `404`
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import posthog from "@utdk/posthog";
|
|
444
|
+
|
|
445
|
+
type TasksRunsLivingArtifactsOpenInput = Parameters<typeof posthog.tasksRunsLivingArtifactsOpen> extends [infer T, ...unknown[]] ? T : undefined;
|
|
446
|
+
type TasksRunsLivingArtifactsOpenOutput = Awaited<ReturnType<typeof posthog.tasksRunsLivingArtifactsOpen>>;
|
|
447
|
+
|
|
448
|
+
const result: TasksRunsLivingArtifactsOpenOutput = await posthog.tasksRunsLivingArtifactsOpen();
|
|
449
|
+
|
|
450
|
+
// Result shape (from schema): { id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
### `posthog.tasksRunsLivingArtifactsEdit`
|
|
454
|
+
|
|
455
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{run_id}/living_artifacts/{id}/edit/`
|
|
456
|
+
- **What it does**: Edit a living artifact for a task run
|
|
457
|
+
- **OpenAPI operationId**: `tasks_runs_living_artifacts_edit`
|
|
458
|
+
- **Path params**: `id`, `run_id`, `task_id`
|
|
459
|
+
- **Query params**: None
|
|
460
|
+
- **Response codes**: `200`, `400`, `404`
|
|
461
|
+
- **Transport options**: None
|
|
462
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
463
|
+
|
|
464
|
+
**Inputs**
|
|
465
|
+
|
|
466
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
467
|
+
- Client transport options: None
|
|
468
|
+
|
|
469
|
+
**Outputs**
|
|
470
|
+
|
|
471
|
+
- Client return type: `{ id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...`
|
|
472
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
473
|
+
|
|
474
|
+
```ts
|
|
475
|
+
import posthog from "@utdk/posthog";
|
|
476
|
+
|
|
477
|
+
type TasksRunsLivingArtifactsEditInput = Parameters<typeof posthog.tasksRunsLivingArtifactsEdit> extends [infer T, ...unknown[]] ? T : undefined;
|
|
478
|
+
type TasksRunsLivingArtifactsEditOutput = Awaited<ReturnType<typeof posthog.tasksRunsLivingArtifactsEdit>>;
|
|
479
|
+
|
|
480
|
+
const result: TasksRunsLivingArtifactsEditOutput = await posthog.tasksRunsLivingArtifactsEdit();
|
|
481
|
+
|
|
482
|
+
// Result shape (from schema): { id: string; task_id: string; run_id: string; team_id: number; name: string; artifact_type: "slack_message" | "slack_canvas" | "document" | "spreadsheet" | "dashboard" | "file" | "github_pr"; adapter: "slack_message" |...
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### `posthog.tasksThreadMessagesList`
|
|
486
|
+
|
|
487
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/thread_messages/`
|
|
488
|
+
- **What it does**: List thread messages
|
|
489
|
+
- **OpenAPI operationId**: `tasks_thread_messages_list`
|
|
490
|
+
- **Path params**: `task_id`
|
|
491
|
+
- **Query params**: `limit`, `offset`
|
|
492
|
+
- **Response codes**: `200`
|
|
493
|
+
- **Transport options**: None
|
|
494
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
495
|
+
|
|
496
|
+
**Inputs**
|
|
497
|
+
|
|
498
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
499
|
+
- Client transport options: None
|
|
500
|
+
|
|
501
|
+
**Outputs**
|
|
502
|
+
|
|
503
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; l...`
|
|
504
|
+
- OpenAPI response codes: `200`
|
|
505
|
+
|
|
506
|
+
```ts
|
|
507
|
+
import posthog from "@utdk/posthog";
|
|
508
|
+
|
|
509
|
+
type TasksThreadMessagesListInput = Parameters<typeof posthog.tasksThreadMessagesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
510
|
+
type TasksThreadMessagesListOutput = Awaited<ReturnType<typeof posthog.tasksThreadMessagesList>>;
|
|
511
|
+
|
|
512
|
+
const result: TasksThreadMessagesListOutput = await posthog.tasksThreadMessagesList();
|
|
513
|
+
|
|
514
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; l...
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### `posthog.tasksThreadMessagesCreate`
|
|
518
|
+
|
|
519
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/thread_messages/`
|
|
520
|
+
- **What it does**: Post a thread message
|
|
521
|
+
- **OpenAPI operationId**: `tasks_thread_messages_create`
|
|
522
|
+
- **Path params**: `task_id`
|
|
523
|
+
- **Query params**: None
|
|
524
|
+
- **Response codes**: `201`
|
|
525
|
+
- **Transport options**: None
|
|
526
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
527
|
+
|
|
528
|
+
**Inputs**
|
|
529
|
+
|
|
530
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
531
|
+
- Client transport options: None
|
|
532
|
+
|
|
533
|
+
**Outputs**
|
|
534
|
+
|
|
535
|
+
- Client return type: `{ id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; last_name: string; email: string; is_email_verified?: boolean | null; hedgeh...`
|
|
536
|
+
- OpenAPI response codes: `201`
|
|
537
|
+
|
|
538
|
+
```ts
|
|
539
|
+
import posthog from "@utdk/posthog";
|
|
540
|
+
|
|
541
|
+
type TasksThreadMessagesCreateInput = Parameters<typeof posthog.tasksThreadMessagesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
542
|
+
type TasksThreadMessagesCreateOutput = Awaited<ReturnType<typeof posthog.tasksThreadMessagesCreate>>;
|
|
543
|
+
|
|
544
|
+
const result: TasksThreadMessagesCreateOutput = await posthog.tasksThreadMessagesCreate();
|
|
545
|
+
|
|
546
|
+
// Result shape (from schema): { id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; last_name: string; email: string; is_email_verified?: boolean | null; hedgeh...
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### `posthog.tasksThreadMessagesDestroy`
|
|
550
|
+
|
|
551
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/tasks/{task_id}/thread_messages/{id}/`
|
|
552
|
+
- **What it does**: Delete own thread message
|
|
553
|
+
- **OpenAPI operationId**: `tasks_thread_messages_destroy`
|
|
554
|
+
- **Path params**: `id`, `task_id`
|
|
555
|
+
- **Query params**: None
|
|
556
|
+
- **Response codes**: `204`
|
|
557
|
+
- **Transport options**: None
|
|
558
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
559
|
+
|
|
560
|
+
**Inputs**
|
|
561
|
+
|
|
562
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
563
|
+
- Client transport options: None
|
|
564
|
+
|
|
565
|
+
**Outputs**
|
|
566
|
+
|
|
567
|
+
- Client return type: `unknown`
|
|
568
|
+
- OpenAPI response codes: `204`
|
|
569
|
+
|
|
570
|
+
```ts
|
|
571
|
+
import posthog from "@utdk/posthog";
|
|
572
|
+
|
|
573
|
+
type TasksThreadMessagesDestroyInput = Parameters<typeof posthog.tasksThreadMessagesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
574
|
+
type TasksThreadMessagesDestroyOutput = Awaited<ReturnType<typeof posthog.tasksThreadMessagesDestroy>>;
|
|
575
|
+
|
|
576
|
+
const result: TasksThreadMessagesDestroyOutput = await posthog.tasksThreadMessagesDestroy();
|
|
577
|
+
|
|
578
|
+
// Result shape (from schema): unknown
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
### `posthog.tasksThreadMessagesSendToAgentCreate`
|
|
582
|
+
|
|
583
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/thread_messages/{id}/send_to_agent/`
|
|
584
|
+
- **What it does**: Send a thread message to the agent
|
|
585
|
+
- **OpenAPI operationId**: `tasks_thread_messages_send_to_agent_create`
|
|
586
|
+
- **Path params**: `id`, `task_id`
|
|
587
|
+
- **Query params**: None
|
|
588
|
+
- **Response codes**: `200`, `400`
|
|
589
|
+
- **Transport options**: None
|
|
590
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
591
|
+
|
|
592
|
+
**Inputs**
|
|
593
|
+
|
|
594
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
595
|
+
- Client transport options: None
|
|
596
|
+
|
|
597
|
+
**Outputs**
|
|
598
|
+
|
|
599
|
+
- Client return type: `{ id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; last_name: string; email: string; is_email_verified?: boolean | null; hedgeh...`
|
|
600
|
+
- OpenAPI response codes: `200`, `400`
|
|
601
|
+
|
|
602
|
+
```ts
|
|
603
|
+
import posthog from "@utdk/posthog";
|
|
604
|
+
|
|
605
|
+
type TasksThreadMessagesSendToAgentCreateInput = Parameters<typeof posthog.tasksThreadMessagesSendToAgentCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
606
|
+
type TasksThreadMessagesSendToAgentCreateOutput = Awaited<ReturnType<typeof posthog.tasksThreadMessagesSendToAgentCreate>>;
|
|
607
|
+
|
|
608
|
+
const result: TasksThreadMessagesSendToAgentCreateOutput = await posthog.tasksThreadMessagesSendToAgentCreate();
|
|
609
|
+
|
|
610
|
+
// Result shape (from schema): { id: string; task: string; content: string; created_at: string; author?: { id: number; uuid: string; distinct_id: string; first_name: string; last_name: string; email: string; is_email_verified?: boolean | null; hedgeh...
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
### `posthog.tasksRepositoriesRetrieve`
|
|
614
|
+
|
|
615
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/repositories/`
|
|
616
|
+
- **What it does**: List distinct task repositories
|
|
617
|
+
- **OpenAPI operationId**: `tasks_repositories_retrieve`
|
|
618
|
+
- **Path params**: None
|
|
619
|
+
- **Query params**: None
|
|
620
|
+
- **Response codes**: `200`
|
|
621
|
+
- **Transport options**: None
|
|
622
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
623
|
+
|
|
624
|
+
**Inputs**
|
|
625
|
+
|
|
626
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
627
|
+
- Client transport options: None
|
|
628
|
+
|
|
629
|
+
**Outputs**
|
|
630
|
+
|
|
631
|
+
- Client return type: `{ repositories: (string)[] }`
|
|
632
|
+
- OpenAPI response codes: `200`
|
|
633
|
+
|
|
634
|
+
```ts
|
|
635
|
+
import posthog from "@utdk/posthog";
|
|
636
|
+
|
|
637
|
+
type TasksRepositoriesRetrieveInput = Parameters<typeof posthog.tasksRepositoriesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
638
|
+
type TasksRepositoriesRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRepositoriesRetrieve>>;
|
|
639
|
+
|
|
640
|
+
const result: TasksRepositoriesRetrieveOutput = await posthog.tasksRepositoriesRetrieve();
|
|
641
|
+
|
|
642
|
+
// Result shape (from schema): { repositories: (string)[] }
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### `posthog.tasksRepositoryReadinessRetrieve`
|
|
646
|
+
|
|
647
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/repository_readiness/`
|
|
648
|
+
- **What it does**: Get repository readiness
|
|
649
|
+
- **OpenAPI operationId**: `tasks_repository_readiness_retrieve`
|
|
650
|
+
- **Path params**: None
|
|
651
|
+
- **Query params**: `refresh`, `repository`, `window_days`
|
|
652
|
+
- **Response codes**: `200`
|
|
653
|
+
- **Transport options**: None
|
|
654
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
655
|
+
|
|
656
|
+
**Inputs**
|
|
657
|
+
|
|
658
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
659
|
+
- Client transport options: None
|
|
660
|
+
|
|
661
|
+
**Outputs**
|
|
662
|
+
|
|
663
|
+
- Client return type: `{ repository: string; classification: string; excluded: boolean; coreSuggestions: { state: "needs_setup" | "detected" | "waiting_for_data" | "ready" | "not_applicable" | "unknown"; estimated: boolean; reason: string; ev...`
|
|
664
|
+
- OpenAPI response codes: `200`
|
|
665
|
+
|
|
666
|
+
```ts
|
|
667
|
+
import posthog from "@utdk/posthog";
|
|
668
|
+
|
|
669
|
+
type TasksRepositoryReadinessRetrieveInput = Parameters<typeof posthog.tasksRepositoryReadinessRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
670
|
+
type TasksRepositoryReadinessRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRepositoryReadinessRetrieve>>;
|
|
671
|
+
|
|
672
|
+
const result: TasksRepositoryReadinessRetrieveOutput = await posthog.tasksRepositoryReadinessRetrieve();
|
|
673
|
+
|
|
674
|
+
// Result shape (from schema): { repository: string; classification: string; excluded: boolean; coreSuggestions: { state: "needs_setup" | "detected" | "waiting_for_data" | "ready" | "not_applicable" | "unknown"; estimated: boolean; reason: string; ev...
|
|
675
|
+
```
|
|
676
|
+
|
|
677
|
+
### `posthog.tasksSlackThreadContextRetrieve`
|
|
678
|
+
|
|
679
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/slack_thread_context/`
|
|
680
|
+
- **What it does**: Resolve a Slack thread to its task, runs, and Temporal workflows
|
|
681
|
+
- **OpenAPI operationId**: `tasks_slack_thread_context_retrieve`
|
|
682
|
+
- **Path params**: None
|
|
683
|
+
- **Query params**: `url`
|
|
684
|
+
- **Response codes**: `200`, `400`, `403`, `404`
|
|
685
|
+
- **Transport options**: None
|
|
686
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
687
|
+
|
|
688
|
+
**Inputs**
|
|
689
|
+
|
|
690
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
691
|
+
- Client transport options: None
|
|
692
|
+
|
|
693
|
+
**Outputs**
|
|
694
|
+
|
|
695
|
+
- Client return type: `{ thread: { url: string; channel: string; thread_ts: string; slack_workspace_id: string | null; mentioning_slack_user_id: string | null }; task: { id: string; team_id: number; title: string; repository: string | null; o...`
|
|
696
|
+
- OpenAPI response codes: `200`, `400`, `403`, `404`
|
|
697
|
+
|
|
698
|
+
```ts
|
|
699
|
+
import posthog from "@utdk/posthog";
|
|
700
|
+
|
|
701
|
+
type TasksSlackThreadContextRetrieveInput = Parameters<typeof posthog.tasksSlackThreadContextRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
702
|
+
type TasksSlackThreadContextRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksSlackThreadContextRetrieve>>;
|
|
703
|
+
|
|
704
|
+
const result: TasksSlackThreadContextRetrieveOutput = await posthog.tasksSlackThreadContextRetrieve();
|
|
705
|
+
|
|
706
|
+
// Result shape (from schema): { thread: { url: string; channel: string; thread_ts: string; slack_workspace_id: string | null; mentioning_slack_user_id: string | null }; task: { id: string; team_id: number; title: string; repository: string | null; o...
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
### `posthog.tasksSummariesCreate`
|
|
710
|
+
|
|
711
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/summaries/`
|
|
712
|
+
- **What it does**: Fetch task summaries by ID
|
|
713
|
+
- **OpenAPI operationId**: `tasks_summaries_create`
|
|
714
|
+
- **Path params**: None
|
|
715
|
+
- **Query params**: `limit`, `offset`
|
|
716
|
+
- **Response codes**: `200`
|
|
717
|
+
- **Transport options**: None
|
|
718
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
719
|
+
|
|
720
|
+
**Inputs**
|
|
721
|
+
|
|
722
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
723
|
+
- Client transport options: None
|
|
724
|
+
|
|
725
|
+
**Outputs**
|
|
726
|
+
|
|
727
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; title: string; repository: string | null; created_at: string; updated_at: string; origin_product?: string; latest_run?: { status: ...`
|
|
728
|
+
- OpenAPI response codes: `200`
|
|
729
|
+
|
|
730
|
+
```ts
|
|
731
|
+
import posthog from "@utdk/posthog";
|
|
732
|
+
|
|
733
|
+
type TasksSummariesCreateInput = Parameters<typeof posthog.tasksSummariesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
734
|
+
type TasksSummariesCreateOutput = Awaited<ReturnType<typeof posthog.tasksSummariesCreate>>;
|
|
735
|
+
|
|
736
|
+
const result: TasksSummariesCreateOutput = await posthog.tasksSummariesCreate();
|
|
737
|
+
|
|
738
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; title: string; repository: string | null; created_at: string; updated_at: string; origin_product?: string; latest_run?: { status: ...
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### `posthog.tasksWarmCreate`
|
|
742
|
+
|
|
743
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/warm/`
|
|
744
|
+
- **What it does**: Warm a task sandbox
|
|
745
|
+
- **OpenAPI operationId**: `tasks_warm_create`
|
|
746
|
+
- **Path params**: None
|
|
747
|
+
- **Query params**: None
|
|
748
|
+
- **Response codes**: `200`
|
|
749
|
+
- **Transport options**: None
|
|
750
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
751
|
+
|
|
752
|
+
**Inputs**
|
|
753
|
+
|
|
754
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
755
|
+
- Client transport options: None
|
|
756
|
+
|
|
757
|
+
**Outputs**
|
|
758
|
+
|
|
759
|
+
- Client return type: `{ task_id: string; run_id: string }`
|
|
760
|
+
- OpenAPI response codes: `200`
|
|
761
|
+
|
|
762
|
+
```ts
|
|
763
|
+
import posthog from "@utdk/posthog";
|
|
764
|
+
|
|
765
|
+
type TasksWarmCreateInput = Parameters<typeof posthog.tasksWarmCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
766
|
+
type TasksWarmCreateOutput = Awaited<ReturnType<typeof posthog.tasksWarmCreate>>;
|
|
767
|
+
|
|
768
|
+
const result: TasksWarmCreateOutput = await posthog.tasksWarmCreate();
|
|
769
|
+
|
|
770
|
+
// Result shape (from schema): { task_id: string; run_id: string }
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<!-- prompt-hash:
|
|
775
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
776
|
+
-->
|