@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,838 @@
1
+ # Notebooks
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.notebooksList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/`
8
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
9
+ - **OpenAPI operationId**: `notebooks_list`
10
+ - **Path params**: None
11
+ - **Query params**: `contains`, `created_by`, `date_from`, `date_to`, `limit`, `offset`, `user`
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; short_id: string; title: string | null; deleted: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type NotebooksListInput = Parameters<typeof posthog.notebooksList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type NotebooksListOutput = Awaited<ReturnType<typeof posthog.notebooksList>>;
31
+
32
+ const result: NotebooksListOutput = await posthog.notebooksList();
33
+
34
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; short_id: string; title: string | null; deleted: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?...
35
+ ```
36
+
37
+ ### `posthog.notebooksCreate`
38
+
39
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/`
40
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
41
+ - **OpenAPI operationId**: `notebooks_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; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...`
56
+ - OpenAPI response codes: `201`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type NotebooksCreateInput = Parameters<typeof posthog.notebooksCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type NotebooksCreateOutput = Awaited<ReturnType<typeof posthog.notebooksCreate>>;
63
+
64
+ const result: NotebooksCreateOutput = await posthog.notebooksCreate();
65
+
66
+ // Result shape (from schema): { id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...
67
+ ```
68
+
69
+ ### `posthog.notebooksSharingList`
70
+
71
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{notebook_id}/sharing/`
72
+ - **OpenAPI operationId**: `notebooks_sharing_list`
73
+ - **Path params**: `notebook_id`
74
+ - **Query params**: None
75
+ - **Response codes**: `200`
76
+ - **Transport options**: None
77
+ - **TypeScript**: [Client interface](../types.ts)
78
+
79
+ **Inputs**
80
+
81
+ - Client input type: `{ [key: string]: unknown }`
82
+ - Client transport options: None
83
+
84
+ **Outputs**
85
+
86
+ - Client return type: `({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...`
87
+ - OpenAPI response codes: `200`
88
+
89
+ ```ts
90
+ import posthog from "@utdk/posthog";
91
+
92
+ type NotebooksSharingListInput = Parameters<typeof posthog.notebooksSharingList> extends [infer T, ...unknown[]] ? T : undefined;
93
+ type NotebooksSharingListOutput = Awaited<ReturnType<typeof posthog.notebooksSharingList>>;
94
+
95
+ const result: NotebooksSharingListOutput = await posthog.notebooksSharingList();
96
+
97
+ // Result shape (from schema): ({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...
98
+ ```
99
+
100
+ ### `posthog.notebooksSharingPasswordsCreate`
101
+
102
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{notebook_id}/sharing/passwords/`
103
+ - **What it does**: Create a new password for the sharing configuration.
104
+ - **OpenAPI operationId**: `notebooks_sharing_passwords_create`
105
+ - **Path params**: `notebook_id`
106
+ - **Query params**: None
107
+ - **Response codes**: `200`
108
+ - **Transport options**: None
109
+ - **TypeScript**: [Client interface](../types.ts)
110
+
111
+ **Inputs**
112
+
113
+ - Client input type: `{ [key: string]: unknown }`
114
+ - Client transport options: None
115
+
116
+ **Outputs**
117
+
118
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
119
+ - OpenAPI response codes: `200`
120
+
121
+ ```ts
122
+ import posthog from "@utdk/posthog";
123
+
124
+ type NotebooksSharingPasswordsCreateInput = Parameters<typeof posthog.notebooksSharingPasswordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
125
+ type NotebooksSharingPasswordsCreateOutput = Awaited<ReturnType<typeof posthog.notebooksSharingPasswordsCreate>>;
126
+
127
+ const result: NotebooksSharingPasswordsCreateOutput = await posthog.notebooksSharingPasswordsCreate();
128
+
129
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
130
+ ```
131
+
132
+ ### `posthog.notebooksSharingPasswordsDestroy`
133
+
134
+ - **HTTP**: `DELETE /api/projects/{project_id}/notebooks/{notebook_id}/sharing/passwords/{password_id}/`
135
+ - **What it does**: Delete a password from the sharing configuration.
136
+ - **OpenAPI operationId**: `notebooks_sharing_passwords_destroy`
137
+ - **Path params**: `notebook_id`, `password_id`
138
+ - **Query params**: None
139
+ - **Response codes**: `204`
140
+ - **Transport options**: None
141
+ - **TypeScript**: [Client interface](../types.ts)
142
+
143
+ **Inputs**
144
+
145
+ - Client input type: `{ [key: string]: unknown }`
146
+ - Client transport options: None
147
+
148
+ **Outputs**
149
+
150
+ - Client return type: `unknown`
151
+ - OpenAPI response codes: `204`
152
+
153
+ ```ts
154
+ import posthog from "@utdk/posthog";
155
+
156
+ type NotebooksSharingPasswordsDestroyInput = Parameters<typeof posthog.notebooksSharingPasswordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
157
+ type NotebooksSharingPasswordsDestroyOutput = Awaited<ReturnType<typeof posthog.notebooksSharingPasswordsDestroy>>;
158
+
159
+ const result: NotebooksSharingPasswordsDestroyOutput = await posthog.notebooksSharingPasswordsDestroy();
160
+
161
+ // Result shape (from schema): unknown
162
+ ```
163
+
164
+ ### `posthog.notebooksSharingRefreshCreate`
165
+
166
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{notebook_id}/sharing/refresh/`
167
+ - **OpenAPI operationId**: `notebooks_sharing_refresh_create`
168
+ - **Path params**: `notebook_id`
169
+ - **Query params**: None
170
+ - **Response codes**: `200`
171
+ - **Transport options**: None
172
+ - **TypeScript**: [Client interface](../types.ts)
173
+
174
+ **Inputs**
175
+
176
+ - Client input type: `{ [key: string]: unknown }`
177
+ - Client transport options: None
178
+
179
+ **Outputs**
180
+
181
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
182
+ - OpenAPI response codes: `200`
183
+
184
+ ```ts
185
+ import posthog from "@utdk/posthog";
186
+
187
+ type NotebooksSharingRefreshCreateInput = Parameters<typeof posthog.notebooksSharingRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
188
+ type NotebooksSharingRefreshCreateOutput = Awaited<ReturnType<typeof posthog.notebooksSharingRefreshCreate>>;
189
+
190
+ const result: NotebooksSharingRefreshCreateOutput = await posthog.notebooksSharingRefreshCreate();
191
+
192
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
193
+ ```
194
+
195
+ ### `posthog.notebooksDestroy`
196
+
197
+ - **HTTP**: `DELETE /api/projects/{project_id}/notebooks/{short_id}/`
198
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
199
+ - **OpenAPI operationId**: `notebooks_destroy`
200
+ - **Path params**: `short_id`
201
+ - **Query params**: None
202
+ - **Response codes**: `405`
203
+ - **Transport options**: None
204
+ - **TypeScript**: [Client interface](../types.ts)
205
+
206
+ **Inputs**
207
+
208
+ - Client input type: `{ [key: string]: unknown }`
209
+ - Client transport options: None
210
+
211
+ **Outputs**
212
+
213
+ - Client return type: `unknown`
214
+ - OpenAPI response codes: `405`
215
+
216
+ ```ts
217
+ import posthog from "@utdk/posthog";
218
+
219
+ type NotebooksDestroyInput = Parameters<typeof posthog.notebooksDestroy> extends [infer T, ...unknown[]] ? T : undefined;
220
+ type NotebooksDestroyOutput = Awaited<ReturnType<typeof posthog.notebooksDestroy>>;
221
+
222
+ const result: NotebooksDestroyOutput = await posthog.notebooksDestroy();
223
+
224
+ // Result shape (from schema): unknown
225
+ ```
226
+
227
+ ### `posthog.notebooksRetrieve`
228
+
229
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{short_id}/`
230
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
231
+ - **OpenAPI operationId**: `notebooks_retrieve`
232
+ - **Path params**: `short_id`
233
+ - **Query params**: None
234
+ - **Response codes**: `200`
235
+ - **Transport options**: None
236
+ - **TypeScript**: [Client interface](../types.ts)
237
+
238
+ **Inputs**
239
+
240
+ - Client input type: `{ [key: string]: unknown }`
241
+ - Client transport options: None
242
+
243
+ **Outputs**
244
+
245
+ - Client return type: `{ id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...`
246
+ - OpenAPI response codes: `200`
247
+
248
+ ```ts
249
+ import posthog from "@utdk/posthog";
250
+
251
+ type NotebooksRetrieveInput = Parameters<typeof posthog.notebooksRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
252
+ type NotebooksRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksRetrieve>>;
253
+
254
+ const result: NotebooksRetrieveOutput = await posthog.notebooksRetrieve();
255
+
256
+ // Result shape (from schema): { id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...
257
+ ```
258
+
259
+ ### `posthog.notebooksPartialUpdate`
260
+
261
+ - **HTTP**: `PATCH /api/projects/{project_id}/notebooks/{short_id}/`
262
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
263
+ - **OpenAPI operationId**: `notebooks_partial_update`
264
+ - **Path params**: `short_id`
265
+ - **Query params**: None
266
+ - **Response codes**: `200`
267
+ - **Transport options**: None
268
+ - **TypeScript**: [Client interface](../types.ts)
269
+
270
+ **Inputs**
271
+
272
+ - Client input type: `{ [key: string]: unknown }`
273
+ - Client transport options: None
274
+
275
+ **Outputs**
276
+
277
+ - Client return type: `{ id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...`
278
+ - OpenAPI response codes: `200`
279
+
280
+ ```ts
281
+ import posthog from "@utdk/posthog";
282
+
283
+ type NotebooksPartialUpdateInput = Parameters<typeof posthog.notebooksPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
284
+ type NotebooksPartialUpdateOutput = Awaited<ReturnType<typeof posthog.notebooksPartialUpdate>>;
285
+
286
+ const result: NotebooksPartialUpdateOutput = await posthog.notebooksPartialUpdate();
287
+
288
+ // Result shape (from schema): { id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...
289
+ ```
290
+
291
+ ### `posthog.notebooksUpdate`
292
+
293
+ - **HTTP**: `PUT /api/projects/{project_id}/notebooks/{short_id}/`
294
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
295
+ - **OpenAPI operationId**: `notebooks_update`
296
+ - **Path params**: `short_id`
297
+ - **Query params**: None
298
+ - **Response codes**: `200`
299
+ - **Transport options**: None
300
+ - **TypeScript**: [Client interface](../types.ts)
301
+
302
+ **Inputs**
303
+
304
+ - Client input type: `{ [key: string]: unknown }`
305
+ - Client transport options: None
306
+
307
+ **Outputs**
308
+
309
+ - Client return type: `{ id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...`
310
+ - OpenAPI response codes: `200`
311
+
312
+ ```ts
313
+ import posthog from "@utdk/posthog";
314
+
315
+ type NotebooksUpdateInput = Parameters<typeof posthog.notebooksUpdate> extends [infer T, ...unknown[]] ? T : undefined;
316
+ type NotebooksUpdateOutput = Awaited<ReturnType<typeof posthog.notebooksUpdate>>;
317
+
318
+ const result: NotebooksUpdateOutput = await posthog.notebooksUpdate();
319
+
320
+ // Result shape (from schema): { id: string; short_id: string; title?: string | null; content?: unknown; text_content?: string | null; version?: number; deleted?: boolean; created_at: string; created_by: { id: number; uuid: string; distinct_id?: stri...
321
+ ```
322
+
323
+ ### `posthog.notebooksActivityRetrieve`
324
+
325
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{short_id}/activity/`
326
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
327
+ - **OpenAPI operationId**: `notebooks_activity_retrieve`
328
+ - **Path params**: `short_id`
329
+ - **Query params**: None
330
+ - **Response codes**: `200`
331
+ - **Transport options**: None
332
+ - **TypeScript**: [Client interface](../types.ts)
333
+
334
+ **Inputs**
335
+
336
+ - Client input type: `{ [key: string]: unknown }`
337
+ - Client transport options: None
338
+
339
+ **Outputs**
340
+
341
+ - Client return type: `unknown`
342
+ - OpenAPI response codes: `200`
343
+
344
+ ```ts
345
+ import posthog from "@utdk/posthog";
346
+
347
+ type NotebooksActivityRetrieveInput = Parameters<typeof posthog.notebooksActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
348
+ type NotebooksActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksActivityRetrieve>>;
349
+
350
+ const result: NotebooksActivityRetrieveOutput = await posthog.notebooksActivityRetrieve();
351
+
352
+ // Result shape (from schema): unknown
353
+ ```
354
+
355
+ ### `posthog.notebooksCollabMarkdownSaveCreate`
356
+
357
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/collab/markdown_save/`
358
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
359
+ - **OpenAPI operationId**: `notebooks_collab_markdown_save_create`
360
+ - **Path params**: `short_id`
361
+ - **Query params**: None
362
+ - **Response codes**: `200`
363
+ - **Transport options**: None
364
+ - **TypeScript**: [Client interface](../types.ts)
365
+
366
+ **Inputs**
367
+
368
+ - Client input type: `{ [key: string]: unknown }`
369
+ - Client transport options: None
370
+
371
+ **Outputs**
372
+
373
+ - Client return type: `unknown`
374
+ - OpenAPI response codes: `200`
375
+
376
+ ```ts
377
+ import posthog from "@utdk/posthog";
378
+
379
+ type NotebooksCollabMarkdownSaveCreateInput = Parameters<typeof posthog.notebooksCollabMarkdownSaveCreate> extends [infer T, ...unknown[]] ? T : undefined;
380
+ type NotebooksCollabMarkdownSaveCreateOutput = Awaited<ReturnType<typeof posthog.notebooksCollabMarkdownSaveCreate>>;
381
+
382
+ const result: NotebooksCollabMarkdownSaveCreateOutput = await posthog.notebooksCollabMarkdownSaveCreate();
383
+
384
+ // Result shape (from schema): unknown
385
+ ```
386
+
387
+ ### `posthog.notebooksCollabPresenceCreate`
388
+
389
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/collab/presence/`
390
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
391
+ - **OpenAPI operationId**: `notebooks_collab_presence_create`
392
+ - **Path params**: `short_id`
393
+ - **Query params**: None
394
+ - **Response codes**: `204`
395
+ - **Transport options**: None
396
+ - **TypeScript**: [Client interface](../types.ts)
397
+
398
+ **Inputs**
399
+
400
+ - Client input type: `{ [key: string]: unknown }`
401
+ - Client transport options: None
402
+
403
+ **Outputs**
404
+
405
+ - Client return type: `unknown`
406
+ - OpenAPI response codes: `204`
407
+
408
+ ```ts
409
+ import posthog from "@utdk/posthog";
410
+
411
+ type NotebooksCollabPresenceCreateInput = Parameters<typeof posthog.notebooksCollabPresenceCreate> extends [infer T, ...unknown[]] ? T : undefined;
412
+ type NotebooksCollabPresenceCreateOutput = Awaited<ReturnType<typeof posthog.notebooksCollabPresenceCreate>>;
413
+
414
+ const result: NotebooksCollabPresenceCreateOutput = await posthog.notebooksCollabPresenceCreate();
415
+
416
+ // Result shape (from schema): unknown
417
+ ```
418
+
419
+ ### `posthog.notebooksCollabSaveCreate`
420
+
421
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/collab/save/`
422
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
423
+ - **OpenAPI operationId**: `notebooks_collab_save_create`
424
+ - **Path params**: `short_id`
425
+ - **Query params**: None
426
+ - **Response codes**: `200`
427
+ - **Transport options**: None
428
+ - **TypeScript**: [Client interface](../types.ts)
429
+
430
+ **Inputs**
431
+
432
+ - Client input type: `{ [key: string]: unknown }`
433
+ - Client transport options: None
434
+
435
+ **Outputs**
436
+
437
+ - Client return type: `unknown`
438
+ - OpenAPI response codes: `200`
439
+
440
+ ```ts
441
+ import posthog from "@utdk/posthog";
442
+
443
+ type NotebooksCollabSaveCreateInput = Parameters<typeof posthog.notebooksCollabSaveCreate> extends [infer T, ...unknown[]] ? T : undefined;
444
+ type NotebooksCollabSaveCreateOutput = Awaited<ReturnType<typeof posthog.notebooksCollabSaveCreate>>;
445
+
446
+ const result: NotebooksCollabSaveCreateOutput = await posthog.notebooksCollabSaveCreate();
447
+
448
+ // Result shape (from schema): unknown
449
+ ```
450
+
451
+ ### `posthog.notebooksCollabStreamRetrieve`
452
+
453
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{short_id}/collab/stream/`
454
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
455
+ - **OpenAPI operationId**: `notebooks_collab_stream_retrieve`
456
+ - **Path params**: `short_id`
457
+ - **Query params**: None
458
+ - **Response codes**: `200`
459
+ - **Transport options**: None
460
+ - **TypeScript**: [Client interface](../types.ts)
461
+
462
+ **Inputs**
463
+
464
+ - Client input type: `{ [key: string]: unknown }`
465
+ - Client transport options: None
466
+
467
+ **Outputs**
468
+
469
+ - Client return type: `unknown`
470
+ - OpenAPI response codes: `200`
471
+
472
+ ```ts
473
+ import posthog from "@utdk/posthog";
474
+
475
+ type NotebooksCollabStreamRetrieveInput = Parameters<typeof posthog.notebooksCollabStreamRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
476
+ type NotebooksCollabStreamRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksCollabStreamRetrieve>>;
477
+
478
+ const result: NotebooksCollabStreamRetrieveOutput = await posthog.notebooksCollabStreamRetrieve();
479
+
480
+ // Result shape (from schema): unknown
481
+ ```
482
+
483
+ ### `posthog.notebooksHogqlExecuteCreate`
484
+
485
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/hogql/execute/`
486
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
487
+ - **OpenAPI operationId**: `notebooks_hogql_execute_create`
488
+ - **Path params**: `short_id`
489
+ - **Query params**: None
490
+ - **Response codes**: `200`
491
+ - **Transport options**: None
492
+ - **TypeScript**: [Client interface](../types.ts)
493
+
494
+ **Inputs**
495
+
496
+ - Client input type: `{ [key: string]: unknown }`
497
+ - Client transport options: None
498
+
499
+ **Outputs**
500
+
501
+ - Client return type: `unknown`
502
+ - OpenAPI response codes: `200`
503
+
504
+ ```ts
505
+ import posthog from "@utdk/posthog";
506
+
507
+ type NotebooksHogqlExecuteCreateInput = Parameters<typeof posthog.notebooksHogqlExecuteCreate> extends [infer T, ...unknown[]] ? T : undefined;
508
+ type NotebooksHogqlExecuteCreateOutput = Awaited<ReturnType<typeof posthog.notebooksHogqlExecuteCreate>>;
509
+
510
+ const result: NotebooksHogqlExecuteCreateOutput = await posthog.notebooksHogqlExecuteCreate();
511
+
512
+ // Result shape (from schema): unknown
513
+ ```
514
+
515
+ ### `posthog.notebooksKernelConfigCreate`
516
+
517
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/config/`
518
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
519
+ - **OpenAPI operationId**: `notebooks_kernel_config_create`
520
+ - **Path params**: `short_id`
521
+ - **Query params**: None
522
+ - **Response codes**: `200`
523
+ - **Transport options**: None
524
+ - **TypeScript**: [Client interface](../types.ts)
525
+
526
+ **Inputs**
527
+
528
+ - Client input type: `{ [key: string]: unknown }`
529
+ - Client transport options: None
530
+
531
+ **Outputs**
532
+
533
+ - Client return type: `unknown`
534
+ - OpenAPI response codes: `200`
535
+
536
+ ```ts
537
+ import posthog from "@utdk/posthog";
538
+
539
+ type NotebooksKernelConfigCreateInput = Parameters<typeof posthog.notebooksKernelConfigCreate> extends [infer T, ...unknown[]] ? T : undefined;
540
+ type NotebooksKernelConfigCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelConfigCreate>>;
541
+
542
+ const result: NotebooksKernelConfigCreateOutput = await posthog.notebooksKernelConfigCreate();
543
+
544
+ // Result shape (from schema): unknown
545
+ ```
546
+
547
+ ### `posthog.notebooksKernelDataframeRetrieve`
548
+
549
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{short_id}/kernel/dataframe/`
550
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
551
+ - **OpenAPI operationId**: `notebooks_kernel_dataframe_retrieve`
552
+ - **Path params**: `short_id`
553
+ - **Query params**: None
554
+ - **Response codes**: `200`
555
+ - **Transport options**: None
556
+ - **TypeScript**: [Client interface](../types.ts)
557
+
558
+ **Inputs**
559
+
560
+ - Client input type: `{ [key: string]: unknown }`
561
+ - Client transport options: None
562
+
563
+ **Outputs**
564
+
565
+ - Client return type: `unknown`
566
+ - OpenAPI response codes: `200`
567
+
568
+ ```ts
569
+ import posthog from "@utdk/posthog";
570
+
571
+ type NotebooksKernelDataframeRetrieveInput = Parameters<typeof posthog.notebooksKernelDataframeRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
572
+ type NotebooksKernelDataframeRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksKernelDataframeRetrieve>>;
573
+
574
+ const result: NotebooksKernelDataframeRetrieveOutput = await posthog.notebooksKernelDataframeRetrieve();
575
+
576
+ // Result shape (from schema): unknown
577
+ ```
578
+
579
+ ### `posthog.notebooksKernelExecuteCreate`
580
+
581
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/execute/`
582
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
583
+ - **OpenAPI operationId**: `notebooks_kernel_execute_create`
584
+ - **Path params**: `short_id`
585
+ - **Query params**: None
586
+ - **Response codes**: `200`
587
+ - **Transport options**: None
588
+ - **TypeScript**: [Client interface](../types.ts)
589
+
590
+ **Inputs**
591
+
592
+ - Client input type: `{ [key: string]: unknown }`
593
+ - Client transport options: None
594
+
595
+ **Outputs**
596
+
597
+ - Client return type: `unknown`
598
+ - OpenAPI response codes: `200`
599
+
600
+ ```ts
601
+ import posthog from "@utdk/posthog";
602
+
603
+ type NotebooksKernelExecuteCreateInput = Parameters<typeof posthog.notebooksKernelExecuteCreate> extends [infer T, ...unknown[]] ? T : undefined;
604
+ type NotebooksKernelExecuteCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelExecuteCreate>>;
605
+
606
+ const result: NotebooksKernelExecuteCreateOutput = await posthog.notebooksKernelExecuteCreate();
607
+
608
+ // Result shape (from schema): unknown
609
+ ```
610
+
611
+ ### `posthog.notebooksKernelExecuteStreamCreate`
612
+
613
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/execute/stream/`
614
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
615
+ - **OpenAPI operationId**: `notebooks_kernel_execute_stream_create`
616
+ - **Path params**: `short_id`
617
+ - **Query params**: None
618
+ - **Response codes**: `200`
619
+ - **Transport options**: None
620
+ - **TypeScript**: [Client interface](../types.ts)
621
+
622
+ **Inputs**
623
+
624
+ - Client input type: `{ [key: string]: unknown }`
625
+ - Client transport options: None
626
+
627
+ **Outputs**
628
+
629
+ - Client return type: `unknown`
630
+ - OpenAPI response codes: `200`
631
+
632
+ ```ts
633
+ import posthog from "@utdk/posthog";
634
+
635
+ type NotebooksKernelExecuteStreamCreateInput = Parameters<typeof posthog.notebooksKernelExecuteStreamCreate> extends [infer T, ...unknown[]] ? T : undefined;
636
+ type NotebooksKernelExecuteStreamCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelExecuteStreamCreate>>;
637
+
638
+ const result: NotebooksKernelExecuteStreamCreateOutput = await posthog.notebooksKernelExecuteStreamCreate();
639
+
640
+ // Result shape (from schema): unknown
641
+ ```
642
+
643
+ ### `posthog.notebooksKernelRestartCreate`
644
+
645
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/restart/`
646
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
647
+ - **OpenAPI operationId**: `notebooks_kernel_restart_create`
648
+ - **Path params**: `short_id`
649
+ - **Query params**: None
650
+ - **Response codes**: `200`
651
+ - **Transport options**: None
652
+ - **TypeScript**: [Client interface](../types.ts)
653
+
654
+ **Inputs**
655
+
656
+ - Client input type: `{ [key: string]: unknown }`
657
+ - Client transport options: None
658
+
659
+ **Outputs**
660
+
661
+ - Client return type: `unknown`
662
+ - OpenAPI response codes: `200`
663
+
664
+ ```ts
665
+ import posthog from "@utdk/posthog";
666
+
667
+ type NotebooksKernelRestartCreateInput = Parameters<typeof posthog.notebooksKernelRestartCreate> extends [infer T, ...unknown[]] ? T : undefined;
668
+ type NotebooksKernelRestartCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelRestartCreate>>;
669
+
670
+ const result: NotebooksKernelRestartCreateOutput = await posthog.notebooksKernelRestartCreate();
671
+
672
+ // Result shape (from schema): unknown
673
+ ```
674
+
675
+ ### `posthog.notebooksKernelStartCreate`
676
+
677
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/start/`
678
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
679
+ - **OpenAPI operationId**: `notebooks_kernel_start_create`
680
+ - **Path params**: `short_id`
681
+ - **Query params**: None
682
+ - **Response codes**: `200`
683
+ - **Transport options**: None
684
+ - **TypeScript**: [Client interface](../types.ts)
685
+
686
+ **Inputs**
687
+
688
+ - Client input type: `{ [key: string]: unknown }`
689
+ - Client transport options: None
690
+
691
+ **Outputs**
692
+
693
+ - Client return type: `unknown`
694
+ - OpenAPI response codes: `200`
695
+
696
+ ```ts
697
+ import posthog from "@utdk/posthog";
698
+
699
+ type NotebooksKernelStartCreateInput = Parameters<typeof posthog.notebooksKernelStartCreate> extends [infer T, ...unknown[]] ? T : undefined;
700
+ type NotebooksKernelStartCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelStartCreate>>;
701
+
702
+ const result: NotebooksKernelStartCreateOutput = await posthog.notebooksKernelStartCreate();
703
+
704
+ // Result shape (from schema): unknown
705
+ ```
706
+
707
+ ### `posthog.notebooksKernelStatusRetrieve`
708
+
709
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/{short_id}/kernel/status/`
710
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
711
+ - **OpenAPI operationId**: `notebooks_kernel_status_retrieve`
712
+ - **Path params**: `short_id`
713
+ - **Query params**: None
714
+ - **Response codes**: `200`
715
+ - **Transport options**: None
716
+ - **TypeScript**: [Client interface](../types.ts)
717
+
718
+ **Inputs**
719
+
720
+ - Client input type: `{ [key: string]: unknown }`
721
+ - Client transport options: None
722
+
723
+ **Outputs**
724
+
725
+ - Client return type: `unknown`
726
+ - OpenAPI response codes: `200`
727
+
728
+ ```ts
729
+ import posthog from "@utdk/posthog";
730
+
731
+ type NotebooksKernelStatusRetrieveInput = Parameters<typeof posthog.notebooksKernelStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
732
+ type NotebooksKernelStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksKernelStatusRetrieve>>;
733
+
734
+ const result: NotebooksKernelStatusRetrieveOutput = await posthog.notebooksKernelStatusRetrieve();
735
+
736
+ // Result shape (from schema): unknown
737
+ ```
738
+
739
+ ### `posthog.notebooksKernelStopCreate`
740
+
741
+ - **HTTP**: `POST /api/projects/{project_id}/notebooks/{short_id}/kernel/stop/`
742
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
743
+ - **OpenAPI operationId**: `notebooks_kernel_stop_create`
744
+ - **Path params**: `short_id`
745
+ - **Query params**: None
746
+ - **Response codes**: `200`
747
+ - **Transport options**: None
748
+ - **TypeScript**: [Client interface](../types.ts)
749
+
750
+ **Inputs**
751
+
752
+ - Client input type: `{ [key: string]: unknown }`
753
+ - Client transport options: None
754
+
755
+ **Outputs**
756
+
757
+ - Client return type: `unknown`
758
+ - OpenAPI response codes: `200`
759
+
760
+ ```ts
761
+ import posthog from "@utdk/posthog";
762
+
763
+ type NotebooksKernelStopCreateInput = Parameters<typeof posthog.notebooksKernelStopCreate> extends [infer T, ...unknown[]] ? T : undefined;
764
+ type NotebooksKernelStopCreateOutput = Awaited<ReturnType<typeof posthog.notebooksKernelStopCreate>>;
765
+
766
+ const result: NotebooksKernelStopCreateOutput = await posthog.notebooksKernelStopCreate();
767
+
768
+ // Result shape (from schema): unknown
769
+ ```
770
+
771
+ ### `posthog.notebooksAllActivityRetrieve`
772
+
773
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/activity/`
774
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
775
+ - **OpenAPI operationId**: `notebooks_all_activity_retrieve`
776
+ - **Path params**: None
777
+ - **Query params**: None
778
+ - **Response codes**: `200`
779
+ - **Transport options**: None
780
+ - **TypeScript**: [Client interface](../types.ts)
781
+
782
+ **Inputs**
783
+
784
+ - Client input type: `{ [key: string]: unknown }`
785
+ - Client transport options: None
786
+
787
+ **Outputs**
788
+
789
+ - Client return type: `unknown`
790
+ - OpenAPI response codes: `200`
791
+
792
+ ```ts
793
+ import posthog from "@utdk/posthog";
794
+
795
+ type NotebooksAllActivityRetrieveInput = Parameters<typeof posthog.notebooksAllActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
796
+ type NotebooksAllActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksAllActivityRetrieve>>;
797
+
798
+ const result: NotebooksAllActivityRetrieveOutput = await posthog.notebooksAllActivityRetrieve();
799
+
800
+ // Result shape (from schema): unknown
801
+ ```
802
+
803
+ ### `posthog.notebooksRecordingCommentsRetrieve`
804
+
805
+ - **HTTP**: `GET /api/projects/{project_id}/notebooks/recording_comments/`
806
+ - **What it does**: The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
807
+ - **OpenAPI operationId**: `notebooks_recording_comments_retrieve`
808
+ - **Path params**: None
809
+ - **Query params**: None
810
+ - **Response codes**: `200`
811
+ - **Transport options**: None
812
+ - **TypeScript**: [Client interface](../types.ts)
813
+
814
+ **Inputs**
815
+
816
+ - Client input type: `{ [key: string]: unknown }`
817
+ - Client transport options: None
818
+
819
+ **Outputs**
820
+
821
+ - Client return type: `unknown`
822
+ - OpenAPI response codes: `200`
823
+
824
+ ```ts
825
+ import posthog from "@utdk/posthog";
826
+
827
+ type NotebooksRecordingCommentsRetrieveInput = Parameters<typeof posthog.notebooksRecordingCommentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
828
+ type NotebooksRecordingCommentsRetrieveOutput = Awaited<ReturnType<typeof posthog.notebooksRecordingCommentsRetrieve>>;
829
+
830
+ const result: NotebooksRecordingCommentsRetrieveOutput = await posthog.notebooksRecordingCommentsRetrieve();
831
+
832
+ // Result shape (from schema): unknown
833
+ ```
834
+
835
+
836
+ <!-- prompt-hash:
837
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
838
+ -->