@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,380 @@
1
+ # Data Color Themes
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsDataColorThemesList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/data_color_themes/`
8
+ - **OpenAPI operationId**: `environments_data_color_themes_list`
9
+ - **Path params**: None
10
+ - **Query params**: `limit`, `offset`
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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsDataColorThemesListInput = Parameters<typeof posthog.environmentsDataColorThemesList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsDataColorThemesListOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesList>>;
30
+
31
+ const result: EnvironmentsDataColorThemesListOutput = await posthog.environmentsDataColorThemesList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id...
34
+ ```
35
+
36
+ ### `posthog.environmentsDataColorThemesCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/data_color_themes/`
39
+ - **OpenAPI operationId**: `environments_data_color_themes_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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsDataColorThemesCreateInput = Parameters<typeof posthog.environmentsDataColorThemesCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsDataColorThemesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesCreate>>;
61
+
62
+ const result: EnvironmentsDataColorThemesCreateOutput = await posthog.environmentsDataColorThemesCreate();
63
+
64
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
65
+ ```
66
+
67
+ ### `posthog.environmentsDataColorThemesDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/data_color_themes/{id}/`
70
+ - **OpenAPI operationId**: `environments_data_color_themes_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 EnvironmentsDataColorThemesDestroyInput = Parameters<typeof posthog.environmentsDataColorThemesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsDataColorThemesDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesDestroy>>;
92
+
93
+ const result: EnvironmentsDataColorThemesDestroyOutput = await posthog.environmentsDataColorThemesDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsDataColorThemesRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/data_color_themes/{id}/`
101
+ - **OpenAPI operationId**: `environments_data_color_themes_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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsDataColorThemesRetrieveInput = Parameters<typeof posthog.environmentsDataColorThemesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsDataColorThemesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesRetrieve>>;
123
+
124
+ const result: EnvironmentsDataColorThemesRetrieveOutput = await posthog.environmentsDataColorThemesRetrieve();
125
+
126
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
127
+ ```
128
+
129
+ ### `posthog.environmentsDataColorThemesPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/data_color_themes/{id}/`
132
+ - **OpenAPI operationId**: `environments_data_color_themes_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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsDataColorThemesPartialUpdateInput = Parameters<typeof posthog.environmentsDataColorThemesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsDataColorThemesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesPartialUpdate>>;
154
+
155
+ const result: EnvironmentsDataColorThemesPartialUpdateOutput = await posthog.environmentsDataColorThemesPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
158
+ ```
159
+
160
+ ### `posthog.environmentsDataColorThemesUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/data_color_themes/{id}/`
163
+ - **OpenAPI operationId**: `environments_data_color_themes_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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsDataColorThemesUpdateInput = Parameters<typeof posthog.environmentsDataColorThemesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsDataColorThemesUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDataColorThemesUpdate>>;
185
+
186
+ const result: EnvironmentsDataColorThemesUpdateOutput = await posthog.environmentsDataColorThemesUpdate();
187
+
188
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
189
+ ```
190
+
191
+ ### `posthog.dataColorThemesList`
192
+
193
+ - **HTTP**: `GET /api/projects/{project_id}/data_color_themes/`
194
+ - **OpenAPI operationId**: `data_color_themes_list`
195
+ - **Path params**: None
196
+ - **Query params**: `limit`, `offset`
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id...`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type DataColorThemesListInput = Parameters<typeof posthog.dataColorThemesList> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type DataColorThemesListOutput = Awaited<ReturnType<typeof posthog.dataColorThemesList>>;
216
+
217
+ const result: DataColorThemesListOutput = await posthog.dataColorThemesList();
218
+
219
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id...
220
+ ```
221
+
222
+ ### `posthog.dataColorThemesCreate`
223
+
224
+ - **HTTP**: `POST /api/projects/{project_id}/data_color_themes/`
225
+ - **OpenAPI operationId**: `data_color_themes_create`
226
+ - **Path params**: None
227
+ - **Query params**: None
228
+ - **Response codes**: `201`
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: `{ id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
240
+ - OpenAPI response codes: `201`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type DataColorThemesCreateInput = Parameters<typeof posthog.dataColorThemesCreate> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type DataColorThemesCreateOutput = Awaited<ReturnType<typeof posthog.dataColorThemesCreate>>;
247
+
248
+ const result: DataColorThemesCreateOutput = await posthog.dataColorThemesCreate();
249
+
250
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
251
+ ```
252
+
253
+ ### `posthog.dataColorThemesDestroy`
254
+
255
+ - **HTTP**: `DELETE /api/projects/{project_id}/data_color_themes/{id}/`
256
+ - **OpenAPI operationId**: `data_color_themes_destroy`
257
+ - **Path params**: `id`
258
+ - **Query params**: None
259
+ - **Response codes**: `204`
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: `unknown`
271
+ - OpenAPI response codes: `204`
272
+
273
+ ```ts
274
+ import posthog from "@utdk/posthog";
275
+
276
+ type DataColorThemesDestroyInput = Parameters<typeof posthog.dataColorThemesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
277
+ type DataColorThemesDestroyOutput = Awaited<ReturnType<typeof posthog.dataColorThemesDestroy>>;
278
+
279
+ const result: DataColorThemesDestroyOutput = await posthog.dataColorThemesDestroy();
280
+
281
+ // Result shape (from schema): unknown
282
+ ```
283
+
284
+ ### `posthog.dataColorThemesRetrieve`
285
+
286
+ - **HTTP**: `GET /api/projects/{project_id}/data_color_themes/{id}/`
287
+ - **OpenAPI operationId**: `data_color_themes_retrieve`
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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
302
+ - OpenAPI response codes: `200`
303
+
304
+ ```ts
305
+ import posthog from "@utdk/posthog";
306
+
307
+ type DataColorThemesRetrieveInput = Parameters<typeof posthog.dataColorThemesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
308
+ type DataColorThemesRetrieveOutput = Awaited<ReturnType<typeof posthog.dataColorThemesRetrieve>>;
309
+
310
+ const result: DataColorThemesRetrieveOutput = await posthog.dataColorThemesRetrieve();
311
+
312
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
313
+ ```
314
+
315
+ ### `posthog.dataColorThemesPartialUpdate`
316
+
317
+ - **HTTP**: `PATCH /api/projects/{project_id}/data_color_themes/{id}/`
318
+ - **OpenAPI operationId**: `data_color_themes_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: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
333
+ - OpenAPI response codes: `200`
334
+
335
+ ```ts
336
+ import posthog from "@utdk/posthog";
337
+
338
+ type DataColorThemesPartialUpdateInput = Parameters<typeof posthog.dataColorThemesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
339
+ type DataColorThemesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.dataColorThemesPartialUpdate>>;
340
+
341
+ const result: DataColorThemesPartialUpdateOutput = await posthog.dataColorThemesPartialUpdate();
342
+
343
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
344
+ ```
345
+
346
+ ### `posthog.dataColorThemesUpdate`
347
+
348
+ - **HTTP**: `PUT /api/projects/{project_id}/data_color_themes/{id}/`
349
+ - **OpenAPI operationId**: `data_color_themes_update`
350
+ - **Path params**: `id`
351
+ - **Query params**: None
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: `{ id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...`
364
+ - OpenAPI response codes: `200`
365
+
366
+ ```ts
367
+ import posthog from "@utdk/posthog";
368
+
369
+ type DataColorThemesUpdateInput = Parameters<typeof posthog.dataColorThemesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
370
+ type DataColorThemesUpdateOutput = Awaited<ReturnType<typeof posthog.dataColorThemesUpdate>>;
371
+
372
+ const result: DataColorThemesUpdateOutput = await posthog.dataColorThemesUpdate();
373
+
374
+ // Result shape (from schema): { id: number; name: string; colors?: unknown; is_global: boolean; created_at: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; i...
375
+ ```
376
+
377
+
378
+ <!-- prompt-hash:
379
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
380
+ -->
@@ -0,0 +1,264 @@
1
+ # Data Modeling Jobs
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsDataModelingJobsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/data_modeling_jobs/`
8
+ - **What it does**: List data modeling jobs which are "runs" for our saved queries.
9
+ - **OpenAPI operationId**: `environments_data_modeling_jobs_list`
10
+ - **Path params**: None
11
+ - **Query params**: `limit`, `offset`, `saved_query_id`
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; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string ...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type EnvironmentsDataModelingJobsListInput = Parameters<typeof posthog.environmentsDataModelingJobsList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type EnvironmentsDataModelingJobsListOutput = Awaited<ReturnType<typeof posthog.environmentsDataModelingJobsList>>;
31
+
32
+ const result: EnvironmentsDataModelingJobsListOutput = await posthog.environmentsDataModelingJobsList();
33
+
34
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string ...
35
+ ```
36
+
37
+ ### `posthog.environmentsDataModelingJobsRetrieve`
38
+
39
+ - **HTTP**: `GET /api/environments/{environment_id}/data_modeling_jobs/{id}/`
40
+ - **What it does**: List data modeling jobs which are "runs" for our saved queries.
41
+ - **OpenAPI operationId**: `environments_data_modeling_jobs_retrieve`
42
+ - **Path params**: `id`
43
+ - **Query params**: None
44
+ - **Response codes**: `200`
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; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type EnvironmentsDataModelingJobsRetrieveInput = Parameters<typeof posthog.environmentsDataModelingJobsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type EnvironmentsDataModelingJobsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataModelingJobsRetrieve>>;
63
+
64
+ const result: EnvironmentsDataModelingJobsRetrieveOutput = await posthog.environmentsDataModelingJobsRetrieve();
65
+
66
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
67
+ ```
68
+
69
+ ### `posthog.environmentsDataModelingJobsRecentRetrieve`
70
+
71
+ - **HTTP**: `GET /api/environments/{environment_id}/data_modeling_jobs/recent/`
72
+ - **What it does**: Get the most recent non-running job for each saved query from the v2 backend.
73
+ - **OpenAPI operationId**: `environments_data_modeling_jobs_recent_retrieve`
74
+ - **Path params**: None
75
+ - **Query params**: None
76
+ - **Response codes**: `200`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `{ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
88
+ - OpenAPI response codes: `200`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type EnvironmentsDataModelingJobsRecentRetrieveInput = Parameters<typeof posthog.environmentsDataModelingJobsRecentRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type EnvironmentsDataModelingJobsRecentRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataModelingJobsRecentRetrieve>>;
95
+
96
+ const result: EnvironmentsDataModelingJobsRecentRetrieveOutput = await posthog.environmentsDataModelingJobsRecentRetrieve();
97
+
98
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
99
+ ```
100
+
101
+ ### `posthog.environmentsDataModelingJobsRunningRetrieve`
102
+
103
+ - **HTTP**: `GET /api/environments/{environment_id}/data_modeling_jobs/running/`
104
+ - **What it does**: Get all currently running jobs from the v2 backend.
105
+ - **OpenAPI operationId**: `environments_data_modeling_jobs_running_retrieve`
106
+ - **Path params**: None
107
+ - **Query params**: None
108
+ - **Response codes**: `200`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `{ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type EnvironmentsDataModelingJobsRunningRetrieveInput = Parameters<typeof posthog.environmentsDataModelingJobsRunningRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type EnvironmentsDataModelingJobsRunningRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDataModelingJobsRunningRetrieve>>;
127
+
128
+ const result: EnvironmentsDataModelingJobsRunningRetrieveOutput = await posthog.environmentsDataModelingJobsRunningRetrieve();
129
+
130
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
131
+ ```
132
+
133
+ ### `posthog.dataModelingJobsList`
134
+
135
+ - **HTTP**: `GET /api/projects/{project_id}/data_modeling_jobs/`
136
+ - **What it does**: List data modeling jobs which are "runs" for our saved queries.
137
+ - **OpenAPI operationId**: `data_modeling_jobs_list`
138
+ - **Path params**: None
139
+ - **Query params**: `limit`, `offset`, `saved_query_id`
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string ...`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type DataModelingJobsListInput = Parameters<typeof posthog.dataModelingJobsList> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type DataModelingJobsListOutput = Awaited<ReturnType<typeof posthog.dataModelingJobsList>>;
159
+
160
+ const result: DataModelingJobsListOutput = await posthog.dataModelingJobsList();
161
+
162
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string ...
163
+ ```
164
+
165
+ ### `posthog.dataModelingJobsRetrieve`
166
+
167
+ - **HTTP**: `GET /api/projects/{project_id}/data_modeling_jobs/{id}/`
168
+ - **What it does**: List data modeling jobs which are "runs" for our saved queries.
169
+ - **OpenAPI operationId**: `data_modeling_jobs_retrieve`
170
+ - **Path params**: `id`
171
+ - **Query params**: None
172
+ - **Response codes**: `200`
173
+ - **Transport options**: None
174
+ - **TypeScript**: [Client interface](../types.ts)
175
+
176
+ **Inputs**
177
+
178
+ - Client input type: `{ [key: string]: unknown }`
179
+ - Client transport options: None
180
+
181
+ **Outputs**
182
+
183
+ - Client return type: `{ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type DataModelingJobsRetrieveInput = Parameters<typeof posthog.dataModelingJobsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type DataModelingJobsRetrieveOutput = Awaited<ReturnType<typeof posthog.dataModelingJobsRetrieve>>;
191
+
192
+ const result: DataModelingJobsRetrieveOutput = await posthog.dataModelingJobsRetrieve();
193
+
194
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
195
+ ```
196
+
197
+ ### `posthog.dataModelingJobsRecentRetrieve`
198
+
199
+ - **HTTP**: `GET /api/projects/{project_id}/data_modeling_jobs/recent/`
200
+ - **What it does**: Get the most recent non-running job for each saved query from the v2 backend.
201
+ - **OpenAPI operationId**: `data_modeling_jobs_recent_retrieve`
202
+ - **Path params**: None
203
+ - **Query params**: None
204
+ - **Response codes**: `200`
205
+ - **Transport options**: None
206
+ - **TypeScript**: [Client interface](../types.ts)
207
+
208
+ **Inputs**
209
+
210
+ - Client input type: `{ [key: string]: unknown }`
211
+ - Client transport options: None
212
+
213
+ **Outputs**
214
+
215
+ - Client return type: `{ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
216
+ - OpenAPI response codes: `200`
217
+
218
+ ```ts
219
+ import posthog from "@utdk/posthog";
220
+
221
+ type DataModelingJobsRecentRetrieveInput = Parameters<typeof posthog.dataModelingJobsRecentRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
222
+ type DataModelingJobsRecentRetrieveOutput = Awaited<ReturnType<typeof posthog.dataModelingJobsRecentRetrieve>>;
223
+
224
+ const result: DataModelingJobsRecentRetrieveOutput = await posthog.dataModelingJobsRecentRetrieve();
225
+
226
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
227
+ ```
228
+
229
+ ### `posthog.dataModelingJobsRunningRetrieve`
230
+
231
+ - **HTTP**: `GET /api/projects/{project_id}/data_modeling_jobs/running/`
232
+ - **What it does**: Get all currently running jobs from the v2 backend.
233
+ - **OpenAPI operationId**: `data_modeling_jobs_running_retrieve`
234
+ - **Path params**: None
235
+ - **Query params**: None
236
+ - **Response codes**: `200`
237
+ - **Transport options**: None
238
+ - **TypeScript**: [Client interface](../types.ts)
239
+
240
+ **Inputs**
241
+
242
+ - Client input type: `{ [key: string]: unknown }`
243
+ - Client transport options: None
244
+
245
+ **Outputs**
246
+
247
+ - Client return type: `{ id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...`
248
+ - OpenAPI response codes: `200`
249
+
250
+ ```ts
251
+ import posthog from "@utdk/posthog";
252
+
253
+ type DataModelingJobsRunningRetrieveInput = Parameters<typeof posthog.dataModelingJobsRunningRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
254
+ type DataModelingJobsRunningRetrieveOutput = Awaited<ReturnType<typeof posthog.dataModelingJobsRunningRetrieve>>;
255
+
256
+ const result: DataModelingJobsRunningRetrieveOutput = await posthog.dataModelingJobsRunningRetrieve();
257
+
258
+ // Result shape (from schema): { id: string; saved_query_id: string | null; status: "Cancelled" | "Completed" | "Failed" | "Running"; rows_materialized: number; error: string | null; created_at: string; last_run_at: string; workflow_id: string | null...
259
+ ```
260
+
261
+
262
+ <!-- prompt-hash:
263
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
264
+ -->