@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.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
@@ -0,0 +1,446 @@
1
+ # Taggers
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsTaggersList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/taggers/`
8
+ - **OpenAPI operationId**: `environments_taggers_list`
9
+ - **Path params**: None
10
+ - **Query params**: `enabled`, `id__in`, `limit`, `offset`, `order_by`, `search`
11
+ - **Response codes**: `200`
12
+ - **Transport options**: None
13
+ - **TypeScript**: [Client interface](../types.ts)
14
+
15
+ **Inputs**
16
+
17
+ - Client input type: `{ [key: string]: unknown }`
18
+ - Client transport options: None
19
+
20
+ **Outputs**
21
+
22
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsTaggersListInput = Parameters<typeof posthog.environmentsTaggersList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsTaggersListOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersList>>;
30
+
31
+ const result: EnvironmentsTaggersListOutput = await posthog.environmentsTaggersList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name...
34
+ ```
35
+
36
+ ### `posthog.environmentsTaggersCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/taggers/`
39
+ - **OpenAPI operationId**: `environments_taggers_create`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `201`
43
+ - **Transport options**: None
44
+ - **TypeScript**: [Client interface](../types.ts)
45
+
46
+ **Inputs**
47
+
48
+ - Client input type: `{ [key: string]: unknown }`
49
+ - Client transport options: None
50
+
51
+ **Outputs**
52
+
53
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsTaggersCreateInput = Parameters<typeof posthog.environmentsTaggersCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsTaggersCreateOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersCreate>>;
61
+
62
+ const result: EnvironmentsTaggersCreateOutput = await posthog.environmentsTaggersCreate();
63
+
64
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
65
+ ```
66
+
67
+ ### `posthog.environmentsTaggersDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/taggers/{id}/`
70
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
71
+ - **OpenAPI operationId**: `environments_taggers_destroy`
72
+ - **Path params**: `id`
73
+ - **Query params**: None
74
+ - **Response codes**: `405`
75
+ - **Transport options**: None
76
+ - **TypeScript**: [Client interface](../types.ts)
77
+
78
+ **Inputs**
79
+
80
+ - Client input type: `{ [key: string]: unknown }`
81
+ - Client transport options: None
82
+
83
+ **Outputs**
84
+
85
+ - Client return type: `unknown`
86
+ - OpenAPI response codes: `405`
87
+
88
+ ```ts
89
+ import posthog from "@utdk/posthog";
90
+
91
+ type EnvironmentsTaggersDestroyInput = Parameters<typeof posthog.environmentsTaggersDestroy> extends [infer T, ...unknown[]] ? T : undefined;
92
+ type EnvironmentsTaggersDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersDestroy>>;
93
+
94
+ const result: EnvironmentsTaggersDestroyOutput = await posthog.environmentsTaggersDestroy();
95
+
96
+ // Result shape (from schema): unknown
97
+ ```
98
+
99
+ ### `posthog.environmentsTaggersRetrieve`
100
+
101
+ - **HTTP**: `GET /api/environments/{environment_id}/taggers/{id}/`
102
+ - **OpenAPI operationId**: `environments_taggers_retrieve`
103
+ - **Path params**: `id`
104
+ - **Query params**: None
105
+ - **Response codes**: `200`
106
+ - **Transport options**: None
107
+ - **TypeScript**: [Client interface](../types.ts)
108
+
109
+ **Inputs**
110
+
111
+ - Client input type: `{ [key: string]: unknown }`
112
+ - Client transport options: None
113
+
114
+ **Outputs**
115
+
116
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
117
+ - OpenAPI response codes: `200`
118
+
119
+ ```ts
120
+ import posthog from "@utdk/posthog";
121
+
122
+ type EnvironmentsTaggersRetrieveInput = Parameters<typeof posthog.environmentsTaggersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
123
+ type EnvironmentsTaggersRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersRetrieve>>;
124
+
125
+ const result: EnvironmentsTaggersRetrieveOutput = await posthog.environmentsTaggersRetrieve();
126
+
127
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
128
+ ```
129
+
130
+ ### `posthog.environmentsTaggersPartialUpdate`
131
+
132
+ - **HTTP**: `PATCH /api/environments/{environment_id}/taggers/{id}/`
133
+ - **OpenAPI operationId**: `environments_taggers_partial_update`
134
+ - **Path params**: `id`
135
+ - **Query params**: None
136
+ - **Response codes**: `200`
137
+ - **Transport options**: None
138
+ - **TypeScript**: [Client interface](../types.ts)
139
+
140
+ **Inputs**
141
+
142
+ - Client input type: `{ [key: string]: unknown }`
143
+ - Client transport options: None
144
+
145
+ **Outputs**
146
+
147
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
148
+ - OpenAPI response codes: `200`
149
+
150
+ ```ts
151
+ import posthog from "@utdk/posthog";
152
+
153
+ type EnvironmentsTaggersPartialUpdateInput = Parameters<typeof posthog.environmentsTaggersPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
154
+ type EnvironmentsTaggersPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersPartialUpdate>>;
155
+
156
+ const result: EnvironmentsTaggersPartialUpdateOutput = await posthog.environmentsTaggersPartialUpdate();
157
+
158
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
159
+ ```
160
+
161
+ ### `posthog.environmentsTaggersUpdate`
162
+
163
+ - **HTTP**: `PUT /api/environments/{environment_id}/taggers/{id}/`
164
+ - **OpenAPI operationId**: `environments_taggers_update`
165
+ - **Path params**: `id`
166
+ - **Query params**: None
167
+ - **Response codes**: `200`
168
+ - **Transport options**: None
169
+ - **TypeScript**: [Client interface](../types.ts)
170
+
171
+ **Inputs**
172
+
173
+ - Client input type: `{ [key: string]: unknown }`
174
+ - Client transport options: None
175
+
176
+ **Outputs**
177
+
178
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
179
+ - OpenAPI response codes: `200`
180
+
181
+ ```ts
182
+ import posthog from "@utdk/posthog";
183
+
184
+ type EnvironmentsTaggersUpdateInput = Parameters<typeof posthog.environmentsTaggersUpdate> extends [infer T, ...unknown[]] ? T : undefined;
185
+ type EnvironmentsTaggersUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersUpdate>>;
186
+
187
+ const result: EnvironmentsTaggersUpdateOutput = await posthog.environmentsTaggersUpdate();
188
+
189
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
190
+ ```
191
+
192
+ ### `posthog.environmentsTaggersTestHogCreate`
193
+
194
+ - **HTTP**: `POST /api/environments/{environment_id}/taggers/test_hog/`
195
+ - **What it does**: Test Hog tagger code against sample events without saving.
196
+ - **OpenAPI operationId**: `environments_taggers_test_hog_create`
197
+ - **Path params**: None
198
+ - **Query params**: None
199
+ - **Response codes**: `200`
200
+ - **Transport options**: None
201
+ - **TypeScript**: [Client interface](../types.ts)
202
+
203
+ **Inputs**
204
+
205
+ - Client input type: `{ [key: string]: unknown }`
206
+ - Client transport options: None
207
+
208
+ **Outputs**
209
+
210
+ - Client return type: `{ results: ({ event_uuid: string; trace_id?: string | null; input_preview: string; output_preview: string; tags: (string)[]; reasoning: string; error?: string | null })[]; message?: string }`
211
+ - OpenAPI response codes: `200`
212
+
213
+ ```ts
214
+ import posthog from "@utdk/posthog";
215
+
216
+ type EnvironmentsTaggersTestHogCreateInput = Parameters<typeof posthog.environmentsTaggersTestHogCreate> extends [infer T, ...unknown[]] ? T : undefined;
217
+ type EnvironmentsTaggersTestHogCreateOutput = Awaited<ReturnType<typeof posthog.environmentsTaggersTestHogCreate>>;
218
+
219
+ const result: EnvironmentsTaggersTestHogCreateOutput = await posthog.environmentsTaggersTestHogCreate();
220
+
221
+ // Result shape (from schema): { results: ({ event_uuid: string; trace_id?: string | null; input_preview: string; output_preview: string; tags: (string)[]; reasoning: string; error?: string | null })[]; message?: string }
222
+ ```
223
+
224
+ ### `posthog.taggersList`
225
+
226
+ - **HTTP**: `GET /api/projects/{project_id}/taggers/`
227
+ - **OpenAPI operationId**: `taggers_list`
228
+ - **Path params**: None
229
+ - **Query params**: `enabled`, `id__in`, `limit`, `offset`, `order_by`, `search`
230
+ - **Response codes**: `200`
231
+ - **Transport options**: None
232
+ - **TypeScript**: [Client interface](../types.ts)
233
+
234
+ **Inputs**
235
+
236
+ - Client input type: `{ [key: string]: unknown }`
237
+ - Client transport options: None
238
+
239
+ **Outputs**
240
+
241
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name...`
242
+ - OpenAPI response codes: `200`
243
+
244
+ ```ts
245
+ import posthog from "@utdk/posthog";
246
+
247
+ type TaggersListInput = Parameters<typeof posthog.taggersList> extends [infer T, ...unknown[]] ? T : undefined;
248
+ type TaggersListOutput = Awaited<ReturnType<typeof posthog.taggersList>>;
249
+
250
+ const result: TaggersListOutput = await posthog.taggersList();
251
+
252
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name...
253
+ ```
254
+
255
+ ### `posthog.taggersCreate`
256
+
257
+ - **HTTP**: `POST /api/projects/{project_id}/taggers/`
258
+ - **OpenAPI operationId**: `taggers_create`
259
+ - **Path params**: None
260
+ - **Query params**: None
261
+ - **Response codes**: `201`
262
+ - **Transport options**: None
263
+ - **TypeScript**: [Client interface](../types.ts)
264
+
265
+ **Inputs**
266
+
267
+ - Client input type: `{ [key: string]: unknown }`
268
+ - Client transport options: None
269
+
270
+ **Outputs**
271
+
272
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
273
+ - OpenAPI response codes: `201`
274
+
275
+ ```ts
276
+ import posthog from "@utdk/posthog";
277
+
278
+ type TaggersCreateInput = Parameters<typeof posthog.taggersCreate> extends [infer T, ...unknown[]] ? T : undefined;
279
+ type TaggersCreateOutput = Awaited<ReturnType<typeof posthog.taggersCreate>>;
280
+
281
+ const result: TaggersCreateOutput = await posthog.taggersCreate();
282
+
283
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
284
+ ```
285
+
286
+ ### `posthog.taggersDestroy`
287
+
288
+ - **HTTP**: `DELETE /api/projects/{project_id}/taggers/{id}/`
289
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
290
+ - **OpenAPI operationId**: `taggers_destroy`
291
+ - **Path params**: `id`
292
+ - **Query params**: None
293
+ - **Response codes**: `405`
294
+ - **Transport options**: None
295
+ - **TypeScript**: [Client interface](../types.ts)
296
+
297
+ **Inputs**
298
+
299
+ - Client input type: `{ [key: string]: unknown }`
300
+ - Client transport options: None
301
+
302
+ **Outputs**
303
+
304
+ - Client return type: `unknown`
305
+ - OpenAPI response codes: `405`
306
+
307
+ ```ts
308
+ import posthog from "@utdk/posthog";
309
+
310
+ type TaggersDestroyInput = Parameters<typeof posthog.taggersDestroy> extends [infer T, ...unknown[]] ? T : undefined;
311
+ type TaggersDestroyOutput = Awaited<ReturnType<typeof posthog.taggersDestroy>>;
312
+
313
+ const result: TaggersDestroyOutput = await posthog.taggersDestroy();
314
+
315
+ // Result shape (from schema): unknown
316
+ ```
317
+
318
+ ### `posthog.taggersRetrieve`
319
+
320
+ - **HTTP**: `GET /api/projects/{project_id}/taggers/{id}/`
321
+ - **OpenAPI operationId**: `taggers_retrieve`
322
+ - **Path params**: `id`
323
+ - **Query params**: None
324
+ - **Response codes**: `200`
325
+ - **Transport options**: None
326
+ - **TypeScript**: [Client interface](../types.ts)
327
+
328
+ **Inputs**
329
+
330
+ - Client input type: `{ [key: string]: unknown }`
331
+ - Client transport options: None
332
+
333
+ **Outputs**
334
+
335
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
336
+ - OpenAPI response codes: `200`
337
+
338
+ ```ts
339
+ import posthog from "@utdk/posthog";
340
+
341
+ type TaggersRetrieveInput = Parameters<typeof posthog.taggersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
342
+ type TaggersRetrieveOutput = Awaited<ReturnType<typeof posthog.taggersRetrieve>>;
343
+
344
+ const result: TaggersRetrieveOutput = await posthog.taggersRetrieve();
345
+
346
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
347
+ ```
348
+
349
+ ### `posthog.taggersPartialUpdate`
350
+
351
+ - **HTTP**: `PATCH /api/projects/{project_id}/taggers/{id}/`
352
+ - **OpenAPI operationId**: `taggers_partial_update`
353
+ - **Path params**: `id`
354
+ - **Query params**: None
355
+ - **Response codes**: `200`
356
+ - **Transport options**: None
357
+ - **TypeScript**: [Client interface](../types.ts)
358
+
359
+ **Inputs**
360
+
361
+ - Client input type: `{ [key: string]: unknown }`
362
+ - Client transport options: None
363
+
364
+ **Outputs**
365
+
366
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
367
+ - OpenAPI response codes: `200`
368
+
369
+ ```ts
370
+ import posthog from "@utdk/posthog";
371
+
372
+ type TaggersPartialUpdateInput = Parameters<typeof posthog.taggersPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
373
+ type TaggersPartialUpdateOutput = Awaited<ReturnType<typeof posthog.taggersPartialUpdate>>;
374
+
375
+ const result: TaggersPartialUpdateOutput = await posthog.taggersPartialUpdate();
376
+
377
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
378
+ ```
379
+
380
+ ### `posthog.taggersUpdate`
381
+
382
+ - **HTTP**: `PUT /api/projects/{project_id}/taggers/{id}/`
383
+ - **OpenAPI operationId**: `taggers_update`
384
+ - **Path params**: `id`
385
+ - **Query params**: None
386
+ - **Response codes**: `200`
387
+ - **Transport options**: None
388
+ - **TypeScript**: [Client interface](../types.ts)
389
+
390
+ **Inputs**
391
+
392
+ - Client input type: `{ [key: string]: unknown }`
393
+ - Client transport options: None
394
+
395
+ **Outputs**
396
+
397
+ - Client return type: `{ id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...`
398
+ - OpenAPI response codes: `200`
399
+
400
+ ```ts
401
+ import posthog from "@utdk/posthog";
402
+
403
+ type TaggersUpdateInput = Parameters<typeof posthog.taggersUpdate> extends [infer T, ...unknown[]] ? T : undefined;
404
+ type TaggersUpdateOutput = Awaited<ReturnType<typeof posthog.taggersUpdate>>;
405
+
406
+ const result: TaggersUpdateOutput = await posthog.taggersUpdate();
407
+
408
+ // Result shape (from schema): { id: string; name: string; description?: string; enabled?: boolean; tagger_type?: "llm" | "hog"; tagger_config: { prompt: string; tags: ({ name: string; description?: string })[]; min_tags?: number; max_tags?: number |...
409
+ ```
410
+
411
+ ### `posthog.taggersTestHogCreate`
412
+
413
+ - **HTTP**: `POST /api/projects/{project_id}/taggers/test_hog/`
414
+ - **What it does**: Test Hog tagger code against sample events without saving.
415
+ - **OpenAPI operationId**: `taggers_test_hog_create`
416
+ - **Path params**: None
417
+ - **Query params**: None
418
+ - **Response codes**: `200`
419
+ - **Transport options**: None
420
+ - **TypeScript**: [Client interface](../types.ts)
421
+
422
+ **Inputs**
423
+
424
+ - Client input type: `{ [key: string]: unknown }`
425
+ - Client transport options: None
426
+
427
+ **Outputs**
428
+
429
+ - Client return type: `{ results: ({ event_uuid: string; trace_id?: string | null; input_preview: string; output_preview: string; tags: (string)[]; reasoning: string; error?: string | null })[]; message?: string }`
430
+ - OpenAPI response codes: `200`
431
+
432
+ ```ts
433
+ import posthog from "@utdk/posthog";
434
+
435
+ type TaggersTestHogCreateInput = Parameters<typeof posthog.taggersTestHogCreate> extends [infer T, ...unknown[]] ? T : undefined;
436
+ type TaggersTestHogCreateOutput = Awaited<ReturnType<typeof posthog.taggersTestHogCreate>>;
437
+
438
+ const result: TaggersTestHogCreateOutput = await posthog.taggersTestHogCreate();
439
+
440
+ // Result shape (from schema): { results: ({ event_uuid: string; trace_id?: string | null; input_preview: string; output_preview: string; tags: (string)[]; reasoning: string; error?: string | null })[]; message?: string }
441
+ ```
442
+
443
+
444
+ <!-- prompt-hash:
445
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
446
+ -->
@@ -0,0 +1,200 @@
1
+ # Task Automations
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.taskAutomationsList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/task_automations/`
8
+ - **What it does**: API for managing scheduled task automations.
9
+ - **OpenAPI operationId**: `task_automations_list`
10
+ - **Path params**: None
11
+ - **Query params**: `limit`, `offset`
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; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: str...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type TaskAutomationsListInput = Parameters<typeof posthog.taskAutomationsList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type TaskAutomationsListOutput = Awaited<ReturnType<typeof posthog.taskAutomationsList>>;
31
+
32
+ const result: TaskAutomationsListOutput = await posthog.taskAutomationsList();
33
+
34
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: str...
35
+ ```
36
+
37
+ ### `posthog.taskAutomationsCreate`
38
+
39
+ - **HTTP**: `POST /api/projects/{project_id}/task_automations/`
40
+ - **What it does**: API for managing scheduled task automations.
41
+ - **OpenAPI operationId**: `task_automations_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; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...`
56
+ - OpenAPI response codes: `201`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type TaskAutomationsCreateInput = Parameters<typeof posthog.taskAutomationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type TaskAutomationsCreateOutput = Awaited<ReturnType<typeof posthog.taskAutomationsCreate>>;
63
+
64
+ const result: TaskAutomationsCreateOutput = await posthog.taskAutomationsCreate();
65
+
66
+ // Result shape (from schema): { id: string; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...
67
+ ```
68
+
69
+ ### `posthog.taskAutomationsDestroy`
70
+
71
+ - **HTTP**: `DELETE /api/projects/{project_id}/task_automations/{id}/`
72
+ - **What it does**: API for managing scheduled task automations.
73
+ - **OpenAPI operationId**: `task_automations_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 TaskAutomationsDestroyInput = Parameters<typeof posthog.taskAutomationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type TaskAutomationsDestroyOutput = Awaited<ReturnType<typeof posthog.taskAutomationsDestroy>>;
95
+
96
+ const result: TaskAutomationsDestroyOutput = await posthog.taskAutomationsDestroy();
97
+
98
+ // Result shape (from schema): unknown
99
+ ```
100
+
101
+ ### `posthog.taskAutomationsRetrieve`
102
+
103
+ - **HTTP**: `GET /api/projects/{project_id}/task_automations/{id}/`
104
+ - **What it does**: API for managing scheduled task automations.
105
+ - **OpenAPI operationId**: `task_automations_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; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type TaskAutomationsRetrieveInput = Parameters<typeof posthog.taskAutomationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type TaskAutomationsRetrieveOutput = Awaited<ReturnType<typeof posthog.taskAutomationsRetrieve>>;
127
+
128
+ const result: TaskAutomationsRetrieveOutput = await posthog.taskAutomationsRetrieve();
129
+
130
+ // Result shape (from schema): { id: string; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...
131
+ ```
132
+
133
+ ### `posthog.taskAutomationsPartialUpdate`
134
+
135
+ - **HTTP**: `PATCH /api/projects/{project_id}/task_automations/{id}/`
136
+ - **What it does**: API for managing scheduled task automations.
137
+ - **OpenAPI operationId**: `task_automations_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; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type TaskAutomationsPartialUpdateInput = Parameters<typeof posthog.taskAutomationsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type TaskAutomationsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.taskAutomationsPartialUpdate>>;
159
+
160
+ const result: TaskAutomationsPartialUpdateOutput = await posthog.taskAutomationsPartialUpdate();
161
+
162
+ // Result shape (from schema): { id: string; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...
163
+ ```
164
+
165
+ ### `posthog.taskAutomationsRunCreate`
166
+
167
+ - **HTTP**: `POST /api/projects/{project_id}/task_automations/{id}/run/`
168
+ - **What it does**: API for managing scheduled task automations.
169
+ - **OpenAPI operationId**: `task_automations_run_create`
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; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type TaskAutomationsRunCreateInput = Parameters<typeof posthog.taskAutomationsRunCreate> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type TaskAutomationsRunCreateOutput = Awaited<ReturnType<typeof posthog.taskAutomationsRunCreate>>;
191
+
192
+ const result: TaskAutomationsRunCreateOutput = await posthog.taskAutomationsRunCreate();
193
+
194
+ // Result shape (from schema): { id: string; name: string; prompt: string; repository: string | null; github_integration: number | null; cron_expression: string; timezone: string; template_id: string | null; enabled: boolean; last_run_at: string | nu...
195
+ ```
196
+
197
+
198
+ <!-- prompt-hash:
199
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
200
+ -->