@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,280 @@
1
+ # Event Filter
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsEventFilterRetrieve`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/event_filter/`
8
+ - **What it does**: Returns the event filter config for the team, or null if not yet created.
9
+ - **OpenAPI operationId**: `environments_event_filter_retrieve`
10
+ - **Path params**: None
11
+ - **Query params**: None
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: `{ id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type EnvironmentsEventFilterRetrieveInput = Parameters<typeof posthog.environmentsEventFilterRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type EnvironmentsEventFilterRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventFilterRetrieve>>;
31
+
32
+ const result: EnvironmentsEventFilterRetrieveOutput = await posthog.environmentsEventFilterRetrieve();
33
+
34
+ // Result shape (from schema): { id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }
35
+ ```
36
+
37
+ ### `posthog.environmentsEventFilterCreate`
38
+
39
+ - **HTTP**: `POST /api/environments/{environment_id}/event_filter/`
40
+ - **What it does**: Create or update the event filter config.
41
+ - **OpenAPI operationId**: `environments_event_filter_create`
42
+ - **Path params**: None
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; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type EnvironmentsEventFilterCreateInput = Parameters<typeof posthog.environmentsEventFilterCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type EnvironmentsEventFilterCreateOutput = Awaited<ReturnType<typeof posthog.environmentsEventFilterCreate>>;
63
+
64
+ const result: EnvironmentsEventFilterCreateOutput = await posthog.environmentsEventFilterCreate();
65
+
66
+ // Result shape (from schema): { id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }
67
+ ```
68
+
69
+ ### `posthog.environmentsEventFilterMetricsRetrieve`
70
+
71
+ - **HTTP**: `GET /api/environments/{environment_id}/event_filter/metrics/`
72
+ - **What it does**: Single event filter per team.
73
+ GET /event_filter/ — returns the config (or null if not yet created)
74
+ POST /event_filter/ — creates or updates the config (upsert)
75
+ GET /event_filter/metrics/ — time-series metrics
76
+ GET /event_filter/metrics/totals/ — aggregate totals
77
+ - **OpenAPI operationId**: `environments_event_filter_metrics_retrieve`
78
+ - **Path params**: None
79
+ - **Query params**: None
80
+ - **Response codes**: `200`
81
+ - **Transport options**: None
82
+ - **TypeScript**: [Client interface](../types.ts)
83
+
84
+ **Inputs**
85
+
86
+ - Client input type: `{ [key: string]: unknown }`
87
+ - Client transport options: None
88
+
89
+ **Outputs**
90
+
91
+ - Client return type: `{ labels: (string)[]; series: ({ name: string; values: (number)[] })[] }`
92
+ - OpenAPI response codes: `200`
93
+
94
+ ```ts
95
+ import posthog from "@utdk/posthog";
96
+
97
+ type EnvironmentsEventFilterMetricsRetrieveInput = Parameters<typeof posthog.environmentsEventFilterMetricsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
98
+ type EnvironmentsEventFilterMetricsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventFilterMetricsRetrieve>>;
99
+
100
+ const result: EnvironmentsEventFilterMetricsRetrieveOutput = await posthog.environmentsEventFilterMetricsRetrieve();
101
+
102
+ // Result shape (from schema): { labels: (string)[]; series: ({ name: string; values: (number)[] })[] }
103
+ ```
104
+
105
+ ### `posthog.environmentsEventFilterMetricsTotalsRetrieve`
106
+
107
+ - **HTTP**: `GET /api/environments/{environment_id}/event_filter/metrics/totals/`
108
+ - **What it does**: Single event filter per team.
109
+ GET /event_filter/ — returns the config (or null if not yet created)
110
+ POST /event_filter/ — creates or updates the config (upsert)
111
+ GET /event_filter/metrics/ — time-series metrics
112
+ GET /event_filter/metrics/totals/ — aggregate totals
113
+ - **OpenAPI operationId**: `environments_event_filter_metrics_totals_retrieve`
114
+ - **Path params**: None
115
+ - **Query params**: None
116
+ - **Response codes**: `200`
117
+ - **Transport options**: None
118
+ - **TypeScript**: [Client interface](../types.ts)
119
+
120
+ **Inputs**
121
+
122
+ - Client input type: `{ [key: string]: unknown }`
123
+ - Client transport options: None
124
+
125
+ **Outputs**
126
+
127
+ - Client return type: `{ totals: { [key: string]: number | undefined } }`
128
+ - OpenAPI response codes: `200`
129
+
130
+ ```ts
131
+ import posthog from "@utdk/posthog";
132
+
133
+ type EnvironmentsEventFilterMetricsTotalsRetrieveInput = Parameters<typeof posthog.environmentsEventFilterMetricsTotalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
134
+ type EnvironmentsEventFilterMetricsTotalsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventFilterMetricsTotalsRetrieve>>;
135
+
136
+ const result: EnvironmentsEventFilterMetricsTotalsRetrieveOutput = await posthog.environmentsEventFilterMetricsTotalsRetrieve();
137
+
138
+ // Result shape (from schema): { totals: { [key: string]: number | undefined } }
139
+ ```
140
+
141
+ ### `posthog.eventFilterRetrieve`
142
+
143
+ - **HTTP**: `GET /api/projects/{project_id}/event_filter/`
144
+ - **What it does**: Returns the event filter config for the team, or null if not yet created.
145
+ - **OpenAPI operationId**: `event_filter_retrieve`
146
+ - **Path params**: None
147
+ - **Query params**: None
148
+ - **Response codes**: `200`
149
+ - **Transport options**: None
150
+ - **TypeScript**: [Client interface](../types.ts)
151
+
152
+ **Inputs**
153
+
154
+ - Client input type: `{ [key: string]: unknown }`
155
+ - Client transport options: None
156
+
157
+ **Outputs**
158
+
159
+ - Client return type: `{ id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }`
160
+ - OpenAPI response codes: `200`
161
+
162
+ ```ts
163
+ import posthog from "@utdk/posthog";
164
+
165
+ type EventFilterRetrieveInput = Parameters<typeof posthog.eventFilterRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
166
+ type EventFilterRetrieveOutput = Awaited<ReturnType<typeof posthog.eventFilterRetrieve>>;
167
+
168
+ const result: EventFilterRetrieveOutput = await posthog.eventFilterRetrieve();
169
+
170
+ // Result shape (from schema): { id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }
171
+ ```
172
+
173
+ ### `posthog.eventFilterCreate`
174
+
175
+ - **HTTP**: `POST /api/projects/{project_id}/event_filter/`
176
+ - **What it does**: Create or update the event filter config.
177
+ - **OpenAPI operationId**: `event_filter_create`
178
+ - **Path params**: None
179
+ - **Query params**: None
180
+ - **Response codes**: `200`
181
+ - **Transport options**: None
182
+ - **TypeScript**: [Client interface](../types.ts)
183
+
184
+ **Inputs**
185
+
186
+ - Client input type: `{ [key: string]: unknown }`
187
+ - Client transport options: None
188
+
189
+ **Outputs**
190
+
191
+ - Client return type: `{ id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }`
192
+ - OpenAPI response codes: `200`
193
+
194
+ ```ts
195
+ import posthog from "@utdk/posthog";
196
+
197
+ type EventFilterCreateInput = Parameters<typeof posthog.eventFilterCreate> extends [infer T, ...unknown[]] ? T : undefined;
198
+ type EventFilterCreateOutput = Awaited<ReturnType<typeof posthog.eventFilterCreate>>;
199
+
200
+ const result: EventFilterCreateOutput = await posthog.eventFilterCreate();
201
+
202
+ // Result shape (from schema): { id: string; mode?: "disabled" | "dry_run" | "live"; filter_tree?: unknown; test_cases?: unknown; created_at: string; updated_at: string }
203
+ ```
204
+
205
+ ### `posthog.eventFilterMetricsRetrieve`
206
+
207
+ - **HTTP**: `GET /api/projects/{project_id}/event_filter/metrics/`
208
+ - **What it does**: Single event filter per team.
209
+ GET /event_filter/ — returns the config (or null if not yet created)
210
+ POST /event_filter/ — creates or updates the config (upsert)
211
+ GET /event_filter/metrics/ — time-series metrics
212
+ GET /event_filter/metrics/totals/ — aggregate totals
213
+ - **OpenAPI operationId**: `event_filter_metrics_retrieve`
214
+ - **Path params**: None
215
+ - **Query params**: None
216
+ - **Response codes**: `200`
217
+ - **Transport options**: None
218
+ - **TypeScript**: [Client interface](../types.ts)
219
+
220
+ **Inputs**
221
+
222
+ - Client input type: `{ [key: string]: unknown }`
223
+ - Client transport options: None
224
+
225
+ **Outputs**
226
+
227
+ - Client return type: `{ labels: (string)[]; series: ({ name: string; values: (number)[] })[] }`
228
+ - OpenAPI response codes: `200`
229
+
230
+ ```ts
231
+ import posthog from "@utdk/posthog";
232
+
233
+ type EventFilterMetricsRetrieveInput = Parameters<typeof posthog.eventFilterMetricsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
234
+ type EventFilterMetricsRetrieveOutput = Awaited<ReturnType<typeof posthog.eventFilterMetricsRetrieve>>;
235
+
236
+ const result: EventFilterMetricsRetrieveOutput = await posthog.eventFilterMetricsRetrieve();
237
+
238
+ // Result shape (from schema): { labels: (string)[]; series: ({ name: string; values: (number)[] })[] }
239
+ ```
240
+
241
+ ### `posthog.eventFilterMetricsTotalsRetrieve`
242
+
243
+ - **HTTP**: `GET /api/projects/{project_id}/event_filter/metrics/totals/`
244
+ - **What it does**: Single event filter per team.
245
+ GET /event_filter/ — returns the config (or null if not yet created)
246
+ POST /event_filter/ — creates or updates the config (upsert)
247
+ GET /event_filter/metrics/ — time-series metrics
248
+ GET /event_filter/metrics/totals/ — aggregate totals
249
+ - **OpenAPI operationId**: `event_filter_metrics_totals_retrieve`
250
+ - **Path params**: None
251
+ - **Query params**: None
252
+ - **Response codes**: `200`
253
+ - **Transport options**: None
254
+ - **TypeScript**: [Client interface](../types.ts)
255
+
256
+ **Inputs**
257
+
258
+ - Client input type: `{ [key: string]: unknown }`
259
+ - Client transport options: None
260
+
261
+ **Outputs**
262
+
263
+ - Client return type: `{ totals: { [key: string]: number | undefined } }`
264
+ - OpenAPI response codes: `200`
265
+
266
+ ```ts
267
+ import posthog from "@utdk/posthog";
268
+
269
+ type EventFilterMetricsTotalsRetrieveInput = Parameters<typeof posthog.eventFilterMetricsTotalsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
270
+ type EventFilterMetricsTotalsRetrieveOutput = Awaited<ReturnType<typeof posthog.eventFilterMetricsTotalsRetrieve>>;
271
+
272
+ const result: EventFilterMetricsTotalsRetrieveOutput = await posthog.eventFilterMetricsTotalsRetrieve();
273
+
274
+ // Result shape (from schema): { totals: { [key: string]: number | undefined } }
275
+ ```
276
+
277
+
278
+ <!-- prompt-hash:
279
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
280
+ -->
@@ -0,0 +1,163 @@
1
+ # Event Schemas
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.eventSchemasList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/event_schemas/`
8
+ - **OpenAPI operationId**: `event_schemas_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: string; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: stri...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EventSchemasListInput = Parameters<typeof posthog.eventSchemasList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EventSchemasListOutput = Awaited<ReturnType<typeof posthog.eventSchemasList>>;
30
+
31
+ const result: EventSchemasListOutput = await posthog.eventSchemasList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: stri...
34
+ ```
35
+
36
+ ### `posthog.eventSchemasCreate`
37
+
38
+ - **HTTP**: `POST /api/projects/{project_id}/event_schemas/`
39
+ - **OpenAPI operationId**: `event_schemas_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; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EventSchemasCreateInput = Parameters<typeof posthog.eventSchemasCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EventSchemasCreateOutput = Awaited<ReturnType<typeof posthog.eventSchemasCreate>>;
61
+
62
+ const result: EventSchemasCreateOutput = await posthog.eventSchemasCreate();
63
+
64
+ // Result shape (from schema): { id: string; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...
65
+ ```
66
+
67
+ ### `posthog.eventSchemasDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/projects/{project_id}/event_schemas/{id}/`
70
+ - **OpenAPI operationId**: `event_schemas_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 EventSchemasDestroyInput = Parameters<typeof posthog.eventSchemasDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EventSchemasDestroyOutput = Awaited<ReturnType<typeof posthog.eventSchemasDestroy>>;
92
+
93
+ const result: EventSchemasDestroyOutput = await posthog.eventSchemasDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.eventSchemasPartialUpdate`
99
+
100
+ - **HTTP**: `PATCH /api/projects/{project_id}/event_schemas/{id}/`
101
+ - **OpenAPI operationId**: `event_schemas_partial_update`
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; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EventSchemasPartialUpdateInput = Parameters<typeof posthog.eventSchemasPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EventSchemasPartialUpdateOutput = Awaited<ReturnType<typeof posthog.eventSchemasPartialUpdate>>;
123
+
124
+ const result: EventSchemasPartialUpdateOutput = await posthog.eventSchemasPartialUpdate();
125
+
126
+ // Result shape (from schema): { id: string; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...
127
+ ```
128
+
129
+ ### `posthog.eventSchemasUpdate`
130
+
131
+ - **HTTP**: `PUT /api/projects/{project_id}/event_schemas/{id}/`
132
+ - **OpenAPI operationId**: `event_schemas_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; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EventSchemasUpdateInput = Parameters<typeof posthog.eventSchemasUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EventSchemasUpdateOutput = Awaited<ReturnType<typeof posthog.eventSchemasUpdate>>;
154
+
155
+ const result: EventSchemasUpdateOutput = await posthog.eventSchemasUpdate();
156
+
157
+ // Result shape (from schema): { id: string; event_definition: string; property_group: { id: string; name: string; description?: string; properties?: ({ id: string; name: string; property_type: "DateTime" | "String" | "Numeric" | "Boolean" | "Object"...
158
+ ```
159
+
160
+
161
+ <!-- prompt-hash:
162
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
163
+ -->
package/docs/events.md ADDED
@@ -0,0 +1,208 @@
1
+ # Events
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsEventsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/events/`
8
+ - **What it does**:
9
+ This endpoint allows you to list and filter events.
10
+ It is effectively deprecated and is kept only for backwards compatibility.
11
+ If you ever ask about it you will be advised to not use it...
12
+ If you want to ad-hoc list or aggregate events, use the Query endpoint instead.
13
+ If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
14
+
15
+ - **OpenAPI operationId**: `environments_events_list`
16
+ - **Path params**: None
17
+ - **Query params**: `after`, `before`, `distinct_id`, `event`, `format`, `include_person`, `limit`, `offset`, `person_id`, `properties`, `select`, `where`
18
+ - **Response codes**: `200`
19
+ - **Transport options**: None
20
+ - **TypeScript**: [Client interface](../types.ts)
21
+
22
+ **Inputs**
23
+
24
+ - Client input type: `{ [key: string]: unknown }`
25
+ - Client transport options: None
26
+
27
+ **Outputs**
28
+
29
+ - Client return type: `{ next?: string | null; results?: ({ id: string; distinct_id: string; properties: { [key: string]: unknown }; event: string; timestamp: string; person: { [key: string]: unknown } | null; elements: ({ event: string; text...`
30
+ - OpenAPI response codes: `200`
31
+
32
+ ```ts
33
+ import posthog from "@utdk/posthog";
34
+
35
+ type EnvironmentsEventsListInput = Parameters<typeof posthog.environmentsEventsList> extends [infer T, ...unknown[]] ? T : undefined;
36
+ type EnvironmentsEventsListOutput = Awaited<ReturnType<typeof posthog.environmentsEventsList>>;
37
+
38
+ const result: EnvironmentsEventsListOutput = await posthog.environmentsEventsList();
39
+
40
+ // Result shape (from schema): { next?: string | null; results?: ({ id: string; distinct_id: string; properties: { [key: string]: unknown }; event: string; timestamp: string; person: { [key: string]: unknown } | null; elements: ({ event: string; text...
41
+ ```
42
+
43
+ ### `posthog.environmentsEventsRetrieve`
44
+
45
+ - **HTTP**: `GET /api/environments/{environment_id}/events/{id}/`
46
+ - **OpenAPI operationId**: `environments_events_retrieve`
47
+ - **Path params**: `id`
48
+ - **Query params**: `format`, `include_person`
49
+ - **Response codes**: `200`
50
+ - **Transport options**: None
51
+ - **TypeScript**: [Client interface](../types.ts)
52
+
53
+ **Inputs**
54
+
55
+ - Client input type: `{ [key: string]: unknown }`
56
+ - Client transport options: None
57
+
58
+ **Outputs**
59
+
60
+ - Client return type: `{ [key: string]: unknown }`
61
+ - OpenAPI response codes: `200`
62
+
63
+ ```ts
64
+ import posthog from "@utdk/posthog";
65
+
66
+ type EnvironmentsEventsRetrieveInput = Parameters<typeof posthog.environmentsEventsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
67
+ type EnvironmentsEventsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventsRetrieve>>;
68
+
69
+ const result: EnvironmentsEventsRetrieveOutput = await posthog.environmentsEventsRetrieve();
70
+
71
+ // Result shape (from schema): { [key: string]: unknown }
72
+ ```
73
+
74
+ ### `posthog.environmentsEventsValuesRetrieve`
75
+
76
+ - **HTTP**: `GET /api/environments/{environment_id}/events/values/`
77
+ - **OpenAPI operationId**: `environments_events_values_retrieve`
78
+ - **Path params**: None
79
+ - **Query params**: `format`
80
+ - **Response codes**: `200`
81
+ - **Transport options**: None
82
+ - **TypeScript**: [Client interface](../types.ts)
83
+
84
+ **Inputs**
85
+
86
+ - Client input type: `{ [key: string]: unknown }`
87
+ - Client transport options: None
88
+
89
+ **Outputs**
90
+
91
+ - Client return type: `unknown`
92
+ - OpenAPI response codes: `200`
93
+
94
+ ```ts
95
+ import posthog from "@utdk/posthog";
96
+
97
+ type EnvironmentsEventsValuesRetrieveInput = Parameters<typeof posthog.environmentsEventsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
98
+ type EnvironmentsEventsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventsValuesRetrieve>>;
99
+
100
+ const result: EnvironmentsEventsValuesRetrieveOutput = await posthog.environmentsEventsValuesRetrieve();
101
+
102
+ // Result shape (from schema): unknown
103
+ ```
104
+
105
+ ### `posthog.eventsList`
106
+
107
+ - **HTTP**: `GET /api/projects/{project_id}/events/`
108
+ - **What it does**:
109
+ This endpoint allows you to list and filter events.
110
+ It is effectively deprecated and is kept only for backwards compatibility.
111
+ If you ever ask about it you will be advised to not use it...
112
+ If you want to ad-hoc list or aggregate events, use the Query endpoint instead.
113
+ If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
114
+
115
+ - **OpenAPI operationId**: `events_list`
116
+ - **Path params**: None
117
+ - **Query params**: `after`, `before`, `distinct_id`, `event`, `format`, `include_person`, `limit`, `offset`, `person_id`, `properties`, `select`, `where`
118
+ - **Response codes**: `200`
119
+ - **Transport options**: None
120
+ - **TypeScript**: [Client interface](../types.ts)
121
+
122
+ **Inputs**
123
+
124
+ - Client input type: `{ [key: string]: unknown }`
125
+ - Client transport options: None
126
+
127
+ **Outputs**
128
+
129
+ - Client return type: `{ next?: string | null; results?: ({ id: string; distinct_id: string; properties: { [key: string]: unknown }; event: string; timestamp: string; person: { [key: string]: unknown } | null; elements: ({ event: string; text...`
130
+ - OpenAPI response codes: `200`
131
+
132
+ ```ts
133
+ import posthog from "@utdk/posthog";
134
+
135
+ type EventsListInput = Parameters<typeof posthog.eventsList> extends [infer T, ...unknown[]] ? T : undefined;
136
+ type EventsListOutput = Awaited<ReturnType<typeof posthog.eventsList>>;
137
+
138
+ const result: EventsListOutput = await posthog.eventsList();
139
+
140
+ // Result shape (from schema): { next?: string | null; results?: ({ id: string; distinct_id: string; properties: { [key: string]: unknown }; event: string; timestamp: string; person: { [key: string]: unknown } | null; elements: ({ event: string; text...
141
+ ```
142
+
143
+ ### `posthog.eventsRetrieve`
144
+
145
+ - **HTTP**: `GET /api/projects/{project_id}/events/{id}/`
146
+ - **OpenAPI operationId**: `events_retrieve`
147
+ - **Path params**: `id`
148
+ - **Query params**: `format`, `include_person`
149
+ - **Response codes**: `200`
150
+ - **Transport options**: None
151
+ - **TypeScript**: [Client interface](../types.ts)
152
+
153
+ **Inputs**
154
+
155
+ - Client input type: `{ [key: string]: unknown }`
156
+ - Client transport options: None
157
+
158
+ **Outputs**
159
+
160
+ - Client return type: `{ [key: string]: unknown }`
161
+ - OpenAPI response codes: `200`
162
+
163
+ ```ts
164
+ import posthog from "@utdk/posthog";
165
+
166
+ type EventsRetrieveInput = Parameters<typeof posthog.eventsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
167
+ type EventsRetrieveOutput = Awaited<ReturnType<typeof posthog.eventsRetrieve>>;
168
+
169
+ const result: EventsRetrieveOutput = await posthog.eventsRetrieve();
170
+
171
+ // Result shape (from schema): { [key: string]: unknown }
172
+ ```
173
+
174
+ ### `posthog.eventsValuesRetrieve`
175
+
176
+ - **HTTP**: `GET /api/projects/{project_id}/events/values/`
177
+ - **OpenAPI operationId**: `events_values_retrieve`
178
+ - **Path params**: None
179
+ - **Query params**: `format`
180
+ - **Response codes**: `200`
181
+ - **Transport options**: None
182
+ - **TypeScript**: [Client interface](../types.ts)
183
+
184
+ **Inputs**
185
+
186
+ - Client input type: `{ [key: string]: unknown }`
187
+ - Client transport options: None
188
+
189
+ **Outputs**
190
+
191
+ - Client return type: `unknown`
192
+ - OpenAPI response codes: `200`
193
+
194
+ ```ts
195
+ import posthog from "@utdk/posthog";
196
+
197
+ type EventsValuesRetrieveInput = Parameters<typeof posthog.eventsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
198
+ type EventsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.eventsValuesRetrieve>>;
199
+
200
+ const result: EventsValuesRetrieveOutput = await posthog.eventsValuesRetrieve();
201
+
202
+ // Result shape (from schema): unknown
203
+ ```
204
+
205
+
206
+ <!-- prompt-hash:
207
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
208
+ -->