@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
package/docs/users.md ADDED
@@ -0,0 +1,1267 @@
1
+ # Users
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.usersList`
6
+
7
+ - **HTTP**: `GET /api/users/`
8
+ - **OpenAPI operationId**: `users_list`
9
+ - **Path params**: None
10
+ - **Query params**: `email`, `is_staff`, `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: ({ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string |...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type UsersListInput = Parameters<typeof posthog.usersList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type UsersListOutput = Awaited<ReturnType<typeof posthog.usersList>>;
30
+
31
+ const result: UsersListOutput = await posthog.usersList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string |...
34
+ ```
35
+
36
+ ### `posthog.usersSignalAutonomyDestroy`
37
+
38
+ - **HTTP**: `DELETE /api/users/{user_id}/signal_autonomy/`
39
+ - **What it does**: Per-user signal autonomy config (singleton keyed by user).
40
+
41
+ GET /api/users/<id>/signal_autonomy/ → current config (or 404)
42
+ POST /api/users/<id>/signal_autonomy/ → create or update
43
+ DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
44
+ - **OpenAPI operationId**: `users_signal_autonomy_destroy`
45
+ - **Path params**: `user_id`
46
+ - **Query params**: None
47
+ - **Response codes**: `204`
48
+ - **Transport options**: None
49
+ - **TypeScript**: [Client interface](../types.ts)
50
+
51
+ **Inputs**
52
+
53
+ - Client input type: `{ [key: string]: unknown }`
54
+ - Client transport options: None
55
+
56
+ **Outputs**
57
+
58
+ - Client return type: `unknown`
59
+ - OpenAPI response codes: `204`
60
+
61
+ ```ts
62
+ import posthog from "@utdk/posthog";
63
+
64
+ type UsersSignalAutonomyDestroyInput = Parameters<typeof posthog.usersSignalAutonomyDestroy> extends [infer T, ...unknown[]] ? T : undefined;
65
+ type UsersSignalAutonomyDestroyOutput = Awaited<ReturnType<typeof posthog.usersSignalAutonomyDestroy>>;
66
+
67
+ const result: UsersSignalAutonomyDestroyOutput = await posthog.usersSignalAutonomyDestroy();
68
+
69
+ // Result shape (from schema): unknown
70
+ ```
71
+
72
+ ### `posthog.usersSignalAutonomyRetrieve`
73
+
74
+ - **HTTP**: `GET /api/users/{user_id}/signal_autonomy/`
75
+ - **What it does**: Per-user signal autonomy config (singleton keyed by user).
76
+
77
+ GET /api/users/<id>/signal_autonomy/ → current config (or 404)
78
+ POST /api/users/<id>/signal_autonomy/ → create or update
79
+ DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
80
+ - **OpenAPI operationId**: `users_signal_autonomy_retrieve`
81
+ - **Path params**: `user_id`
82
+ - **Query params**: None
83
+ - **Response codes**: `200`
84
+ - **Transport options**: None
85
+ - **TypeScript**: [Client interface](../types.ts)
86
+
87
+ **Inputs**
88
+
89
+ - Client input type: `{ [key: string]: unknown }`
90
+ - Client transport options: None
91
+
92
+ **Outputs**
93
+
94
+ - Client return type: `{ id: string; user: { id: number; uuid: string; first_name: string; last_name: string; email: string }; autostart_priority?: "P0" | "P1" | "P2" | "P3" | "P4" | "" | null; slack_notification_integration_id: number | null...`
95
+ - OpenAPI response codes: `200`
96
+
97
+ ```ts
98
+ import posthog from "@utdk/posthog";
99
+
100
+ type UsersSignalAutonomyRetrieveInput = Parameters<typeof posthog.usersSignalAutonomyRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
101
+ type UsersSignalAutonomyRetrieveOutput = Awaited<ReturnType<typeof posthog.usersSignalAutonomyRetrieve>>;
102
+
103
+ const result: UsersSignalAutonomyRetrieveOutput = await posthog.usersSignalAutonomyRetrieve();
104
+
105
+ // Result shape (from schema): { id: string; user: { id: number; uuid: string; first_name: string; last_name: string; email: string }; autostart_priority?: "P0" | "P1" | "P2" | "P3" | "P4" | "" | null; slack_notification_integration_id: number | null...
106
+ ```
107
+
108
+ ### `posthog.usersSignalAutonomyCreate`
109
+
110
+ - **HTTP**: `POST /api/users/{user_id}/signal_autonomy/`
111
+ - **What it does**: Per-user signal autonomy config (singleton keyed by user).
112
+
113
+ GET /api/users/<id>/signal_autonomy/ → current config (or 404)
114
+ POST /api/users/<id>/signal_autonomy/ → create or update
115
+ DELETE /api/users/<id>/signal_autonomy/ → remove (opt out)
116
+ - **OpenAPI operationId**: `users_signal_autonomy_create`
117
+ - **Path params**: `user_id`
118
+ - **Query params**: None
119
+ - **Response codes**: `200`
120
+ - **Transport options**: None
121
+ - **TypeScript**: [Client interface](../types.ts)
122
+
123
+ **Inputs**
124
+
125
+ - Client input type: `{ [key: string]: unknown }`
126
+ - Client transport options: None
127
+
128
+ **Outputs**
129
+
130
+ - Client return type: `{ id: string; user: { id: number; uuid: string; first_name: string; last_name: string; email: string }; autostart_priority?: "P0" | "P1" | "P2" | "P3" | "P4" | "" | null; slack_notification_integration_id: number | null...`
131
+ - OpenAPI response codes: `200`
132
+
133
+ ```ts
134
+ import posthog from "@utdk/posthog";
135
+
136
+ type UsersSignalAutonomyCreateInput = Parameters<typeof posthog.usersSignalAutonomyCreate> extends [infer T, ...unknown[]] ? T : undefined;
137
+ type UsersSignalAutonomyCreateOutput = Awaited<ReturnType<typeof posthog.usersSignalAutonomyCreate>>;
138
+
139
+ const result: UsersSignalAutonomyCreateOutput = await posthog.usersSignalAutonomyCreate();
140
+
141
+ // Result shape (from schema): { id: string; user: { id: number; uuid: string; first_name: string; last_name: string; email: string }; autostart_priority?: "P0" | "P1" | "P2" | "P3" | "P4" | "" | null; slack_notification_integration_id: number | null...
142
+ ```
143
+
144
+ ### `posthog.usersDestroy`
145
+
146
+ - **HTTP**: `DELETE /api/users/{uuid}/`
147
+ - **OpenAPI operationId**: `users_destroy`
148
+ - **Path params**: `uuid`
149
+ - **Query params**: None
150
+ - **Response codes**: `204`
151
+ - **Transport options**: None
152
+ - **TypeScript**: [Client interface](../types.ts)
153
+
154
+ **Inputs**
155
+
156
+ - Client input type: `{ [key: string]: unknown }`
157
+ - Client transport options: None
158
+
159
+ **Outputs**
160
+
161
+ - Client return type: `unknown`
162
+ - OpenAPI response codes: `204`
163
+
164
+ ```ts
165
+ import posthog from "@utdk/posthog";
166
+
167
+ type UsersDestroyInput = Parameters<typeof posthog.usersDestroy> extends [infer T, ...unknown[]] ? T : undefined;
168
+ type UsersDestroyOutput = Awaited<ReturnType<typeof posthog.usersDestroy>>;
169
+
170
+ const result: UsersDestroyOutput = await posthog.usersDestroy();
171
+
172
+ // Result shape (from schema): unknown
173
+ ```
174
+
175
+ ### `posthog.usersRetrieve`
176
+
177
+ - **HTTP**: `GET /api/users/{uuid}/`
178
+ - **What it does**: Retrieve a user's profile and settings. Pass `@me` as the UUID to fetch the authenticated user; non-staff callers may only access their own account.
179
+ - **OpenAPI operationId**: `users_retrieve`
180
+ - **Path params**: `uuid`
181
+ - **Query params**: None
182
+ - **Response codes**: `200`
183
+ - **Transport options**: None
184
+ - **TypeScript**: [Client interface](../types.ts)
185
+
186
+ **Inputs**
187
+
188
+ - Client input type: `{ [key: string]: unknown }`
189
+ - Client transport options: None
190
+
191
+ **Outputs**
192
+
193
+ - Client return type: `{ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...`
194
+ - OpenAPI response codes: `200`
195
+
196
+ ```ts
197
+ import posthog from "@utdk/posthog";
198
+
199
+ type UsersRetrieveInput = Parameters<typeof posthog.usersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
200
+ type UsersRetrieveOutput = Awaited<ReturnType<typeof posthog.usersRetrieve>>;
201
+
202
+ const result: UsersRetrieveOutput = await posthog.usersRetrieve();
203
+
204
+ // Result shape (from schema): { date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...
205
+ ```
206
+
207
+ ### `posthog.usersPartialUpdate`
208
+
209
+ - **HTTP**: `PATCH /api/users/{uuid}/`
210
+ - **What it does**: Update one or more of the authenticated user's profile fields or settings.
211
+ - **OpenAPI operationId**: `users_partial_update`
212
+ - **Path params**: `uuid`
213
+ - **Query params**: None
214
+ - **Response codes**: `200`
215
+ - **Transport options**: None
216
+ - **TypeScript**: [Client interface](../types.ts)
217
+
218
+ **Inputs**
219
+
220
+ - Client input type: `{ [key: string]: unknown }`
221
+ - Client transport options: None
222
+
223
+ **Outputs**
224
+
225
+ - Client return type: `{ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...`
226
+ - OpenAPI response codes: `200`
227
+
228
+ ```ts
229
+ import posthog from "@utdk/posthog";
230
+
231
+ type UsersPartialUpdateInput = Parameters<typeof posthog.usersPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
232
+ type UsersPartialUpdateOutput = Awaited<ReturnType<typeof posthog.usersPartialUpdate>>;
233
+
234
+ const result: UsersPartialUpdateOutput = await posthog.usersPartialUpdate();
235
+
236
+ // Result shape (from schema): { date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...
237
+ ```
238
+
239
+ ### `posthog.usersUpdate`
240
+
241
+ - **HTTP**: `PUT /api/users/{uuid}/`
242
+ - **What it does**: Replace the authenticated user's profile and settings. Pass `@me` as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.
243
+ - **OpenAPI operationId**: `users_update`
244
+ - **Path params**: `uuid`
245
+ - **Query params**: None
246
+ - **Response codes**: `200`
247
+ - **Transport options**: None
248
+ - **TypeScript**: [Client interface](../types.ts)
249
+
250
+ **Inputs**
251
+
252
+ - Client input type: `{ [key: string]: unknown }`
253
+ - Client transport options: None
254
+
255
+ **Outputs**
256
+
257
+ - Client return type: `{ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...`
258
+ - OpenAPI response codes: `200`
259
+
260
+ ```ts
261
+ import posthog from "@utdk/posthog";
262
+
263
+ type UsersUpdateInput = Parameters<typeof posthog.usersUpdate> extends [infer T, ...unknown[]] ? T : undefined;
264
+ type UsersUpdateOutput = Awaited<ReturnType<typeof posthog.usersUpdate>>;
265
+
266
+ const result: UsersUpdateOutput = await posthog.usersUpdate();
267
+
268
+ // Result shape (from schema): { date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...
269
+ ```
270
+
271
+ ### `posthog.usersCredentialsReviewCompleteCreate`
272
+
273
+ - **HTTP**: `POST /api/users/{uuid}/credentials_review_complete/`
274
+ - **What it does**: Mark the user as having reviewed their existing credentials. Idempotent. Flips `requires_credential_review` to False so the post-login interstitial isn't shown again. Does not modify any credentials; the user revokes individual Personal API Keys and passkeys via their existing endpoints from the same screen.
275
+ - **OpenAPI operationId**: `users_credentials_review_complete_create`
276
+ - **Path params**: `uuid`
277
+ - **Query params**: None
278
+ - **Response codes**: `204`
279
+ - **Transport options**: None
280
+ - **TypeScript**: [Client interface](../types.ts)
281
+
282
+ **Inputs**
283
+
284
+ - Client input type: `{ [key: string]: unknown }`
285
+ - Client transport options: None
286
+
287
+ **Outputs**
288
+
289
+ - Client return type: `unknown`
290
+ - OpenAPI response codes: `204`
291
+
292
+ ```ts
293
+ import posthog from "@utdk/posthog";
294
+
295
+ type UsersCredentialsReviewCompleteCreateInput = Parameters<typeof posthog.usersCredentialsReviewCompleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
296
+ type UsersCredentialsReviewCompleteCreateOutput = Awaited<ReturnType<typeof posthog.usersCredentialsReviewCompleteCreate>>;
297
+
298
+ const result: UsersCredentialsReviewCompleteCreateOutput = await posthog.usersCredentialsReviewCompleteCreate();
299
+
300
+ // Result shape (from schema): unknown
301
+ ```
302
+
303
+ ### `posthog.usersGithubLoginRetrieve`
304
+
305
+ - **HTTP**: `GET /api/users/{uuid}/github_login/`
306
+ - **OpenAPI operationId**: `users_github_login_retrieve`
307
+ - **Path params**: `uuid`
308
+ - **Query params**: None
309
+ - **Response codes**: `200`
310
+ - **Transport options**: None
311
+ - **TypeScript**: [Client interface](../types.ts)
312
+
313
+ **Inputs**
314
+
315
+ - Client input type: `{ [key: string]: unknown }`
316
+ - Client transport options: None
317
+
318
+ **Outputs**
319
+
320
+ - Client return type: `unknown`
321
+ - OpenAPI response codes: `200`
322
+
323
+ ```ts
324
+ import posthog from "@utdk/posthog";
325
+
326
+ type UsersGithubLoginRetrieveInput = Parameters<typeof posthog.usersGithubLoginRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
327
+ type UsersGithubLoginRetrieveOutput = Awaited<ReturnType<typeof posthog.usersGithubLoginRetrieve>>;
328
+
329
+ const result: UsersGithubLoginRetrieveOutput = await posthog.usersGithubLoginRetrieve();
330
+
331
+ // Result shape (from schema): unknown
332
+ ```
333
+
334
+ ### `posthog.usersHedgehogConfigRetrieve`
335
+
336
+ - **HTTP**: `GET /api/users/{uuid}/hedgehog_config/`
337
+ - **OpenAPI operationId**: `users_hedgehog_config_retrieve`
338
+ - **Path params**: `uuid`
339
+ - **Query params**: None
340
+ - **Response codes**: `200`
341
+ - **Transport options**: None
342
+ - **TypeScript**: [Client interface](../types.ts)
343
+
344
+ **Inputs**
345
+
346
+ - Client input type: `{ [key: string]: unknown }`
347
+ - Client transport options: None
348
+
349
+ **Outputs**
350
+
351
+ - Client return type: `unknown`
352
+ - OpenAPI response codes: `200`
353
+
354
+ ```ts
355
+ import posthog from "@utdk/posthog";
356
+
357
+ type UsersHedgehogConfigRetrieveInput = Parameters<typeof posthog.usersHedgehogConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
358
+ type UsersHedgehogConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.usersHedgehogConfigRetrieve>>;
359
+
360
+ const result: UsersHedgehogConfigRetrieveOutput = await posthog.usersHedgehogConfigRetrieve();
361
+
362
+ // Result shape (from schema): unknown
363
+ ```
364
+
365
+ ### `posthog.usersHedgehogConfigPartialUpdate`
366
+
367
+ - **HTTP**: `PATCH /api/users/{uuid}/hedgehog_config/`
368
+ - **OpenAPI operationId**: `users_hedgehog_config_partial_update`
369
+ - **Path params**: `uuid`
370
+ - **Query params**: None
371
+ - **Response codes**: `200`
372
+ - **Transport options**: None
373
+ - **TypeScript**: [Client interface](../types.ts)
374
+
375
+ **Inputs**
376
+
377
+ - Client input type: `{ [key: string]: unknown }`
378
+ - Client transport options: None
379
+
380
+ **Outputs**
381
+
382
+ - Client return type: `unknown`
383
+ - OpenAPI response codes: `200`
384
+
385
+ ```ts
386
+ import posthog from "@utdk/posthog";
387
+
388
+ type UsersHedgehogConfigPartialUpdateInput = Parameters<typeof posthog.usersHedgehogConfigPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
389
+ type UsersHedgehogConfigPartialUpdateOutput = Awaited<ReturnType<typeof posthog.usersHedgehogConfigPartialUpdate>>;
390
+
391
+ const result: UsersHedgehogConfigPartialUpdateOutput = await posthog.usersHedgehogConfigPartialUpdate();
392
+
393
+ // Result shape (from schema): unknown
394
+ ```
395
+
396
+ ### `posthog.usersIntegrationsList`
397
+
398
+ - **HTTP**: `GET /api/users/{uuid}/integrations/`
399
+ - **What it does**: List the user's personal integrations of a given kind
400
+ - **OpenAPI operationId**: `users_integrations_list`
401
+ - **Path params**: `uuid`
402
+ - **Query params**: `kind`, `limit`, `offset`
403
+ - **Response codes**: `200`
404
+ - **Transport options**: None
405
+ - **TypeScript**: [Client interface](../types.ts)
406
+
407
+ **Inputs**
408
+
409
+ - Client input type: `{ [key: string]: unknown }`
410
+ - Client transport options: None
411
+
412
+ **Outputs**
413
+
414
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ results: ({ id: string; kind: string; installation_id: string; repository_selection?: string | null; account?: { type?: string | null; name?: ...`
415
+ - OpenAPI response codes: `200`
416
+
417
+ ```ts
418
+ import posthog from "@utdk/posthog";
419
+
420
+ type UsersIntegrationsListInput = Parameters<typeof posthog.usersIntegrationsList> extends [infer T, ...unknown[]] ? T : undefined;
421
+ type UsersIntegrationsListOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsList>>;
422
+
423
+ const result: UsersIntegrationsListOutput = await posthog.usersIntegrationsList();
424
+
425
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ results: ({ id: string; kind: string; installation_id: string; repository_selection?: string | null; account?: { type?: string | null; name?: ...
426
+ ```
427
+
428
+ ### `posthog.usersIntegrationsGithubDestroy`
429
+
430
+ - **HTTP**: `DELETE /api/users/{uuid}/integrations/github/{installation_id}/`
431
+ - **What it does**: Disconnect a personal GitHub integration
432
+ - **OpenAPI operationId**: `users_integrations_github_destroy`
433
+ - **Path params**: `installation_id`, `uuid`
434
+ - **Query params**: None
435
+ - **Response codes**: `204`
436
+ - **Transport options**: None
437
+ - **TypeScript**: [Client interface](../types.ts)
438
+
439
+ **Inputs**
440
+
441
+ - Client input type: `{ [key: string]: unknown }`
442
+ - Client transport options: None
443
+
444
+ **Outputs**
445
+
446
+ - Client return type: `unknown`
447
+ - OpenAPI response codes: `204`
448
+
449
+ ```ts
450
+ import posthog from "@utdk/posthog";
451
+
452
+ type UsersIntegrationsGithubDestroyInput = Parameters<typeof posthog.usersIntegrationsGithubDestroy> extends [infer T, ...unknown[]] ? T : undefined;
453
+ type UsersIntegrationsGithubDestroyOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubDestroy>>;
454
+
455
+ const result: UsersIntegrationsGithubDestroyOutput = await posthog.usersIntegrationsGithubDestroy();
456
+
457
+ // Result shape (from schema): unknown
458
+ ```
459
+
460
+ ### `posthog.usersIntegrationsGithubBranchesRetrieve`
461
+
462
+ - **HTTP**: `GET /api/users/{uuid}/integrations/github/{installation_id}/branches/`
463
+ - **What it does**: List branches for a personal GitHub installation repository
464
+ - **OpenAPI operationId**: `users_integrations_github_branches_retrieve`
465
+ - **Path params**: `installation_id`, `uuid`
466
+ - **Query params**: `limit`, `offset`, `repo`, `search`
467
+ - **Response codes**: `200`
468
+ - **Transport options**: None
469
+ - **TypeScript**: [Client interface](../types.ts)
470
+
471
+ **Inputs**
472
+
473
+ - Client input type: `{ [key: string]: unknown }`
474
+ - Client transport options: None
475
+
476
+ **Outputs**
477
+
478
+ - Client return type: `{ branches: (string)[]; default_branch?: string | null; has_more: boolean }`
479
+ - OpenAPI response codes: `200`
480
+
481
+ ```ts
482
+ import posthog from "@utdk/posthog";
483
+
484
+ type UsersIntegrationsGithubBranchesRetrieveInput = Parameters<typeof posthog.usersIntegrationsGithubBranchesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
485
+ type UsersIntegrationsGithubBranchesRetrieveOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubBranchesRetrieve>>;
486
+
487
+ const result: UsersIntegrationsGithubBranchesRetrieveOutput = await posthog.usersIntegrationsGithubBranchesRetrieve();
488
+
489
+ // Result shape (from schema): { branches: (string)[]; default_branch?: string | null; has_more: boolean }
490
+ ```
491
+
492
+ ### `posthog.usersIntegrationsGithubReposRetrieve`
493
+
494
+ - **HTTP**: `GET /api/users/{uuid}/integrations/github/{installation_id}/repos/`
495
+ - **What it does**: List repositories for a personal GitHub installation
496
+ - **OpenAPI operationId**: `users_integrations_github_repos_retrieve`
497
+ - **Path params**: `installation_id`, `uuid`
498
+ - **Query params**: `limit`, `offset`, `search`
499
+ - **Response codes**: `200`
500
+ - **Transport options**: None
501
+ - **TypeScript**: [Client interface](../types.ts)
502
+
503
+ **Inputs**
504
+
505
+ - Client input type: `{ [key: string]: unknown }`
506
+ - Client transport options: None
507
+
508
+ **Outputs**
509
+
510
+ - Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }`
511
+ - OpenAPI response codes: `200`
512
+
513
+ ```ts
514
+ import posthog from "@utdk/posthog";
515
+
516
+ type UsersIntegrationsGithubReposRetrieveInput = Parameters<typeof posthog.usersIntegrationsGithubReposRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
517
+ type UsersIntegrationsGithubReposRetrieveOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubReposRetrieve>>;
518
+
519
+ const result: UsersIntegrationsGithubReposRetrieveOutput = await posthog.usersIntegrationsGithubReposRetrieve();
520
+
521
+ // Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }
522
+ ```
523
+
524
+ ### `posthog.usersIntegrationsGithubReposRefreshCreate`
525
+
526
+ - **HTTP**: `POST /api/users/{uuid}/integrations/github/{installation_id}/repos/refresh/`
527
+ - **What it does**: Refresh repositories for a personal GitHub installation
528
+ - **OpenAPI operationId**: `users_integrations_github_repos_refresh_create`
529
+ - **Path params**: `installation_id`, `uuid`
530
+ - **Query params**: None
531
+ - **Response codes**: `200`
532
+ - **Transport options**: None
533
+ - **TypeScript**: [Client interface](../types.ts)
534
+
535
+ **Inputs**
536
+
537
+ - Client input type: `{ [key: string]: unknown }`
538
+ - Client transport options: None
539
+
540
+ **Outputs**
541
+
542
+ - Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }`
543
+ - OpenAPI response codes: `200`
544
+
545
+ ```ts
546
+ import posthog from "@utdk/posthog";
547
+
548
+ type UsersIntegrationsGithubReposRefreshCreateInput = Parameters<typeof posthog.usersIntegrationsGithubReposRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
549
+ type UsersIntegrationsGithubReposRefreshCreateOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubReposRefreshCreate>>;
550
+
551
+ const result: UsersIntegrationsGithubReposRefreshCreateOutput = await posthog.usersIntegrationsGithubReposRefreshCreate();
552
+
553
+ // Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }
554
+ ```
555
+
556
+ ### `posthog.usersIntegrationsGithubPrepareCallbackCreate`
557
+
558
+ - **HTTP**: `POST /api/users/{uuid}/integrations/github/prepare_callback/`
559
+ - **What it does**: Seed personal GitHub manage callback state before opening installation settings on GitHub.
560
+ - **OpenAPI operationId**: `users_integrations_github_prepare_callback_create`
561
+ - **Path params**: `uuid`
562
+ - **Query params**: None
563
+ - **Response codes**: `204`
564
+ - **Transport options**: None
565
+ - **TypeScript**: [Client interface](../types.ts)
566
+
567
+ **Inputs**
568
+
569
+ - Client input type: `{ [key: string]: unknown }`
570
+ - Client transport options: None
571
+
572
+ **Outputs**
573
+
574
+ - Client return type: `unknown`
575
+ - OpenAPI response codes: `204`
576
+
577
+ ```ts
578
+ import posthog from "@utdk/posthog";
579
+
580
+ type UsersIntegrationsGithubPrepareCallbackCreateInput = Parameters<typeof posthog.usersIntegrationsGithubPrepareCallbackCreate> extends [infer T, ...unknown[]] ? T : undefined;
581
+ type UsersIntegrationsGithubPrepareCallbackCreateOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubPrepareCallbackCreate>>;
582
+
583
+ const result: UsersIntegrationsGithubPrepareCallbackCreateOutput = await posthog.usersIntegrationsGithubPrepareCallbackCreate();
584
+
585
+ // Result shape (from schema): unknown
586
+ ```
587
+
588
+ ### `posthog.usersIntegrationsGithubStartCreate`
589
+
590
+ - **HTTP**: `POST /api/users/{uuid}/integrations/github/start/`
591
+ - **What it does**: Start GitHub personal integration linking
592
+ - **OpenAPI operationId**: `users_integrations_github_start_create`
593
+ - **Path params**: `uuid`
594
+ - **Query params**: None
595
+ - **Response codes**: `200`
596
+ - **Transport options**: None
597
+ - **TypeScript**: [Client interface](../types.ts)
598
+
599
+ **Inputs**
600
+
601
+ - Client input type: `{ [key: string]: unknown }`
602
+ - Client transport options: None
603
+
604
+ **Outputs**
605
+
606
+ - Client return type: `{ install_url: string; connect_flow: string }`
607
+ - OpenAPI response codes: `200`
608
+
609
+ ```ts
610
+ import posthog from "@utdk/posthog";
611
+
612
+ type UsersIntegrationsGithubStartCreateInput = Parameters<typeof posthog.usersIntegrationsGithubStartCreate> extends [infer T, ...unknown[]] ? T : undefined;
613
+ type UsersIntegrationsGithubStartCreateOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsGithubStartCreate>>;
614
+
615
+ const result: UsersIntegrationsGithubStartCreateOutput = await posthog.usersIntegrationsGithubStartCreate();
616
+
617
+ // Result shape (from schema): { install_url: string; connect_flow: string }
618
+ ```
619
+
620
+ ### `posthog.usersIntegrationsSlackDestroy`
621
+
622
+ - **HTTP**: `DELETE /api/users/{uuid}/integrations/slack/{slack_user_id}/`
623
+ - **What it does**: Unlink a Slack identity
624
+ - **OpenAPI operationId**: `users_integrations_slack_destroy`
625
+ - **Path params**: `slack_user_id`, `uuid`
626
+ - **Query params**: None
627
+ - **Response codes**: `204`
628
+ - **Transport options**: None
629
+ - **TypeScript**: [Client interface](../types.ts)
630
+
631
+ **Inputs**
632
+
633
+ - Client input type: `{ [key: string]: unknown }`
634
+ - Client transport options: None
635
+
636
+ **Outputs**
637
+
638
+ - Client return type: `unknown`
639
+ - OpenAPI response codes: `204`
640
+
641
+ ```ts
642
+ import posthog from "@utdk/posthog";
643
+
644
+ type UsersIntegrationsSlackDestroyInput = Parameters<typeof posthog.usersIntegrationsSlackDestroy> extends [infer T, ...unknown[]] ? T : undefined;
645
+ type UsersIntegrationsSlackDestroyOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsSlackDestroy>>;
646
+
647
+ const result: UsersIntegrationsSlackDestroyOutput = await posthog.usersIntegrationsSlackDestroy();
648
+
649
+ // Result shape (from schema): unknown
650
+ ```
651
+
652
+ ### `posthog.usersIntegrationsSlackLinkableWorkspacesRetrieve`
653
+
654
+ - **HTTP**: `GET /api/users/{uuid}/integrations/slack/linkable_workspaces/`
655
+ - **What it does**: List Slack workspaces this user could link to
656
+ - **OpenAPI operationId**: `users_integrations_slack_linkable_workspaces_retrieve`
657
+ - **Path params**: `uuid`
658
+ - **Query params**: None
659
+ - **Response codes**: `200`
660
+ - **Transport options**: None
661
+ - **TypeScript**: [Client interface](../types.ts)
662
+
663
+ **Inputs**
664
+
665
+ - Client input type: `{ [key: string]: unknown }`
666
+ - Client transport options: None
667
+
668
+ **Outputs**
669
+
670
+ - Client return type: `{ results: ({ posthog_team_id: number; posthog_team_name: string; posthog_organization_name: string; slack_team_id: string; slack_team_name?: string | null })[] }`
671
+ - OpenAPI response codes: `200`
672
+
673
+ ```ts
674
+ import posthog from "@utdk/posthog";
675
+
676
+ type UsersIntegrationsSlackLinkableWorkspacesRetrieveInput = Parameters<typeof posthog.usersIntegrationsSlackLinkableWorkspacesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
677
+ type UsersIntegrationsSlackLinkableWorkspacesRetrieveOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsSlackLinkableWorkspacesRetrieve>>;
678
+
679
+ const result: UsersIntegrationsSlackLinkableWorkspacesRetrieveOutput = await posthog.usersIntegrationsSlackLinkableWorkspacesRetrieve();
680
+
681
+ // Result shape (from schema): { results: ({ posthog_team_id: number; posthog_team_name: string; posthog_organization_name: string; slack_team_id: string; slack_team_name?: string | null })[] }
682
+ ```
683
+
684
+ ### `posthog.usersIntegrationsSlackStartCreate`
685
+
686
+ - **HTTP**: `POST /api/users/{uuid}/integrations/slack/start/`
687
+ - **What it does**: Start Slack identity link from settings
688
+ - **OpenAPI operationId**: `users_integrations_slack_start_create`
689
+ - **Path params**: `uuid`
690
+ - **Query params**: None
691
+ - **Response codes**: `200`
692
+ - **Transport options**: None
693
+ - **TypeScript**: [Client interface](../types.ts)
694
+
695
+ **Inputs**
696
+
697
+ - Client input type: `{ [key: string]: unknown }`
698
+ - Client transport options: None
699
+
700
+ **Outputs**
701
+
702
+ - Client return type: `{ install_url: string }`
703
+ - OpenAPI response codes: `200`
704
+
705
+ ```ts
706
+ import posthog from "@utdk/posthog";
707
+
708
+ type UsersIntegrationsSlackStartCreateInput = Parameters<typeof posthog.usersIntegrationsSlackStartCreate> extends [infer T, ...unknown[]] ? T : undefined;
709
+ type UsersIntegrationsSlackStartCreateOutput = Awaited<ReturnType<typeof posthog.usersIntegrationsSlackStartCreate>>;
710
+
711
+ const result: UsersIntegrationsSlackStartCreateOutput = await posthog.usersIntegrationsSlackStartCreate();
712
+
713
+ // Result shape (from schema): { install_url: string }
714
+ ```
715
+
716
+ ### `posthog.usersLoginSessionsList`
717
+
718
+ - **HTTP**: `GET /api/users/{uuid}/login_sessions/`
719
+ - **What it does**: List the cookie-auth login sessions for the current user. Self-only — never another user.
720
+ - **OpenAPI operationId**: `users_login_sessions_list`
721
+ - **Path params**: `uuid`
722
+ - **Query params**: `email`, `is_staff`
723
+ - **Response codes**: `200`
724
+ - **Transport options**: None
725
+ - **TypeScript**: [Client interface](../types.ts)
726
+
727
+ **Inputs**
728
+
729
+ - Client input type: `{ [key: string]: unknown }`
730
+ - Client transport options: None
731
+
732
+ **Outputs**
733
+
734
+ - Client return type: `({ id: string; created_at: string | null; last_activity: string; location: string; device: string; login_method: string; is_current: boolean })[]`
735
+ - OpenAPI response codes: `200`
736
+
737
+ ```ts
738
+ import posthog from "@utdk/posthog";
739
+
740
+ type UsersLoginSessionsListInput = Parameters<typeof posthog.usersLoginSessionsList> extends [infer T, ...unknown[]] ? T : undefined;
741
+ type UsersLoginSessionsListOutput = Awaited<ReturnType<typeof posthog.usersLoginSessionsList>>;
742
+
743
+ const result: UsersLoginSessionsListOutput = await posthog.usersLoginSessionsList();
744
+
745
+ // Result shape (from schema): ({ id: string; created_at: string | null; last_activity: string; location: string; device: string; login_method: string; is_current: boolean })[]
746
+ ```
747
+
748
+ ### `posthog.usersLoginSessionsDestroy`
749
+
750
+ - **HTTP**: `DELETE /api/users/{uuid}/login_sessions/{session_id}/`
751
+ - **What it does**: Revoke a single login session belonging to the current user. Self-only.
752
+
753
+ Requires recent auth (TimeSensitiveActionPermission) so a stolen cookie can't weaponize
754
+ revocation, and is blocked while impersonating via ImpersonationBlockedPathsMiddleware.
755
+ - **OpenAPI operationId**: `users_login_sessions_destroy`
756
+ - **Path params**: `session_id`, `uuid`
757
+ - **Query params**: None
758
+ - **Response codes**: `204`
759
+ - **Transport options**: None
760
+ - **TypeScript**: [Client interface](../types.ts)
761
+
762
+ **Inputs**
763
+
764
+ - Client input type: `{ [key: string]: unknown }`
765
+ - Client transport options: None
766
+
767
+ **Outputs**
768
+
769
+ - Client return type: `unknown`
770
+ - OpenAPI response codes: `204`
771
+
772
+ ```ts
773
+ import posthog from "@utdk/posthog";
774
+
775
+ type UsersLoginSessionsDestroyInput = Parameters<typeof posthog.usersLoginSessionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
776
+ type UsersLoginSessionsDestroyOutput = Awaited<ReturnType<typeof posthog.usersLoginSessionsDestroy>>;
777
+
778
+ const result: UsersLoginSessionsDestroyOutput = await posthog.usersLoginSessionsDestroy();
779
+
780
+ // Result shape (from schema): unknown
781
+ ```
782
+
783
+ ### `posthog.usersLoginSessionsRevokeOthersCreate`
784
+
785
+ - **HTTP**: `POST /api/users/{uuid}/login_sessions/revoke_others/`
786
+ - **What it does**: Revoke every login session for the current user except the one making this request. Self-only.
787
+
788
+ Requires recent auth (TimeSensitiveActionPermission) so a stolen cookie can't weaponize the
789
+ "log out everywhere else" lock-out, and is blocked while impersonating.
790
+ - **OpenAPI operationId**: `users_login_sessions_revoke_others_create`
791
+ - **Path params**: `uuid`
792
+ - **Query params**: None
793
+ - **Response codes**: `200`
794
+ - **Transport options**: None
795
+ - **TypeScript**: [Client interface](../types.ts)
796
+
797
+ **Inputs**
798
+
799
+ - Client input type: `{ [key: string]: unknown }`
800
+ - Client transport options: None
801
+
802
+ **Outputs**
803
+
804
+ - Client return type: `{ revoked_count: number }`
805
+ - OpenAPI response codes: `200`
806
+
807
+ ```ts
808
+ import posthog from "@utdk/posthog";
809
+
810
+ type UsersLoginSessionsRevokeOthersCreateInput = Parameters<typeof posthog.usersLoginSessionsRevokeOthersCreate> extends [infer T, ...unknown[]] ? T : undefined;
811
+ type UsersLoginSessionsRevokeOthersCreateOutput = Awaited<ReturnType<typeof posthog.usersLoginSessionsRevokeOthersCreate>>;
812
+
813
+ const result: UsersLoginSessionsRevokeOthersCreateOutput = await posthog.usersLoginSessionsRevokeOthersCreate();
814
+
815
+ // Result shape (from schema): { revoked_count: number }
816
+ ```
817
+
818
+ ### `posthog.usersOnboardingSkipCreate`
819
+
820
+ - **HTTP**: `POST /api/users/{uuid}/onboarding/skip/`
821
+ - **What it does**: Mark the current user as having exited onboarding with a non-delegated reason.
822
+ Idempotent: the skip timestamp is only set on the first successful call.
823
+
824
+ Callers wanting to delegate setup to a teammate must use the dedicated
825
+ /organizations/{id}/invites/delegate/ endpoint, which atomically creates the
826
+ invite and sets reason="delegated". This endpoint rejects that reason so state
827
+ can't be faked without a real invite.
828
+ - **OpenAPI operationId**: `users_onboarding_skip_create`
829
+ - **Path params**: `uuid`
830
+ - **Query params**: None
831
+ - **Response codes**: `200`
832
+ - **Transport options**: None
833
+ - **TypeScript**: [Client interface](../types.ts)
834
+
835
+ **Inputs**
836
+
837
+ - Client input type: `{ [key: string]: unknown }`
838
+ - Client transport options: None
839
+
840
+ **Outputs**
841
+
842
+ - Client return type: `{ date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...`
843
+ - OpenAPI response codes: `200`
844
+
845
+ ```ts
846
+ import posthog from "@utdk/posthog";
847
+
848
+ type UsersOnboardingSkipCreateInput = Parameters<typeof posthog.usersOnboardingSkipCreate> extends [infer T, ...unknown[]] ? T : undefined;
849
+ type UsersOnboardingSkipCreateOutput = Awaited<ReturnType<typeof posthog.usersOnboardingSkipCreate>>;
850
+
851
+ const result: UsersOnboardingSkipCreateOutput = await posthog.usersOnboardingSkipCreate();
852
+
853
+ // Result shape (from schema): { date_joined: string; uuid: string; distinct_id: string | null; first_name?: string; last_name?: string; email: string; pending_email: string | null; is_email_verified: boolean | null; notification_settings?: { [key: s...
854
+ ```
855
+
856
+ ### `posthog.usersPushTokensCreate`
857
+
858
+ - **HTTP**: `POST /api/users/{uuid}/push_tokens/`
859
+ - **What it does**: Register a push notification token
860
+ - **OpenAPI operationId**: `users_push_tokens_create`
861
+ - **Path params**: `uuid`
862
+ - **Query params**: None
863
+ - **Response codes**: `200`
864
+ - **Transport options**: None
865
+ - **TypeScript**: [Client interface](../types.ts)
866
+
867
+ **Inputs**
868
+
869
+ - Client input type: `{ [key: string]: unknown }`
870
+ - Client transport options: None
871
+
872
+ **Outputs**
873
+
874
+ - Client return type: `{ id: string; platform: "ios" | "android" | "web"; created_at: string; last_seen_at: string }`
875
+ - OpenAPI response codes: `200`
876
+
877
+ ```ts
878
+ import posthog from "@utdk/posthog";
879
+
880
+ type UsersPushTokensCreateInput = Parameters<typeof posthog.usersPushTokensCreate> extends [infer T, ...unknown[]] ? T : undefined;
881
+ type UsersPushTokensCreateOutput = Awaited<ReturnType<typeof posthog.usersPushTokensCreate>>;
882
+
883
+ const result: UsersPushTokensCreateOutput = await posthog.usersPushTokensCreate();
884
+
885
+ // Result shape (from schema): { id: string; platform: "ios" | "android" | "web"; created_at: string; last_seen_at: string }
886
+ ```
887
+
888
+ ### `posthog.usersPushTokensUnregisterCreate`
889
+
890
+ - **HTTP**: `POST /api/users/{uuid}/push_tokens/unregister/`
891
+ - **What it does**: Unregister a push notification token
892
+ - **OpenAPI operationId**: `users_push_tokens_unregister_create`
893
+ - **Path params**: `uuid`
894
+ - **Query params**: None
895
+ - **Response codes**: `204`
896
+ - **Transport options**: None
897
+ - **TypeScript**: [Client interface](../types.ts)
898
+
899
+ **Inputs**
900
+
901
+ - Client input type: `{ [key: string]: unknown }`
902
+ - Client transport options: None
903
+
904
+ **Outputs**
905
+
906
+ - Client return type: `unknown`
907
+ - OpenAPI response codes: `204`
908
+
909
+ ```ts
910
+ import posthog from "@utdk/posthog";
911
+
912
+ type UsersPushTokensUnregisterCreateInput = Parameters<typeof posthog.usersPushTokensUnregisterCreate> extends [infer T, ...unknown[]] ? T : undefined;
913
+ type UsersPushTokensUnregisterCreateOutput = Awaited<ReturnType<typeof posthog.usersPushTokensUnregisterCreate>>;
914
+
915
+ const result: UsersPushTokensUnregisterCreateOutput = await posthog.usersPushTokensUnregisterCreate();
916
+
917
+ // Result shape (from schema): unknown
918
+ ```
919
+
920
+ ### `posthog.usersScenePersonalisationCreate`
921
+
922
+ - **HTTP**: `POST /api/users/{uuid}/scene_personalisation/`
923
+ - **OpenAPI operationId**: `users_scene_personalisation_create`
924
+ - **Path params**: `uuid`
925
+ - **Query params**: None
926
+ - **Response codes**: `200`
927
+ - **Transport options**: None
928
+ - **TypeScript**: [Client interface](../types.ts)
929
+
930
+ **Inputs**
931
+
932
+ - Client input type: `{ [key: string]: unknown }`
933
+ - Client transport options: None
934
+
935
+ **Outputs**
936
+
937
+ - Client return type: `unknown`
938
+ - OpenAPI response codes: `200`
939
+
940
+ ```ts
941
+ import posthog from "@utdk/posthog";
942
+
943
+ type UsersScenePersonalisationCreateInput = Parameters<typeof posthog.usersScenePersonalisationCreate> extends [infer T, ...unknown[]] ? T : undefined;
944
+ type UsersScenePersonalisationCreateOutput = Awaited<ReturnType<typeof posthog.usersScenePersonalisationCreate>>;
945
+
946
+ const result: UsersScenePersonalisationCreateOutput = await posthog.usersScenePersonalisationCreate();
947
+
948
+ // Result shape (from schema): unknown
949
+ ```
950
+
951
+ ### `posthog.usersStart2FaSetupRetrieve`
952
+
953
+ - **HTTP**: `GET /api/users/{uuid}/start_2fa_setup/`
954
+ - **OpenAPI operationId**: `users_start_2fa_setup_retrieve`
955
+ - **Path params**: `uuid`
956
+ - **Query params**: None
957
+ - **Response codes**: `200`
958
+ - **Transport options**: None
959
+ - **TypeScript**: [Client interface](../types.ts)
960
+
961
+ **Inputs**
962
+
963
+ - Client input type: `{ [key: string]: unknown }`
964
+ - Client transport options: None
965
+
966
+ **Outputs**
967
+
968
+ - Client return type: `unknown`
969
+ - OpenAPI response codes: `200`
970
+
971
+ ```ts
972
+ import posthog from "@utdk/posthog";
973
+
974
+ type UsersStart2FaSetupRetrieveInput = Parameters<typeof posthog.usersStart2FaSetupRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
975
+ type UsersStart2FaSetupRetrieveOutput = Awaited<ReturnType<typeof posthog.usersStart2FaSetupRetrieve>>;
976
+
977
+ const result: UsersStart2FaSetupRetrieveOutput = await posthog.usersStart2FaSetupRetrieve();
978
+
979
+ // Result shape (from schema): unknown
980
+ ```
981
+
982
+ ### `posthog.usersTwoFactorBackupCodesCreate`
983
+
984
+ - **HTTP**: `POST /api/users/{uuid}/two_factor_backup_codes/`
985
+ - **What it does**: Generate new backup codes, invalidating any existing ones
986
+ - **OpenAPI operationId**: `users_two_factor_backup_codes_create`
987
+ - **Path params**: `uuid`
988
+ - **Query params**: None
989
+ - **Response codes**: `200`
990
+ - **Transport options**: None
991
+ - **TypeScript**: [Client interface](../types.ts)
992
+
993
+ **Inputs**
994
+
995
+ - Client input type: `{ [key: string]: unknown }`
996
+ - Client transport options: None
997
+
998
+ **Outputs**
999
+
1000
+ - Client return type: `unknown`
1001
+ - OpenAPI response codes: `200`
1002
+
1003
+ ```ts
1004
+ import posthog from "@utdk/posthog";
1005
+
1006
+ type UsersTwoFactorBackupCodesCreateInput = Parameters<typeof posthog.usersTwoFactorBackupCodesCreate> extends [infer T, ...unknown[]] ? T : undefined;
1007
+ type UsersTwoFactorBackupCodesCreateOutput = Awaited<ReturnType<typeof posthog.usersTwoFactorBackupCodesCreate>>;
1008
+
1009
+ const result: UsersTwoFactorBackupCodesCreateOutput = await posthog.usersTwoFactorBackupCodesCreate();
1010
+
1011
+ // Result shape (from schema): unknown
1012
+ ```
1013
+
1014
+ ### `posthog.usersTwoFactorDisableCreate`
1015
+
1016
+ - **HTTP**: `POST /api/users/{uuid}/two_factor_disable/`
1017
+ - **What it does**: Disable 2FA and remove all related devices
1018
+ - **OpenAPI operationId**: `users_two_factor_disable_create`
1019
+ - **Path params**: `uuid`
1020
+ - **Query params**: None
1021
+ - **Response codes**: `200`
1022
+ - **Transport options**: None
1023
+ - **TypeScript**: [Client interface](../types.ts)
1024
+
1025
+ **Inputs**
1026
+
1027
+ - Client input type: `{ [key: string]: unknown }`
1028
+ - Client transport options: None
1029
+
1030
+ **Outputs**
1031
+
1032
+ - Client return type: `unknown`
1033
+ - OpenAPI response codes: `200`
1034
+
1035
+ ```ts
1036
+ import posthog from "@utdk/posthog";
1037
+
1038
+ type UsersTwoFactorDisableCreateInput = Parameters<typeof posthog.usersTwoFactorDisableCreate> extends [infer T, ...unknown[]] ? T : undefined;
1039
+ type UsersTwoFactorDisableCreateOutput = Awaited<ReturnType<typeof posthog.usersTwoFactorDisableCreate>>;
1040
+
1041
+ const result: UsersTwoFactorDisableCreateOutput = await posthog.usersTwoFactorDisableCreate();
1042
+
1043
+ // Result shape (from schema): unknown
1044
+ ```
1045
+
1046
+ ### `posthog.usersTwoFactorStartSetupRetrieve`
1047
+
1048
+ - **HTTP**: `GET /api/users/{uuid}/two_factor_start_setup/`
1049
+ - **OpenAPI operationId**: `users_two_factor_start_setup_retrieve`
1050
+ - **Path params**: `uuid`
1051
+ - **Query params**: None
1052
+ - **Response codes**: `200`
1053
+ - **Transport options**: None
1054
+ - **TypeScript**: [Client interface](../types.ts)
1055
+
1056
+ **Inputs**
1057
+
1058
+ - Client input type: `{ [key: string]: unknown }`
1059
+ - Client transport options: None
1060
+
1061
+ **Outputs**
1062
+
1063
+ - Client return type: `unknown`
1064
+ - OpenAPI response codes: `200`
1065
+
1066
+ ```ts
1067
+ import posthog from "@utdk/posthog";
1068
+
1069
+ type UsersTwoFactorStartSetupRetrieveInput = Parameters<typeof posthog.usersTwoFactorStartSetupRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1070
+ type UsersTwoFactorStartSetupRetrieveOutput = Awaited<ReturnType<typeof posthog.usersTwoFactorStartSetupRetrieve>>;
1071
+
1072
+ const result: UsersTwoFactorStartSetupRetrieveOutput = await posthog.usersTwoFactorStartSetupRetrieve();
1073
+
1074
+ // Result shape (from schema): unknown
1075
+ ```
1076
+
1077
+ ### `posthog.usersTwoFactorStatusRetrieve`
1078
+
1079
+ - **HTTP**: `GET /api/users/{uuid}/two_factor_status/`
1080
+ - **What it does**: Get current 2FA status including backup codes if enabled
1081
+ - **OpenAPI operationId**: `users_two_factor_status_retrieve`
1082
+ - **Path params**: `uuid`
1083
+ - **Query params**: None
1084
+ - **Response codes**: `200`
1085
+ - **Transport options**: None
1086
+ - **TypeScript**: [Client interface](../types.ts)
1087
+
1088
+ **Inputs**
1089
+
1090
+ - Client input type: `{ [key: string]: unknown }`
1091
+ - Client transport options: None
1092
+
1093
+ **Outputs**
1094
+
1095
+ - Client return type: `unknown`
1096
+ - OpenAPI response codes: `200`
1097
+
1098
+ ```ts
1099
+ import posthog from "@utdk/posthog";
1100
+
1101
+ type UsersTwoFactorStatusRetrieveInput = Parameters<typeof posthog.usersTwoFactorStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
1102
+ type UsersTwoFactorStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.usersTwoFactorStatusRetrieve>>;
1103
+
1104
+ const result: UsersTwoFactorStatusRetrieveOutput = await posthog.usersTwoFactorStatusRetrieve();
1105
+
1106
+ // Result shape (from schema): unknown
1107
+ ```
1108
+
1109
+ ### `posthog.usersTwoFactorValidateCreate`
1110
+
1111
+ - **HTTP**: `POST /api/users/{uuid}/two_factor_validate/`
1112
+ - **OpenAPI operationId**: `users_two_factor_validate_create`
1113
+ - **Path params**: `uuid`
1114
+ - **Query params**: None
1115
+ - **Response codes**: `200`
1116
+ - **Transport options**: None
1117
+ - **TypeScript**: [Client interface](../types.ts)
1118
+
1119
+ **Inputs**
1120
+
1121
+ - Client input type: `{ [key: string]: unknown }`
1122
+ - Client transport options: None
1123
+
1124
+ **Outputs**
1125
+
1126
+ - Client return type: `unknown`
1127
+ - OpenAPI response codes: `200`
1128
+
1129
+ ```ts
1130
+ import posthog from "@utdk/posthog";
1131
+
1132
+ type UsersTwoFactorValidateCreateInput = Parameters<typeof posthog.usersTwoFactorValidateCreate> extends [infer T, ...unknown[]] ? T : undefined;
1133
+ type UsersTwoFactorValidateCreateOutput = Awaited<ReturnType<typeof posthog.usersTwoFactorValidateCreate>>;
1134
+
1135
+ const result: UsersTwoFactorValidateCreateOutput = await posthog.usersTwoFactorValidateCreate();
1136
+
1137
+ // Result shape (from schema): unknown
1138
+ ```
1139
+
1140
+ ### `posthog.usersValidate2FaCreate`
1141
+
1142
+ - **HTTP**: `POST /api/users/{uuid}/validate_2fa/`
1143
+ - **OpenAPI operationId**: `users_validate_2fa_create`
1144
+ - **Path params**: `uuid`
1145
+ - **Query params**: None
1146
+ - **Response codes**: `200`
1147
+ - **Transport options**: None
1148
+ - **TypeScript**: [Client interface](../types.ts)
1149
+
1150
+ **Inputs**
1151
+
1152
+ - Client input type: `{ [key: string]: unknown }`
1153
+ - Client transport options: None
1154
+
1155
+ **Outputs**
1156
+
1157
+ - Client return type: `unknown`
1158
+ - OpenAPI response codes: `200`
1159
+
1160
+ ```ts
1161
+ import posthog from "@utdk/posthog";
1162
+
1163
+ type UsersValidate2FaCreateInput = Parameters<typeof posthog.usersValidate2FaCreate> extends [infer T, ...unknown[]] ? T : undefined;
1164
+ type UsersValidate2FaCreateOutput = Awaited<ReturnType<typeof posthog.usersValidate2FaCreate>>;
1165
+
1166
+ const result: UsersValidate2FaCreateOutput = await posthog.usersValidate2FaCreate();
1167
+
1168
+ // Result shape (from schema): unknown
1169
+ ```
1170
+
1171
+ ### `posthog.usersCancelEmailChangeRequestPartialUpdate`
1172
+
1173
+ - **HTTP**: `PATCH /api/users/cancel_email_change_request/`
1174
+ - **OpenAPI operationId**: `users_cancel_email_change_request_partial_update`
1175
+ - **Path params**: None
1176
+ - **Query params**: None
1177
+ - **Response codes**: `200`
1178
+ - **Transport options**: None
1179
+ - **TypeScript**: [Client interface](../types.ts)
1180
+
1181
+ **Inputs**
1182
+
1183
+ - Client input type: `{ [key: string]: unknown }`
1184
+ - Client transport options: None
1185
+
1186
+ **Outputs**
1187
+
1188
+ - Client return type: `unknown`
1189
+ - OpenAPI response codes: `200`
1190
+
1191
+ ```ts
1192
+ import posthog from "@utdk/posthog";
1193
+
1194
+ type UsersCancelEmailChangeRequestPartialUpdateInput = Parameters<typeof posthog.usersCancelEmailChangeRequestPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
1195
+ type UsersCancelEmailChangeRequestPartialUpdateOutput = Awaited<ReturnType<typeof posthog.usersCancelEmailChangeRequestPartialUpdate>>;
1196
+
1197
+ const result: UsersCancelEmailChangeRequestPartialUpdateOutput = await posthog.usersCancelEmailChangeRequestPartialUpdate();
1198
+
1199
+ // Result shape (from schema): unknown
1200
+ ```
1201
+
1202
+ ### `posthog.usersRequestEmailVerificationCreate`
1203
+
1204
+ - **HTTP**: `POST /api/users/request_email_verification/`
1205
+ - **OpenAPI operationId**: `users_request_email_verification_create`
1206
+ - **Path params**: None
1207
+ - **Query params**: None
1208
+ - **Response codes**: `200`
1209
+ - **Transport options**: None
1210
+ - **TypeScript**: [Client interface](../types.ts)
1211
+
1212
+ **Inputs**
1213
+
1214
+ - Client input type: `{ [key: string]: unknown }`
1215
+ - Client transport options: None
1216
+
1217
+ **Outputs**
1218
+
1219
+ - Client return type: `unknown`
1220
+ - OpenAPI response codes: `200`
1221
+
1222
+ ```ts
1223
+ import posthog from "@utdk/posthog";
1224
+
1225
+ type UsersRequestEmailVerificationCreateInput = Parameters<typeof posthog.usersRequestEmailVerificationCreate> extends [infer T, ...unknown[]] ? T : undefined;
1226
+ type UsersRequestEmailVerificationCreateOutput = Awaited<ReturnType<typeof posthog.usersRequestEmailVerificationCreate>>;
1227
+
1228
+ const result: UsersRequestEmailVerificationCreateOutput = await posthog.usersRequestEmailVerificationCreate();
1229
+
1230
+ // Result shape (from schema): unknown
1231
+ ```
1232
+
1233
+ ### `posthog.usersVerifyEmailCreate`
1234
+
1235
+ - **HTTP**: `POST /api/users/verify_email/`
1236
+ - **OpenAPI operationId**: `users_verify_email_create`
1237
+ - **Path params**: None
1238
+ - **Query params**: None
1239
+ - **Response codes**: `200`
1240
+ - **Transport options**: None
1241
+ - **TypeScript**: [Client interface](../types.ts)
1242
+
1243
+ **Inputs**
1244
+
1245
+ - Client input type: `{ [key: string]: unknown }`
1246
+ - Client transport options: None
1247
+
1248
+ **Outputs**
1249
+
1250
+ - Client return type: `unknown`
1251
+ - OpenAPI response codes: `200`
1252
+
1253
+ ```ts
1254
+ import posthog from "@utdk/posthog";
1255
+
1256
+ type UsersVerifyEmailCreateInput = Parameters<typeof posthog.usersVerifyEmailCreate> extends [infer T, ...unknown[]] ? T : undefined;
1257
+ type UsersVerifyEmailCreateOutput = Awaited<ReturnType<typeof posthog.usersVerifyEmailCreate>>;
1258
+
1259
+ const result: UsersVerifyEmailCreateOutput = await posthog.usersVerifyEmailCreate();
1260
+
1261
+ // Result shape (from schema): unknown
1262
+ ```
1263
+
1264
+
1265
+ <!-- prompt-hash:
1266
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
1267
+ -->