@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,1576 @@
1
+ # Hog Flows
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsHogFlowsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/`
8
+ - **OpenAPI operationId**: `environments_hog_flows_list`
9
+ - **Path params**: None
10
+ - **Query params**: `created_at`, `created_by`, `id`, `limit`, `offset`, `status`, `updated_at`
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 | null; description: string; version: number; status: "draft" | "active" | "archived"; created_at: string; created_by...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsHogFlowsListInput = Parameters<typeof posthog.environmentsHogFlowsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsHogFlowsListOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsList>>;
30
+
31
+ const result: EnvironmentsHogFlowsListOutput = await posthog.environmentsHogFlowsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string | null; description: string; version: number; status: "draft" | "active" | "archived"; created_at: string; created_by...
34
+ ```
35
+
36
+ ### `posthog.environmentsHogFlowsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/`
39
+ - **OpenAPI operationId**: `environments_hog_flows_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 | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsHogFlowsCreateInput = Parameters<typeof posthog.environmentsHogFlowsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsHogFlowsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsCreate>>;
61
+
62
+ const result: EnvironmentsHogFlowsCreateOutput = await posthog.environmentsHogFlowsCreate();
63
+
64
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
65
+ ```
66
+
67
+ ### `posthog.environmentsHogFlowsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/hog_flows/{id}/`
70
+ - **OpenAPI operationId**: `environments_hog_flows_destroy`
71
+ - **Path params**: `id`
72
+ - **Query params**: None
73
+ - **Response codes**: `204`
74
+ - **Transport options**: None
75
+ - **TypeScript**: [Client interface](../types.ts)
76
+
77
+ **Inputs**
78
+
79
+ - Client input type: `{ [key: string]: unknown }`
80
+ - Client transport options: None
81
+
82
+ **Outputs**
83
+
84
+ - Client return type: `unknown`
85
+ - OpenAPI response codes: `204`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type EnvironmentsHogFlowsDestroyInput = Parameters<typeof posthog.environmentsHogFlowsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsHogFlowsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsDestroy>>;
92
+
93
+ const result: EnvironmentsHogFlowsDestroyOutput = await posthog.environmentsHogFlowsDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsHogFlowsRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/`
101
+ - **OpenAPI operationId**: `environments_hog_flows_retrieve`
102
+ - **Path params**: `id`
103
+ - **Query params**: None
104
+ - **Response codes**: `200`
105
+ - **Transport options**: None
106
+ - **TypeScript**: [Client interface](../types.ts)
107
+
108
+ **Inputs**
109
+
110
+ - Client input type: `{ [key: string]: unknown }`
111
+ - Client transport options: None
112
+
113
+ **Outputs**
114
+
115
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsHogFlowsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsHogFlowsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsRetrieve>>;
123
+
124
+ const result: EnvironmentsHogFlowsRetrieveOutput = await posthog.environmentsHogFlowsRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
127
+ ```
128
+
129
+ ### `posthog.environmentsHogFlowsPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/hog_flows/{id}/`
132
+ - **OpenAPI operationId**: `environments_hog_flows_partial_update`
133
+ - **Path params**: `id`
134
+ - **Query params**: None
135
+ - **Response codes**: `200`
136
+ - **Transport options**: None
137
+ - **TypeScript**: [Client interface](../types.ts)
138
+
139
+ **Inputs**
140
+
141
+ - Client input type: `{ [key: string]: unknown }`
142
+ - Client transport options: None
143
+
144
+ **Outputs**
145
+
146
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsHogFlowsPartialUpdateInput = Parameters<typeof posthog.environmentsHogFlowsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsHogFlowsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsPartialUpdate>>;
154
+
155
+ const result: EnvironmentsHogFlowsPartialUpdateOutput = await posthog.environmentsHogFlowsPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
158
+ ```
159
+
160
+ ### `posthog.environmentsHogFlowsUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/hog_flows/{id}/`
163
+ - **OpenAPI operationId**: `environments_hog_flows_update`
164
+ - **Path params**: `id`
165
+ - **Query params**: None
166
+ - **Response codes**: `200`
167
+ - **Transport options**: None
168
+ - **TypeScript**: [Client interface](../types.ts)
169
+
170
+ **Inputs**
171
+
172
+ - Client input type: `{ [key: string]: unknown }`
173
+ - Client transport options: None
174
+
175
+ **Outputs**
176
+
177
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsHogFlowsUpdateInput = Parameters<typeof posthog.environmentsHogFlowsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsHogFlowsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsUpdate>>;
185
+
186
+ const result: EnvironmentsHogFlowsUpdateOutput = await posthog.environmentsHogFlowsUpdate();
187
+
188
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
189
+ ```
190
+
191
+ ### `posthog.environmentsHogFlowsAssetsRetrieve`
192
+
193
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/assets/`
194
+ - **OpenAPI operationId**: `environments_hog_flows_assets_retrieve`
195
+ - **Path params**: `id`
196
+ - **Query params**: `action_id`, `after`, `before`, `distinct_id`, `invocation_id`, `limit`, `offset`, `parent_run_id`, `search`
197
+ - **Response codes**: `200`
198
+ - **Transport options**: None
199
+ - **TypeScript**: [Client interface](../types.ts)
200
+
201
+ **Inputs**
202
+
203
+ - Client input type: `{ [key: string]: unknown }`
204
+ - Client transport options: None
205
+
206
+ **Outputs**
207
+
208
+ - Client return type: `({ invocation_id: string; action_id: string; function_id: string; function_name: string; parent_run_id: string; kind: string; distinct_id: string; person_id: string; recipient: string; subject: string; status: string; s...`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type EnvironmentsHogFlowsAssetsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsAssetsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type EnvironmentsHogFlowsAssetsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsAssetsRetrieve>>;
216
+
217
+ const result: EnvironmentsHogFlowsAssetsRetrieveOutput = await posthog.environmentsHogFlowsAssetsRetrieve();
218
+
219
+ // Result shape (from schema): ({ invocation_id: string; action_id: string; function_id: string; function_name: string; parent_run_id: string; kind: string; distinct_id: string; person_id: string; recipient: string; subject: string; status: string; s...
220
+ ```
221
+
222
+ ### `posthog.environmentsHogFlowsAssetContentRetrieve`
223
+
224
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/assets/content/`
225
+ - **OpenAPI operationId**: `environments_hog_flows_asset_content_retrieve`
226
+ - **Path params**: `id`
227
+ - **Query params**: `action_id`, `invocation_id`
228
+ - **Response codes**: `200`
229
+ - **Transport options**: None
230
+ - **TypeScript**: [Client interface](../types.ts)
231
+
232
+ **Inputs**
233
+
234
+ - Client input type: `{ [key: string]: unknown }`
235
+ - Client transport options: None
236
+
237
+ **Outputs**
238
+
239
+ - Client return type: `string`
240
+ - OpenAPI response codes: `200`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type EnvironmentsHogFlowsAssetContentRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsAssetContentRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type EnvironmentsHogFlowsAssetContentRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsAssetContentRetrieve>>;
247
+
248
+ const result: EnvironmentsHogFlowsAssetContentRetrieveOutput = await posthog.environmentsHogFlowsAssetContentRetrieve();
249
+
250
+ // Result shape (from schema): string
251
+ ```
252
+
253
+ ### `posthog.environmentsHogFlowsBatchJobsList`
254
+
255
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/batch_jobs/`
256
+ - **OpenAPI operationId**: `environments_hog_flows_batch_jobs_list`
257
+ - **Path params**: `id`
258
+ - **Query params**: None
259
+ - **Response codes**: `200`
260
+ - **Transport options**: None
261
+ - **TypeScript**: [Client interface](../types.ts)
262
+
263
+ **Inputs**
264
+
265
+ - Client input type: `{ [key: string]: unknown }`
266
+ - Client transport options: None
267
+
268
+ **Outputs**
269
+
270
+ - Client return type: `({ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; disti...`
271
+ - OpenAPI response codes: `200`
272
+
273
+ ```ts
274
+ import posthog from "@utdk/posthog";
275
+
276
+ type EnvironmentsHogFlowsBatchJobsListInput = Parameters<typeof posthog.environmentsHogFlowsBatchJobsList> extends [infer T, ...unknown[]] ? T : undefined;
277
+ type EnvironmentsHogFlowsBatchJobsListOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsBatchJobsList>>;
278
+
279
+ const result: EnvironmentsHogFlowsBatchJobsListOutput = await posthog.environmentsHogFlowsBatchJobsList();
280
+
281
+ // Result shape (from schema): ({ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; disti...
282
+ ```
283
+
284
+ ### `posthog.environmentsHogFlowsBatchJobsCreate`
285
+
286
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/{id}/batch_jobs/`
287
+ - **OpenAPI operationId**: `environments_hog_flows_batch_jobs_create`
288
+ - **Path params**: `id`
289
+ - **Query params**: None
290
+ - **Response codes**: `200`
291
+ - **Transport options**: None
292
+ - **TypeScript**: [Client interface](../types.ts)
293
+
294
+ **Inputs**
295
+
296
+ - Client input type: `{ [key: string]: unknown }`
297
+ - Client transport options: None
298
+
299
+ **Outputs**
300
+
301
+ - Client return type: `{ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; distin...`
302
+ - OpenAPI response codes: `200`
303
+
304
+ ```ts
305
+ import posthog from "@utdk/posthog";
306
+
307
+ type EnvironmentsHogFlowsBatchJobsCreateInput = Parameters<typeof posthog.environmentsHogFlowsBatchJobsCreate> extends [infer T, ...unknown[]] ? T : undefined;
308
+ type EnvironmentsHogFlowsBatchJobsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsBatchJobsCreate>>;
309
+
310
+ const result: EnvironmentsHogFlowsBatchJobsCreateOutput = await posthog.environmentsHogFlowsBatchJobsCreate();
311
+
312
+ // Result shape (from schema): { id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; distin...
313
+ ```
314
+
315
+ ### `posthog.environmentsHogFlowsGraphPartialUpdate`
316
+
317
+ - **HTTP**: `PATCH /api/environments/{environment_id}/hog_flows/{id}/graph/`
318
+ - **OpenAPI operationId**: `environments_hog_flows_graph_partial_update`
319
+ - **Path params**: `id`
320
+ - **Query params**: None
321
+ - **Response codes**: `200`
322
+ - **Transport options**: None
323
+ - **TypeScript**: [Client interface](../types.ts)
324
+
325
+ **Inputs**
326
+
327
+ - Client input type: `{ [key: string]: unknown }`
328
+ - Client transport options: None
329
+
330
+ **Outputs**
331
+
332
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
333
+ - OpenAPI response codes: `200`
334
+
335
+ ```ts
336
+ import posthog from "@utdk/posthog";
337
+
338
+ type EnvironmentsHogFlowsGraphPartialUpdateInput = Parameters<typeof posthog.environmentsHogFlowsGraphPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
339
+ type EnvironmentsHogFlowsGraphPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsGraphPartialUpdate>>;
340
+
341
+ const result: EnvironmentsHogFlowsGraphPartialUpdateOutput = await posthog.environmentsHogFlowsGraphPartialUpdate();
342
+
343
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
344
+ ```
345
+
346
+ ### `posthog.environmentsHogFlowsInvocationResultsRetrieve`
347
+
348
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/invocation_results/`
349
+ - **OpenAPI operationId**: `environments_hog_flows_invocation_results_retrieve`
350
+ - **Path params**: `id`
351
+ - **Query params**: `after`, `before`, `distinct_id`, `limit`, `status`
352
+ - **Response codes**: `200`
353
+ - **Transport options**: None
354
+ - **TypeScript**: [Client interface](../types.ts)
355
+
356
+ **Inputs**
357
+
358
+ - Client input type: `{ [key: string]: unknown }`
359
+ - Client transport options: None
360
+
361
+ **Outputs**
362
+
363
+ - Client return type: `({ invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null; finished_at: string | null; duration_ms: numb...`
364
+ - OpenAPI response codes: `200`
365
+
366
+ ```ts
367
+ import posthog from "@utdk/posthog";
368
+
369
+ type EnvironmentsHogFlowsInvocationResultsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsInvocationResultsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
370
+ type EnvironmentsHogFlowsInvocationResultsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsInvocationResultsRetrieve>>;
371
+
372
+ const result: EnvironmentsHogFlowsInvocationResultsRetrieveOutput = await posthog.environmentsHogFlowsInvocationResultsRetrieve();
373
+
374
+ // Result shape (from schema): ({ invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null; finished_at: string | null; duration_ms: numb...
375
+ ```
376
+
377
+ ### `posthog.environmentsHogFlowsInvocationResultRetrieve`
378
+
379
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/invocation_results/{invocation_id}/`
380
+ - **OpenAPI operationId**: `environments_hog_flows_invocation_result_retrieve`
381
+ - **Path params**: `id`, `invocation_id`
382
+ - **Query params**: None
383
+ - **Response codes**: `200`
384
+ - **Transport options**: None
385
+ - **TypeScript**: [Client interface](../types.ts)
386
+
387
+ **Inputs**
388
+
389
+ - Client input type: `{ [key: string]: unknown }`
390
+ - Client transport options: None
391
+
392
+ **Outputs**
393
+
394
+ - Client return type: `{ invocation_globals: { [key: string]: unknown }; invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null...`
395
+ - OpenAPI response codes: `200`
396
+
397
+ ```ts
398
+ import posthog from "@utdk/posthog";
399
+
400
+ type EnvironmentsHogFlowsInvocationResultRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsInvocationResultRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
401
+ type EnvironmentsHogFlowsInvocationResultRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsInvocationResultRetrieve>>;
402
+
403
+ const result: EnvironmentsHogFlowsInvocationResultRetrieveOutput = await posthog.environmentsHogFlowsInvocationResultRetrieve();
404
+
405
+ // Result shape (from schema): { invocation_globals: { [key: string]: unknown }; invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null...
406
+ ```
407
+
408
+ ### `posthog.environmentsHogFlowsInvocationsCreate`
409
+
410
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/{id}/invocations/`
411
+ - **OpenAPI operationId**: `environments_hog_flows_invocations_create`
412
+ - **Path params**: `id`
413
+ - **Query params**: None
414
+ - **Response codes**: `200`
415
+ - **Transport options**: None
416
+ - **TypeScript**: [Client interface](../types.ts)
417
+
418
+ **Inputs**
419
+
420
+ - Client input type: `{ [key: string]: unknown }`
421
+ - Client transport options: None
422
+
423
+ **Outputs**
424
+
425
+ - Client return type: `unknown`
426
+ - OpenAPI response codes: `200`
427
+
428
+ ```ts
429
+ import posthog from "@utdk/posthog";
430
+
431
+ type EnvironmentsHogFlowsInvocationsCreateInput = Parameters<typeof posthog.environmentsHogFlowsInvocationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
432
+ type EnvironmentsHogFlowsInvocationsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsInvocationsCreate>>;
433
+
434
+ const result: EnvironmentsHogFlowsInvocationsCreateOutput = await posthog.environmentsHogFlowsInvocationsCreate();
435
+
436
+ // Result shape (from schema): unknown
437
+ ```
438
+
439
+ ### `posthog.environmentsHogFlowsLogsRetrieve`
440
+
441
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/logs/`
442
+ - **OpenAPI operationId**: `environments_hog_flows_logs_retrieve`
443
+ - **Path params**: `id`
444
+ - **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
445
+ - **Response codes**: `200`
446
+ - **Transport options**: None
447
+ - **TypeScript**: [Client interface](../types.ts)
448
+
449
+ **Inputs**
450
+
451
+ - Client input type: `{ [key: string]: unknown }`
452
+ - Client transport options: None
453
+
454
+ **Outputs**
455
+
456
+ - Client return type: `unknown`
457
+ - OpenAPI response codes: `200`
458
+
459
+ ```ts
460
+ import posthog from "@utdk/posthog";
461
+
462
+ type EnvironmentsHogFlowsLogsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
463
+ type EnvironmentsHogFlowsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsLogsRetrieve>>;
464
+
465
+ const result: EnvironmentsHogFlowsLogsRetrieveOutput = await posthog.environmentsHogFlowsLogsRetrieve();
466
+
467
+ // Result shape (from schema): unknown
468
+ ```
469
+
470
+ ### `posthog.environmentsHogFlowsMetricsRetrieve`
471
+
472
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/metrics/`
473
+ - **OpenAPI operationId**: `environments_hog_flows_metrics_retrieve`
474
+ - **Path params**: `id`
475
+ - **Query params**: `after`, `before`, `breakdown_by`, `instance_id`, `interval`, `kind`, `name`
476
+ - **Response codes**: `200`
477
+ - **Transport options**: None
478
+ - **TypeScript**: [Client interface](../types.ts)
479
+
480
+ **Inputs**
481
+
482
+ - Client input type: `{ [key: string]: unknown }`
483
+ - Client transport options: None
484
+
485
+ **Outputs**
486
+
487
+ - Client return type: `{ labels: (string)[]; series: ({ name: string; values: (number)[] })[] }`
488
+ - OpenAPI response codes: `200`
489
+
490
+ ```ts
491
+ import posthog from "@utdk/posthog";
492
+
493
+ type EnvironmentsHogFlowsMetricsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsMetricsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
494
+ type EnvironmentsHogFlowsMetricsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsMetricsRetrieve>>;
495
+
496
+ const result: EnvironmentsHogFlowsMetricsRetrieveOutput = await posthog.environmentsHogFlowsMetricsRetrieve();
497
+
498
+ // Result shape (from schema): { labels: (string)[]; series: ({ name: string; values: (number)[] })[] }
499
+ ```
500
+
501
+ ### `posthog.environmentsHogFlowsMetricsTotalsRetrieve`
502
+
503
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/metrics/totals/`
504
+ - **OpenAPI operationId**: `environments_hog_flows_metrics_totals_retrieve`
505
+ - **Path params**: `id`
506
+ - **Query params**: `after`, `before`, `breakdown_by`, `instance_id`, `interval`, `kind`, `name`
507
+ - **Response codes**: `200`
508
+ - **Transport options**: None
509
+ - **TypeScript**: [Client interface](../types.ts)
510
+
511
+ **Inputs**
512
+
513
+ - Client input type: `{ [key: string]: unknown }`
514
+ - Client transport options: None
515
+
516
+ **Outputs**
517
+
518
+ - Client return type: `{ totals: { [key: string]: number | undefined } }`
519
+ - OpenAPI response codes: `200`
520
+
521
+ ```ts
522
+ import posthog from "@utdk/posthog";
523
+
524
+ type EnvironmentsHogFlowsMetricsTotalsRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsMetricsTotalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
525
+ type EnvironmentsHogFlowsMetricsTotalsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsMetricsTotalsRetrieve>>;
526
+
527
+ const result: EnvironmentsHogFlowsMetricsTotalsRetrieveOutput = await posthog.environmentsHogFlowsMetricsTotalsRetrieve();
528
+
529
+ // Result shape (from schema): { totals: { [key: string]: number | undefined } }
530
+ ```
531
+
532
+ ### `posthog.environmentsHogFlowsRerunCreate`
533
+
534
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/{id}/rerun/`
535
+ - **What it does**: Rerun past invocations of this hog flow from their stored payloads.
536
+
537
+ Same shape and semantics as the hog function rerun endpoint —
538
+ proxies through to the CDP worker, which reads matching rows from
539
+ ClickHouse, rehydrates from `invocation_globals`, and re-enqueues
540
+ onto cyclotron with `is_retry=1`.
541
+
542
+ Because rerun replays historical event/person/group data, it requires
543
+ `person:read` and `group:read` on top of `hog_flow:write`.
544
+ - **OpenAPI operationId**: `environments_hog_flows_rerun_create`
545
+ - **Path params**: `id`
546
+ - **Query params**: None
547
+ - **Response codes**: `200`, `400`
548
+ - **Transport options**: None
549
+ - **TypeScript**: [Client interface](../types.ts)
550
+
551
+ **Inputs**
552
+
553
+ - Client input type: `{ [key: string]: unknown }`
554
+ - Client transport options: None
555
+
556
+ **Outputs**
557
+
558
+ - Client return type: `{ rerun_job_id: string; queued_count: number; skipped_count: number }`
559
+ - OpenAPI response codes: `200`, `400`
560
+
561
+ ```ts
562
+ import posthog from "@utdk/posthog";
563
+
564
+ type EnvironmentsHogFlowsRerunCreateInput = Parameters<typeof posthog.environmentsHogFlowsRerunCreate> extends [infer T, ...unknown[]] ? T : undefined;
565
+ type EnvironmentsHogFlowsRerunCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsRerunCreate>>;
566
+
567
+ const result: EnvironmentsHogFlowsRerunCreateOutput = await posthog.environmentsHogFlowsRerunCreate();
568
+
569
+ // Result shape (from schema): { rerun_job_id: string; queued_count: number; skipped_count: number }
570
+ ```
571
+
572
+ ### `posthog.environmentsHogFlowsSchedulesList`
573
+
574
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/{id}/schedules/`
575
+ - **OpenAPI operationId**: `environments_hog_flows_schedules_list`
576
+ - **Path params**: `id`
577
+ - **Query params**: None
578
+ - **Response codes**: `200`
579
+ - **Transport options**: None
580
+ - **TypeScript**: [Client interface](../types.ts)
581
+
582
+ **Inputs**
583
+
584
+ - Client input type: `{ [key: string]: unknown }`
585
+ - Client transport options: None
586
+
587
+ **Outputs**
588
+
589
+ - Client return type: `({ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string })[]`
590
+ - OpenAPI response codes: `200`
591
+
592
+ ```ts
593
+ import posthog from "@utdk/posthog";
594
+
595
+ type EnvironmentsHogFlowsSchedulesListInput = Parameters<typeof posthog.environmentsHogFlowsSchedulesList> extends [infer T, ...unknown[]] ? T : undefined;
596
+ type EnvironmentsHogFlowsSchedulesListOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsSchedulesList>>;
597
+
598
+ const result: EnvironmentsHogFlowsSchedulesListOutput = await posthog.environmentsHogFlowsSchedulesList();
599
+
600
+ // Result shape (from schema): ({ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string })[]
601
+ ```
602
+
603
+ ### `posthog.environmentsHogFlowsSchedulesCreate`
604
+
605
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/{id}/schedules/`
606
+ - **OpenAPI operationId**: `environments_hog_flows_schedules_create`
607
+ - **Path params**: `id`
608
+ - **Query params**: None
609
+ - **Response codes**: `200`
610
+ - **Transport options**: None
611
+ - **TypeScript**: [Client interface](../types.ts)
612
+
613
+ **Inputs**
614
+
615
+ - Client input type: `{ [key: string]: unknown }`
616
+ - Client transport options: None
617
+
618
+ **Outputs**
619
+
620
+ - Client return type: `{ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }`
621
+ - OpenAPI response codes: `200`
622
+
623
+ ```ts
624
+ import posthog from "@utdk/posthog";
625
+
626
+ type EnvironmentsHogFlowsSchedulesCreateInput = Parameters<typeof posthog.environmentsHogFlowsSchedulesCreate> extends [infer T, ...unknown[]] ? T : undefined;
627
+ type EnvironmentsHogFlowsSchedulesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsSchedulesCreate>>;
628
+
629
+ const result: EnvironmentsHogFlowsSchedulesCreateOutput = await posthog.environmentsHogFlowsSchedulesCreate();
630
+
631
+ // Result shape (from schema): { id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }
632
+ ```
633
+
634
+ ### `posthog.environmentsHogFlowsSchedulesDestroy`
635
+
636
+ - **HTTP**: `DELETE /api/environments/{environment_id}/hog_flows/{id}/schedules/{schedule_id}/`
637
+ - **OpenAPI operationId**: `environments_hog_flows_schedules_destroy`
638
+ - **Path params**: `id`, `schedule_id`
639
+ - **Query params**: None
640
+ - **Response codes**: `204`
641
+ - **Transport options**: None
642
+ - **TypeScript**: [Client interface](../types.ts)
643
+
644
+ **Inputs**
645
+
646
+ - Client input type: `{ [key: string]: unknown }`
647
+ - Client transport options: None
648
+
649
+ **Outputs**
650
+
651
+ - Client return type: `unknown`
652
+ - OpenAPI response codes: `204`
653
+
654
+ ```ts
655
+ import posthog from "@utdk/posthog";
656
+
657
+ type EnvironmentsHogFlowsSchedulesDestroyInput = Parameters<typeof posthog.environmentsHogFlowsSchedulesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
658
+ type EnvironmentsHogFlowsSchedulesDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsSchedulesDestroy>>;
659
+
660
+ const result: EnvironmentsHogFlowsSchedulesDestroyOutput = await posthog.environmentsHogFlowsSchedulesDestroy();
661
+
662
+ // Result shape (from schema): unknown
663
+ ```
664
+
665
+ ### `posthog.environmentsHogFlowsSchedulesPartialUpdate`
666
+
667
+ - **HTTP**: `PATCH /api/environments/{environment_id}/hog_flows/{id}/schedules/{schedule_id}/`
668
+ - **OpenAPI operationId**: `environments_hog_flows_schedules_partial_update`
669
+ - **Path params**: `id`, `schedule_id`
670
+ - **Query params**: None
671
+ - **Response codes**: `200`
672
+ - **Transport options**: None
673
+ - **TypeScript**: [Client interface](../types.ts)
674
+
675
+ **Inputs**
676
+
677
+ - Client input type: `{ [key: string]: unknown }`
678
+ - Client transport options: None
679
+
680
+ **Outputs**
681
+
682
+ - Client return type: `{ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }`
683
+ - OpenAPI response codes: `200`
684
+
685
+ ```ts
686
+ import posthog from "@utdk/posthog";
687
+
688
+ type EnvironmentsHogFlowsSchedulesPartialUpdateInput = Parameters<typeof posthog.environmentsHogFlowsSchedulesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
689
+ type EnvironmentsHogFlowsSchedulesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsSchedulesPartialUpdate>>;
690
+
691
+ const result: EnvironmentsHogFlowsSchedulesPartialUpdateOutput = await posthog.environmentsHogFlowsSchedulesPartialUpdate();
692
+
693
+ // Result shape (from schema): { id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }
694
+ ```
695
+
696
+ ### `posthog.environmentsHogFlowsBulkDeleteCreate`
697
+
698
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/bulk_delete/`
699
+ - **OpenAPI operationId**: `environments_hog_flows_bulk_delete_create`
700
+ - **Path params**: None
701
+ - **Query params**: None
702
+ - **Response codes**: `200`
703
+ - **Transport options**: None
704
+ - **TypeScript**: [Client interface](../types.ts)
705
+
706
+ **Inputs**
707
+
708
+ - Client input type: `{ [key: string]: unknown }`
709
+ - Client transport options: None
710
+
711
+ **Outputs**
712
+
713
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
714
+ - OpenAPI response codes: `200`
715
+
716
+ ```ts
717
+ import posthog from "@utdk/posthog";
718
+
719
+ type EnvironmentsHogFlowsBulkDeleteCreateInput = Parameters<typeof posthog.environmentsHogFlowsBulkDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
720
+ type EnvironmentsHogFlowsBulkDeleteCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsBulkDeleteCreate>>;
721
+
722
+ const result: EnvironmentsHogFlowsBulkDeleteCreateOutput = await posthog.environmentsHogFlowsBulkDeleteCreate();
723
+
724
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
725
+ ```
726
+
727
+ ### `posthog.environmentsHogFlowsMetricsGlobalRetrieve`
728
+
729
+ - **HTTP**: `GET /api/environments/{environment_id}/hog_flows/metrics/global/`
730
+ - **OpenAPI operationId**: `environments_hog_flows_metrics_global_retrieve`
731
+ - **Path params**: None
732
+ - **Query params**: `after`, `before`
733
+ - **Response codes**: `200`
734
+ - **Transport options**: None
735
+ - **TypeScript**: [Client interface](../types.ts)
736
+
737
+ **Inputs**
738
+
739
+ - Client input type: `{ [key: string]: unknown }`
740
+ - Client transport options: None
741
+
742
+ **Outputs**
743
+
744
+ - Client return type: `({ workflow_id: string; succeeded: number; failed: number })[]`
745
+ - OpenAPI response codes: `200`
746
+
747
+ ```ts
748
+ import posthog from "@utdk/posthog";
749
+
750
+ type EnvironmentsHogFlowsMetricsGlobalRetrieveInput = Parameters<typeof posthog.environmentsHogFlowsMetricsGlobalRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
751
+ type EnvironmentsHogFlowsMetricsGlobalRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsMetricsGlobalRetrieve>>;
752
+
753
+ const result: EnvironmentsHogFlowsMetricsGlobalRetrieveOutput = await posthog.environmentsHogFlowsMetricsGlobalRetrieve();
754
+
755
+ // Result shape (from schema): ({ workflow_id: string; succeeded: number; failed: number })[]
756
+ ```
757
+
758
+ ### `posthog.environmentsHogFlowsUserBlastRadiusCreate`
759
+
760
+ - **HTTP**: `POST /api/environments/{environment_id}/hog_flows/user_blast_radius/`
761
+ - **OpenAPI operationId**: `environments_hog_flows_user_blast_radius_create`
762
+ - **Path params**: None
763
+ - **Query params**: None
764
+ - **Response codes**: `200`
765
+ - **Transport options**: None
766
+ - **TypeScript**: [Client interface](../types.ts)
767
+
768
+ **Inputs**
769
+
770
+ - Client input type: `{ [key: string]: unknown }`
771
+ - Client transport options: None
772
+
773
+ **Outputs**
774
+
775
+ - Client return type: `{ affected: number; total: number; limit: number; dedupe_key: "email" | null }`
776
+ - OpenAPI response codes: `200`
777
+
778
+ ```ts
779
+ import posthog from "@utdk/posthog";
780
+
781
+ type EnvironmentsHogFlowsUserBlastRadiusCreateInput = Parameters<typeof posthog.environmentsHogFlowsUserBlastRadiusCreate> extends [infer T, ...unknown[]] ? T : undefined;
782
+ type EnvironmentsHogFlowsUserBlastRadiusCreateOutput = Awaited<ReturnType<typeof posthog.environmentsHogFlowsUserBlastRadiusCreate>>;
783
+
784
+ const result: EnvironmentsHogFlowsUserBlastRadiusCreateOutput = await posthog.environmentsHogFlowsUserBlastRadiusCreate();
785
+
786
+ // Result shape (from schema): { affected: number; total: number; limit: number; dedupe_key: "email" | null }
787
+ ```
788
+
789
+ ### `posthog.hogFlowsList`
790
+
791
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/`
792
+ - **OpenAPI operationId**: `hog_flows_list`
793
+ - **Path params**: None
794
+ - **Query params**: `created_at`, `created_by`, `id`, `limit`, `offset`, `status`, `updated_at`
795
+ - **Response codes**: `200`
796
+ - **Transport options**: None
797
+ - **TypeScript**: [Client interface](../types.ts)
798
+
799
+ **Inputs**
800
+
801
+ - Client input type: `{ [key: string]: unknown }`
802
+ - Client transport options: None
803
+
804
+ **Outputs**
805
+
806
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string | null; description: string; version: number; status: "draft" | "active" | "archived"; created_at: string; created_by...`
807
+ - OpenAPI response codes: `200`
808
+
809
+ ```ts
810
+ import posthog from "@utdk/posthog";
811
+
812
+ type HogFlowsListInput = Parameters<typeof posthog.hogFlowsList> extends [infer T, ...unknown[]] ? T : undefined;
813
+ type HogFlowsListOutput = Awaited<ReturnType<typeof posthog.hogFlowsList>>;
814
+
815
+ const result: HogFlowsListOutput = await posthog.hogFlowsList();
816
+
817
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string | null; description: string; version: number; status: "draft" | "active" | "archived"; created_at: string; created_by...
818
+ ```
819
+
820
+ ### `posthog.hogFlowsCreate`
821
+
822
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/`
823
+ - **OpenAPI operationId**: `hog_flows_create`
824
+ - **Path params**: None
825
+ - **Query params**: None
826
+ - **Response codes**: `201`
827
+ - **Transport options**: None
828
+ - **TypeScript**: [Client interface](../types.ts)
829
+
830
+ **Inputs**
831
+
832
+ - Client input type: `{ [key: string]: unknown }`
833
+ - Client transport options: None
834
+
835
+ **Outputs**
836
+
837
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
838
+ - OpenAPI response codes: `201`
839
+
840
+ ```ts
841
+ import posthog from "@utdk/posthog";
842
+
843
+ type HogFlowsCreateInput = Parameters<typeof posthog.hogFlowsCreate> extends [infer T, ...unknown[]] ? T : undefined;
844
+ type HogFlowsCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsCreate>>;
845
+
846
+ const result: HogFlowsCreateOutput = await posthog.hogFlowsCreate();
847
+
848
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
849
+ ```
850
+
851
+ ### `posthog.hogFlowsDestroy`
852
+
853
+ - **HTTP**: `DELETE /api/projects/{project_id}/hog_flows/{id}/`
854
+ - **OpenAPI operationId**: `hog_flows_destroy`
855
+ - **Path params**: `id`
856
+ - **Query params**: None
857
+ - **Response codes**: `204`
858
+ - **Transport options**: None
859
+ - **TypeScript**: [Client interface](../types.ts)
860
+
861
+ **Inputs**
862
+
863
+ - Client input type: `{ [key: string]: unknown }`
864
+ - Client transport options: None
865
+
866
+ **Outputs**
867
+
868
+ - Client return type: `unknown`
869
+ - OpenAPI response codes: `204`
870
+
871
+ ```ts
872
+ import posthog from "@utdk/posthog";
873
+
874
+ type HogFlowsDestroyInput = Parameters<typeof posthog.hogFlowsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
875
+ type HogFlowsDestroyOutput = Awaited<ReturnType<typeof posthog.hogFlowsDestroy>>;
876
+
877
+ const result: HogFlowsDestroyOutput = await posthog.hogFlowsDestroy();
878
+
879
+ // Result shape (from schema): unknown
880
+ ```
881
+
882
+ ### `posthog.hogFlowsRetrieve`
883
+
884
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/`
885
+ - **OpenAPI operationId**: `hog_flows_retrieve`
886
+ - **Path params**: `id`
887
+ - **Query params**: None
888
+ - **Response codes**: `200`
889
+ - **Transport options**: None
890
+ - **TypeScript**: [Client interface](../types.ts)
891
+
892
+ **Inputs**
893
+
894
+ - Client input type: `{ [key: string]: unknown }`
895
+ - Client transport options: None
896
+
897
+ **Outputs**
898
+
899
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
900
+ - OpenAPI response codes: `200`
901
+
902
+ ```ts
903
+ import posthog from "@utdk/posthog";
904
+
905
+ type HogFlowsRetrieveInput = Parameters<typeof posthog.hogFlowsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
906
+ type HogFlowsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsRetrieve>>;
907
+
908
+ const result: HogFlowsRetrieveOutput = await posthog.hogFlowsRetrieve();
909
+
910
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
911
+ ```
912
+
913
+ ### `posthog.hogFlowsPartialUpdate`
914
+
915
+ - **HTTP**: `PATCH /api/projects/{project_id}/hog_flows/{id}/`
916
+ - **OpenAPI operationId**: `hog_flows_partial_update`
917
+ - **Path params**: `id`
918
+ - **Query params**: None
919
+ - **Response codes**: `200`
920
+ - **Transport options**: None
921
+ - **TypeScript**: [Client interface](../types.ts)
922
+
923
+ **Inputs**
924
+
925
+ - Client input type: `{ [key: string]: unknown }`
926
+ - Client transport options: None
927
+
928
+ **Outputs**
929
+
930
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
931
+ - OpenAPI response codes: `200`
932
+
933
+ ```ts
934
+ import posthog from "@utdk/posthog";
935
+
936
+ type HogFlowsPartialUpdateInput = Parameters<typeof posthog.hogFlowsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
937
+ type HogFlowsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.hogFlowsPartialUpdate>>;
938
+
939
+ const result: HogFlowsPartialUpdateOutput = await posthog.hogFlowsPartialUpdate();
940
+
941
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
942
+ ```
943
+
944
+ ### `posthog.hogFlowsUpdate`
945
+
946
+ - **HTTP**: `PUT /api/projects/{project_id}/hog_flows/{id}/`
947
+ - **OpenAPI operationId**: `hog_flows_update`
948
+ - **Path params**: `id`
949
+ - **Query params**: None
950
+ - **Response codes**: `200`
951
+ - **Transport options**: None
952
+ - **TypeScript**: [Client interface](../types.ts)
953
+
954
+ **Inputs**
955
+
956
+ - Client input type: `{ [key: string]: unknown }`
957
+ - Client transport options: None
958
+
959
+ **Outputs**
960
+
961
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
962
+ - OpenAPI response codes: `200`
963
+
964
+ ```ts
965
+ import posthog from "@utdk/posthog";
966
+
967
+ type HogFlowsUpdateInput = Parameters<typeof posthog.hogFlowsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
968
+ type HogFlowsUpdateOutput = Awaited<ReturnType<typeof posthog.hogFlowsUpdate>>;
969
+
970
+ const result: HogFlowsUpdateOutput = await posthog.hogFlowsUpdate();
971
+
972
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
973
+ ```
974
+
975
+ ### `posthog.hogFlowsAssetsRetrieve`
976
+
977
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/assets/`
978
+ - **OpenAPI operationId**: `hog_flows_assets_retrieve`
979
+ - **Path params**: `id`
980
+ - **Query params**: `action_id`, `after`, `before`, `distinct_id`, `invocation_id`, `limit`, `offset`, `parent_run_id`, `search`
981
+ - **Response codes**: `200`
982
+ - **Transport options**: None
983
+ - **TypeScript**: [Client interface](../types.ts)
984
+
985
+ **Inputs**
986
+
987
+ - Client input type: `{ [key: string]: unknown }`
988
+ - Client transport options: None
989
+
990
+ **Outputs**
991
+
992
+ - Client return type: `({ invocation_id: string; action_id: string; function_id: string; function_name: string; parent_run_id: string; kind: string; distinct_id: string; person_id: string; recipient: string; subject: string; status: string; s...`
993
+ - OpenAPI response codes: `200`
994
+
995
+ ```ts
996
+ import posthog from "@utdk/posthog";
997
+
998
+ type HogFlowsAssetsRetrieveInput = Parameters<typeof posthog.hogFlowsAssetsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
999
+ type HogFlowsAssetsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsAssetsRetrieve>>;
1000
+
1001
+ const result: HogFlowsAssetsRetrieveOutput = await posthog.hogFlowsAssetsRetrieve();
1002
+
1003
+ // Result shape (from schema): ({ invocation_id: string; action_id: string; function_id: string; function_name: string; parent_run_id: string; kind: string; distinct_id: string; person_id: string; recipient: string; subject: string; status: string; s...
1004
+ ```
1005
+
1006
+ ### `posthog.hogFlowsAssetContentRetrieve`
1007
+
1008
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/assets/content/`
1009
+ - **OpenAPI operationId**: `hog_flows_asset_content_retrieve`
1010
+ - **Path params**: `id`
1011
+ - **Query params**: `action_id`, `invocation_id`
1012
+ - **Response codes**: `200`
1013
+ - **Transport options**: None
1014
+ - **TypeScript**: [Client interface](../types.ts)
1015
+
1016
+ **Inputs**
1017
+
1018
+ - Client input type: `{ [key: string]: unknown }`
1019
+ - Client transport options: None
1020
+
1021
+ **Outputs**
1022
+
1023
+ - Client return type: `string`
1024
+ - OpenAPI response codes: `200`
1025
+
1026
+ ```ts
1027
+ import posthog from "@utdk/posthog";
1028
+
1029
+ type HogFlowsAssetContentRetrieveInput = Parameters<typeof posthog.hogFlowsAssetContentRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1030
+ type HogFlowsAssetContentRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsAssetContentRetrieve>>;
1031
+
1032
+ const result: HogFlowsAssetContentRetrieveOutput = await posthog.hogFlowsAssetContentRetrieve();
1033
+
1034
+ // Result shape (from schema): string
1035
+ ```
1036
+
1037
+ ### `posthog.hogFlowsBatchJobsList`
1038
+
1039
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/batch_jobs/`
1040
+ - **OpenAPI operationId**: `hog_flows_batch_jobs_list`
1041
+ - **Path params**: `id`
1042
+ - **Query params**: None
1043
+ - **Response codes**: `200`
1044
+ - **Transport options**: None
1045
+ - **TypeScript**: [Client interface](../types.ts)
1046
+
1047
+ **Inputs**
1048
+
1049
+ - Client input type: `{ [key: string]: unknown }`
1050
+ - Client transport options: None
1051
+
1052
+ **Outputs**
1053
+
1054
+ - Client return type: `({ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; disti...`
1055
+ - OpenAPI response codes: `200`
1056
+
1057
+ ```ts
1058
+ import posthog from "@utdk/posthog";
1059
+
1060
+ type HogFlowsBatchJobsListInput = Parameters<typeof posthog.hogFlowsBatchJobsList> extends [infer T, ...unknown[]] ? T : undefined;
1061
+ type HogFlowsBatchJobsListOutput = Awaited<ReturnType<typeof posthog.hogFlowsBatchJobsList>>;
1062
+
1063
+ const result: HogFlowsBatchJobsListOutput = await posthog.hogFlowsBatchJobsList();
1064
+
1065
+ // Result shape (from schema): ({ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; disti...
1066
+ ```
1067
+
1068
+ ### `posthog.hogFlowsBatchJobsCreate`
1069
+
1070
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/{id}/batch_jobs/`
1071
+ - **OpenAPI operationId**: `hog_flows_batch_jobs_create`
1072
+ - **Path params**: `id`
1073
+ - **Query params**: None
1074
+ - **Response codes**: `200`
1075
+ - **Transport options**: None
1076
+ - **TypeScript**: [Client interface](../types.ts)
1077
+
1078
+ **Inputs**
1079
+
1080
+ - Client input type: `{ [key: string]: unknown }`
1081
+ - Client transport options: None
1082
+
1083
+ **Outputs**
1084
+
1085
+ - Client return type: `{ id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; distin...`
1086
+ - OpenAPI response codes: `200`
1087
+
1088
+ ```ts
1089
+ import posthog from "@utdk/posthog";
1090
+
1091
+ type HogFlowsBatchJobsCreateInput = Parameters<typeof posthog.hogFlowsBatchJobsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1092
+ type HogFlowsBatchJobsCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsBatchJobsCreate>>;
1093
+
1094
+ const result: HogFlowsBatchJobsCreateOutput = await posthog.hogFlowsBatchJobsCreate();
1095
+
1096
+ // Result shape (from schema): { id: string; status?: "waiting" | "queued" | "active" | "completed" | "cancelled" | "failed"; hog_flow: string; filters?: unknown; variables?: unknown; created_at: string; created_by: { id: number; uuid: string; distin...
1097
+ ```
1098
+
1099
+ ### `posthog.hogFlowsGraphPartialUpdate`
1100
+
1101
+ - **HTTP**: `PATCH /api/projects/{project_id}/hog_flows/{id}/graph/`
1102
+ - **OpenAPI operationId**: `hog_flows_graph_partial_update`
1103
+ - **Path params**: `id`
1104
+ - **Query params**: None
1105
+ - **Response codes**: `200`
1106
+ - **Transport options**: None
1107
+ - **TypeScript**: [Client interface](../types.ts)
1108
+
1109
+ **Inputs**
1110
+
1111
+ - Client input type: `{ [key: string]: unknown }`
1112
+ - Client transport options: None
1113
+
1114
+ **Outputs**
1115
+
1116
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
1117
+ - OpenAPI response codes: `200`
1118
+
1119
+ ```ts
1120
+ import posthog from "@utdk/posthog";
1121
+
1122
+ type HogFlowsGraphPartialUpdateInput = Parameters<typeof posthog.hogFlowsGraphPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1123
+ type HogFlowsGraphPartialUpdateOutput = Awaited<ReturnType<typeof posthog.hogFlowsGraphPartialUpdate>>;
1124
+
1125
+ const result: HogFlowsGraphPartialUpdateOutput = await posthog.hogFlowsGraphPartialUpdate();
1126
+
1127
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
1128
+ ```
1129
+
1130
+ ### `posthog.hogFlowsInvocationResultsRetrieve`
1131
+
1132
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/invocation_results/`
1133
+ - **OpenAPI operationId**: `hog_flows_invocation_results_retrieve`
1134
+ - **Path params**: `id`
1135
+ - **Query params**: `after`, `before`, `distinct_id`, `limit`, `status`
1136
+ - **Response codes**: `200`
1137
+ - **Transport options**: None
1138
+ - **TypeScript**: [Client interface](../types.ts)
1139
+
1140
+ **Inputs**
1141
+
1142
+ - Client input type: `{ [key: string]: unknown }`
1143
+ - Client transport options: None
1144
+
1145
+ **Outputs**
1146
+
1147
+ - Client return type: `({ invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null; finished_at: string | null; duration_ms: numb...`
1148
+ - OpenAPI response codes: `200`
1149
+
1150
+ ```ts
1151
+ import posthog from "@utdk/posthog";
1152
+
1153
+ type HogFlowsInvocationResultsRetrieveInput = Parameters<typeof posthog.hogFlowsInvocationResultsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1154
+ type HogFlowsInvocationResultsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsInvocationResultsRetrieve>>;
1155
+
1156
+ const result: HogFlowsInvocationResultsRetrieveOutput = await posthog.hogFlowsInvocationResultsRetrieve();
1157
+
1158
+ // Result shape (from schema): ({ invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null; finished_at: string | null; duration_ms: numb...
1159
+ ```
1160
+
1161
+ ### `posthog.hogFlowsInvocationResultRetrieve`
1162
+
1163
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/invocation_results/{invocation_id}/`
1164
+ - **OpenAPI operationId**: `hog_flows_invocation_result_retrieve`
1165
+ - **Path params**: `id`, `invocation_id`
1166
+ - **Query params**: None
1167
+ - **Response codes**: `200`
1168
+ - **Transport options**: None
1169
+ - **TypeScript**: [Client interface](../types.ts)
1170
+
1171
+ **Inputs**
1172
+
1173
+ - Client input type: `{ [key: string]: unknown }`
1174
+ - Client transport options: None
1175
+
1176
+ **Outputs**
1177
+
1178
+ - Client return type: `{ invocation_globals: { [key: string]: unknown }; invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null...`
1179
+ - OpenAPI response codes: `200`
1180
+
1181
+ ```ts
1182
+ import posthog from "@utdk/posthog";
1183
+
1184
+ type HogFlowsInvocationResultRetrieveInput = Parameters<typeof posthog.hogFlowsInvocationResultRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1185
+ type HogFlowsInvocationResultRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsInvocationResultRetrieve>>;
1186
+
1187
+ const result: HogFlowsInvocationResultRetrieveOutput = await posthog.hogFlowsInvocationResultRetrieve();
1188
+
1189
+ // Result shape (from schema): { invocation_globals: { [key: string]: unknown }; invocation_id: string; status: string; error_kind: string; error_message: string; distinct_id: string; person_id: string; scheduled_at: string; started_at: string | null...
1190
+ ```
1191
+
1192
+ ### `posthog.hogFlowsInvocationsCreate`
1193
+
1194
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/{id}/invocations/`
1195
+ - **OpenAPI operationId**: `hog_flows_invocations_create`
1196
+ - **Path params**: `id`
1197
+ - **Query params**: None
1198
+ - **Response codes**: `200`
1199
+ - **Transport options**: None
1200
+ - **TypeScript**: [Client interface](../types.ts)
1201
+
1202
+ **Inputs**
1203
+
1204
+ - Client input type: `{ [key: string]: unknown }`
1205
+ - Client transport options: None
1206
+
1207
+ **Outputs**
1208
+
1209
+ - Client return type: `unknown`
1210
+ - OpenAPI response codes: `200`
1211
+
1212
+ ```ts
1213
+ import posthog from "@utdk/posthog";
1214
+
1215
+ type HogFlowsInvocationsCreateInput = Parameters<typeof posthog.hogFlowsInvocationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
1216
+ type HogFlowsInvocationsCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsInvocationsCreate>>;
1217
+
1218
+ const result: HogFlowsInvocationsCreateOutput = await posthog.hogFlowsInvocationsCreate();
1219
+
1220
+ // Result shape (from schema): unknown
1221
+ ```
1222
+
1223
+ ### `posthog.hogFlowsLogsRetrieve`
1224
+
1225
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/logs/`
1226
+ - **OpenAPI operationId**: `hog_flows_logs_retrieve`
1227
+ - **Path params**: `id`
1228
+ - **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
1229
+ - **Response codes**: `200`
1230
+ - **Transport options**: None
1231
+ - **TypeScript**: [Client interface](../types.ts)
1232
+
1233
+ **Inputs**
1234
+
1235
+ - Client input type: `{ [key: string]: unknown }`
1236
+ - Client transport options: None
1237
+
1238
+ **Outputs**
1239
+
1240
+ - Client return type: `unknown`
1241
+ - OpenAPI response codes: `200`
1242
+
1243
+ ```ts
1244
+ import posthog from "@utdk/posthog";
1245
+
1246
+ type HogFlowsLogsRetrieveInput = Parameters<typeof posthog.hogFlowsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1247
+ type HogFlowsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsLogsRetrieve>>;
1248
+
1249
+ const result: HogFlowsLogsRetrieveOutput = await posthog.hogFlowsLogsRetrieve();
1250
+
1251
+ // Result shape (from schema): unknown
1252
+ ```
1253
+
1254
+ ### `posthog.hogFlowsMetricsRetrieve`
1255
+
1256
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/metrics/`
1257
+ - **OpenAPI operationId**: `hog_flows_metrics_retrieve`
1258
+ - **Path params**: `id`
1259
+ - **Query params**: `after`, `before`, `breakdown_by`, `instance_id`, `interval`, `kind`, `name`
1260
+ - **Response codes**: `200`
1261
+ - **Transport options**: None
1262
+ - **TypeScript**: [Client interface](../types.ts)
1263
+
1264
+ **Inputs**
1265
+
1266
+ - Client input type: `{ [key: string]: unknown }`
1267
+ - Client transport options: None
1268
+
1269
+ **Outputs**
1270
+
1271
+ - Client return type: `{ labels: (string)[]; series: ({ name: string; values: (number)[] })[] }`
1272
+ - OpenAPI response codes: `200`
1273
+
1274
+ ```ts
1275
+ import posthog from "@utdk/posthog";
1276
+
1277
+ type HogFlowsMetricsRetrieveInput = Parameters<typeof posthog.hogFlowsMetricsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1278
+ type HogFlowsMetricsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsMetricsRetrieve>>;
1279
+
1280
+ const result: HogFlowsMetricsRetrieveOutput = await posthog.hogFlowsMetricsRetrieve();
1281
+
1282
+ // Result shape (from schema): { labels: (string)[]; series: ({ name: string; values: (number)[] })[] }
1283
+ ```
1284
+
1285
+ ### `posthog.hogFlowsMetricsTotalsRetrieve`
1286
+
1287
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/metrics/totals/`
1288
+ - **OpenAPI operationId**: `hog_flows_metrics_totals_retrieve`
1289
+ - **Path params**: `id`
1290
+ - **Query params**: `after`, `before`, `breakdown_by`, `instance_id`, `interval`, `kind`, `name`
1291
+ - **Response codes**: `200`
1292
+ - **Transport options**: None
1293
+ - **TypeScript**: [Client interface](../types.ts)
1294
+
1295
+ **Inputs**
1296
+
1297
+ - Client input type: `{ [key: string]: unknown }`
1298
+ - Client transport options: None
1299
+
1300
+ **Outputs**
1301
+
1302
+ - Client return type: `{ totals: { [key: string]: number | undefined } }`
1303
+ - OpenAPI response codes: `200`
1304
+
1305
+ ```ts
1306
+ import posthog from "@utdk/posthog";
1307
+
1308
+ type HogFlowsMetricsTotalsRetrieveInput = Parameters<typeof posthog.hogFlowsMetricsTotalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1309
+ type HogFlowsMetricsTotalsRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsMetricsTotalsRetrieve>>;
1310
+
1311
+ const result: HogFlowsMetricsTotalsRetrieveOutput = await posthog.hogFlowsMetricsTotalsRetrieve();
1312
+
1313
+ // Result shape (from schema): { totals: { [key: string]: number | undefined } }
1314
+ ```
1315
+
1316
+ ### `posthog.hogFlowsRerunCreate`
1317
+
1318
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/{id}/rerun/`
1319
+ - **What it does**: Rerun past invocations of this hog flow from their stored payloads.
1320
+
1321
+ Same shape and semantics as the hog function rerun endpoint —
1322
+ proxies through to the CDP worker, which reads matching rows from
1323
+ ClickHouse, rehydrates from `invocation_globals`, and re-enqueues
1324
+ onto cyclotron with `is_retry=1`.
1325
+
1326
+ Because rerun replays historical event/person/group data, it requires
1327
+ `person:read` and `group:read` on top of `hog_flow:write`.
1328
+ - **OpenAPI operationId**: `hog_flows_rerun_create`
1329
+ - **Path params**: `id`
1330
+ - **Query params**: None
1331
+ - **Response codes**: `200`, `400`
1332
+ - **Transport options**: None
1333
+ - **TypeScript**: [Client interface](../types.ts)
1334
+
1335
+ **Inputs**
1336
+
1337
+ - Client input type: `{ [key: string]: unknown }`
1338
+ - Client transport options: None
1339
+
1340
+ **Outputs**
1341
+
1342
+ - Client return type: `{ rerun_job_id: string; queued_count: number; skipped_count: number }`
1343
+ - OpenAPI response codes: `200`, `400`
1344
+
1345
+ ```ts
1346
+ import posthog from "@utdk/posthog";
1347
+
1348
+ type HogFlowsRerunCreateInput = Parameters<typeof posthog.hogFlowsRerunCreate> extends [infer T, ...unknown[]] ? T : undefined;
1349
+ type HogFlowsRerunCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsRerunCreate>>;
1350
+
1351
+ const result: HogFlowsRerunCreateOutput = await posthog.hogFlowsRerunCreate();
1352
+
1353
+ // Result shape (from schema): { rerun_job_id: string; queued_count: number; skipped_count: number }
1354
+ ```
1355
+
1356
+ ### `posthog.hogFlowsSchedulesList`
1357
+
1358
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/{id}/schedules/`
1359
+ - **OpenAPI operationId**: `hog_flows_schedules_list`
1360
+ - **Path params**: `id`
1361
+ - **Query params**: None
1362
+ - **Response codes**: `200`
1363
+ - **Transport options**: None
1364
+ - **TypeScript**: [Client interface](../types.ts)
1365
+
1366
+ **Inputs**
1367
+
1368
+ - Client input type: `{ [key: string]: unknown }`
1369
+ - Client transport options: None
1370
+
1371
+ **Outputs**
1372
+
1373
+ - Client return type: `({ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string })[]`
1374
+ - OpenAPI response codes: `200`
1375
+
1376
+ ```ts
1377
+ import posthog from "@utdk/posthog";
1378
+
1379
+ type HogFlowsSchedulesListInput = Parameters<typeof posthog.hogFlowsSchedulesList> extends [infer T, ...unknown[]] ? T : undefined;
1380
+ type HogFlowsSchedulesListOutput = Awaited<ReturnType<typeof posthog.hogFlowsSchedulesList>>;
1381
+
1382
+ const result: HogFlowsSchedulesListOutput = await posthog.hogFlowsSchedulesList();
1383
+
1384
+ // Result shape (from schema): ({ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string })[]
1385
+ ```
1386
+
1387
+ ### `posthog.hogFlowsSchedulesCreate`
1388
+
1389
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/{id}/schedules/`
1390
+ - **OpenAPI operationId**: `hog_flows_schedules_create`
1391
+ - **Path params**: `id`
1392
+ - **Query params**: None
1393
+ - **Response codes**: `200`
1394
+ - **Transport options**: None
1395
+ - **TypeScript**: [Client interface](../types.ts)
1396
+
1397
+ **Inputs**
1398
+
1399
+ - Client input type: `{ [key: string]: unknown }`
1400
+ - Client transport options: None
1401
+
1402
+ **Outputs**
1403
+
1404
+ - Client return type: `{ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }`
1405
+ - OpenAPI response codes: `200`
1406
+
1407
+ ```ts
1408
+ import posthog from "@utdk/posthog";
1409
+
1410
+ type HogFlowsSchedulesCreateInput = Parameters<typeof posthog.hogFlowsSchedulesCreate> extends [infer T, ...unknown[]] ? T : undefined;
1411
+ type HogFlowsSchedulesCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsSchedulesCreate>>;
1412
+
1413
+ const result: HogFlowsSchedulesCreateOutput = await posthog.hogFlowsSchedulesCreate();
1414
+
1415
+ // Result shape (from schema): { id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }
1416
+ ```
1417
+
1418
+ ### `posthog.hogFlowsSchedulesDestroy`
1419
+
1420
+ - **HTTP**: `DELETE /api/projects/{project_id}/hog_flows/{id}/schedules/{schedule_id}/`
1421
+ - **OpenAPI operationId**: `hog_flows_schedules_destroy`
1422
+ - **Path params**: `id`, `schedule_id`
1423
+ - **Query params**: None
1424
+ - **Response codes**: `204`
1425
+ - **Transport options**: None
1426
+ - **TypeScript**: [Client interface](../types.ts)
1427
+
1428
+ **Inputs**
1429
+
1430
+ - Client input type: `{ [key: string]: unknown }`
1431
+ - Client transport options: None
1432
+
1433
+ **Outputs**
1434
+
1435
+ - Client return type: `unknown`
1436
+ - OpenAPI response codes: `204`
1437
+
1438
+ ```ts
1439
+ import posthog from "@utdk/posthog";
1440
+
1441
+ type HogFlowsSchedulesDestroyInput = Parameters<typeof posthog.hogFlowsSchedulesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
1442
+ type HogFlowsSchedulesDestroyOutput = Awaited<ReturnType<typeof posthog.hogFlowsSchedulesDestroy>>;
1443
+
1444
+ const result: HogFlowsSchedulesDestroyOutput = await posthog.hogFlowsSchedulesDestroy();
1445
+
1446
+ // Result shape (from schema): unknown
1447
+ ```
1448
+
1449
+ ### `posthog.hogFlowsSchedulesPartialUpdate`
1450
+
1451
+ - **HTTP**: `PATCH /api/projects/{project_id}/hog_flows/{id}/schedules/{schedule_id}/`
1452
+ - **OpenAPI operationId**: `hog_flows_schedules_partial_update`
1453
+ - **Path params**: `id`, `schedule_id`
1454
+ - **Query params**: None
1455
+ - **Response codes**: `200`
1456
+ - **Transport options**: None
1457
+ - **TypeScript**: [Client interface](../types.ts)
1458
+
1459
+ **Inputs**
1460
+
1461
+ - Client input type: `{ [key: string]: unknown }`
1462
+ - Client transport options: None
1463
+
1464
+ **Outputs**
1465
+
1466
+ - Client return type: `{ id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }`
1467
+ - OpenAPI response codes: `200`
1468
+
1469
+ ```ts
1470
+ import posthog from "@utdk/posthog";
1471
+
1472
+ type HogFlowsSchedulesPartialUpdateInput = Parameters<typeof posthog.hogFlowsSchedulesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1473
+ type HogFlowsSchedulesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.hogFlowsSchedulesPartialUpdate>>;
1474
+
1475
+ const result: HogFlowsSchedulesPartialUpdateOutput = await posthog.hogFlowsSchedulesPartialUpdate();
1476
+
1477
+ // Result shape (from schema): { id: string; rrule: string; starts_at: string; timezone?: string; variables?: unknown; status: "active" | "paused" | "completed"; next_run_at: string | null; created_at: string; updated_at: string }
1478
+ ```
1479
+
1480
+ ### `posthog.hogFlowsBulkDeleteCreate`
1481
+
1482
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/bulk_delete/`
1483
+ - **OpenAPI operationId**: `hog_flows_bulk_delete_create`
1484
+ - **Path params**: None
1485
+ - **Query params**: None
1486
+ - **Response codes**: `200`
1487
+ - **Transport options**: None
1488
+ - **TypeScript**: [Client interface](../types.ts)
1489
+
1490
+ **Inputs**
1491
+
1492
+ - Client input type: `{ [key: string]: unknown }`
1493
+ - Client transport options: None
1494
+
1495
+ **Outputs**
1496
+
1497
+ - Client return type: `{ id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...`
1498
+ - OpenAPI response codes: `200`
1499
+
1500
+ ```ts
1501
+ import posthog from "@utdk/posthog";
1502
+
1503
+ type HogFlowsBulkDeleteCreateInput = Parameters<typeof posthog.hogFlowsBulkDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
1504
+ type HogFlowsBulkDeleteCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsBulkDeleteCreate>>;
1505
+
1506
+ const result: HogFlowsBulkDeleteCreateOutput = await posthog.hogFlowsBulkDeleteCreate();
1507
+
1508
+ // Result shape (from schema): { id: string; name?: string | null; description?: string; version: number; status?: "draft" | "active" | "archived"; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: ...
1509
+ ```
1510
+
1511
+ ### `posthog.hogFlowsMetricsGlobalRetrieve`
1512
+
1513
+ - **HTTP**: `GET /api/projects/{project_id}/hog_flows/metrics/global/`
1514
+ - **OpenAPI operationId**: `hog_flows_metrics_global_retrieve`
1515
+ - **Path params**: None
1516
+ - **Query params**: `after`, `before`
1517
+ - **Response codes**: `200`
1518
+ - **Transport options**: None
1519
+ - **TypeScript**: [Client interface](../types.ts)
1520
+
1521
+ **Inputs**
1522
+
1523
+ - Client input type: `{ [key: string]: unknown }`
1524
+ - Client transport options: None
1525
+
1526
+ **Outputs**
1527
+
1528
+ - Client return type: `({ workflow_id: string; succeeded: number; failed: number })[]`
1529
+ - OpenAPI response codes: `200`
1530
+
1531
+ ```ts
1532
+ import posthog from "@utdk/posthog";
1533
+
1534
+ type HogFlowsMetricsGlobalRetrieveInput = Parameters<typeof posthog.hogFlowsMetricsGlobalRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1535
+ type HogFlowsMetricsGlobalRetrieveOutput = Awaited<ReturnType<typeof posthog.hogFlowsMetricsGlobalRetrieve>>;
1536
+
1537
+ const result: HogFlowsMetricsGlobalRetrieveOutput = await posthog.hogFlowsMetricsGlobalRetrieve();
1538
+
1539
+ // Result shape (from schema): ({ workflow_id: string; succeeded: number; failed: number })[]
1540
+ ```
1541
+
1542
+ ### `posthog.hogFlowsUserBlastRadiusCreate`
1543
+
1544
+ - **HTTP**: `POST /api/projects/{project_id}/hog_flows/user_blast_radius/`
1545
+ - **OpenAPI operationId**: `hog_flows_user_blast_radius_create`
1546
+ - **Path params**: None
1547
+ - **Query params**: None
1548
+ - **Response codes**: `200`
1549
+ - **Transport options**: None
1550
+ - **TypeScript**: [Client interface](../types.ts)
1551
+
1552
+ **Inputs**
1553
+
1554
+ - Client input type: `{ [key: string]: unknown }`
1555
+ - Client transport options: None
1556
+
1557
+ **Outputs**
1558
+
1559
+ - Client return type: `{ affected: number; total: number; limit: number; dedupe_key: "email" | null }`
1560
+ - OpenAPI response codes: `200`
1561
+
1562
+ ```ts
1563
+ import posthog from "@utdk/posthog";
1564
+
1565
+ type HogFlowsUserBlastRadiusCreateInput = Parameters<typeof posthog.hogFlowsUserBlastRadiusCreate> extends [infer T, ...unknown[]] ? T : undefined;
1566
+ type HogFlowsUserBlastRadiusCreateOutput = Awaited<ReturnType<typeof posthog.hogFlowsUserBlastRadiusCreate>>;
1567
+
1568
+ const result: HogFlowsUserBlastRadiusCreateOutput = await posthog.hogFlowsUserBlastRadiusCreate();
1569
+
1570
+ // Result shape (from schema): { affected: number; total: number; limit: number; dedupe_key: "email" | null }
1571
+ ```
1572
+
1573
+
1574
+ <!-- prompt-hash:
1575
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
1576
+ -->