@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,260 @@
1
+ # Session Recordings
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsSessionRecordingsSharingList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/`
8
+ - **OpenAPI operationId**: `environments_session_recordings_sharing_list`
9
+ - **Path params**: `recording_id`
10
+ - **Query params**: None
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: `({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsSessionRecordingsSharingListInput = Parameters<typeof posthog.environmentsSessionRecordingsSharingList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsSessionRecordingsSharingListOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsSharingList>>;
30
+
31
+ const result: EnvironmentsSessionRecordingsSharingListOutput = await posthog.environmentsSessionRecordingsSharingList();
32
+
33
+ // Result shape (from schema): ({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...
34
+ ```
35
+
36
+ ### `posthog.environmentsSessionRecordingsSharingPasswordsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/passwords/`
39
+ - **What it does**: Create a new password for the sharing configuration.
40
+ - **OpenAPI operationId**: `environments_session_recordings_sharing_passwords_create`
41
+ - **Path params**: `recording_id`
42
+ - **Query params**: None
43
+ - **Response codes**: `200`
44
+ - **Transport options**: None
45
+ - **TypeScript**: [Client interface](../types.ts)
46
+
47
+ **Inputs**
48
+
49
+ - Client input type: `{ [key: string]: unknown }`
50
+ - Client transport options: None
51
+
52
+ **Outputs**
53
+
54
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
55
+ - OpenAPI response codes: `200`
56
+
57
+ ```ts
58
+ import posthog from "@utdk/posthog";
59
+
60
+ type EnvironmentsSessionRecordingsSharingPasswordsCreateInput = Parameters<typeof posthog.environmentsSessionRecordingsSharingPasswordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
61
+ type EnvironmentsSessionRecordingsSharingPasswordsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsSharingPasswordsCreate>>;
62
+
63
+ const result: EnvironmentsSessionRecordingsSharingPasswordsCreateOutput = await posthog.environmentsSessionRecordingsSharingPasswordsCreate();
64
+
65
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
66
+ ```
67
+
68
+ ### `posthog.environmentsSessionRecordingsSharingPasswordsDestroy`
69
+
70
+ - **HTTP**: `DELETE /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/passwords/{password_id}/`
71
+ - **What it does**: Delete a password from the sharing configuration.
72
+ - **OpenAPI operationId**: `environments_session_recordings_sharing_passwords_destroy`
73
+ - **Path params**: `password_id`, `recording_id`
74
+ - **Query params**: None
75
+ - **Response codes**: `204`
76
+ - **Transport options**: None
77
+ - **TypeScript**: [Client interface](../types.ts)
78
+
79
+ **Inputs**
80
+
81
+ - Client input type: `{ [key: string]: unknown }`
82
+ - Client transport options: None
83
+
84
+ **Outputs**
85
+
86
+ - Client return type: `unknown`
87
+ - OpenAPI response codes: `204`
88
+
89
+ ```ts
90
+ import posthog from "@utdk/posthog";
91
+
92
+ type EnvironmentsSessionRecordingsSharingPasswordsDestroyInput = Parameters<typeof posthog.environmentsSessionRecordingsSharingPasswordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
93
+ type EnvironmentsSessionRecordingsSharingPasswordsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsSharingPasswordsDestroy>>;
94
+
95
+ const result: EnvironmentsSessionRecordingsSharingPasswordsDestroyOutput = await posthog.environmentsSessionRecordingsSharingPasswordsDestroy();
96
+
97
+ // Result shape (from schema): unknown
98
+ ```
99
+
100
+ ### `posthog.environmentsSessionRecordingsSharingRefreshCreate`
101
+
102
+ - **HTTP**: `POST /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/refresh/`
103
+ - **OpenAPI operationId**: `environments_session_recordings_sharing_refresh_create`
104
+ - **Path params**: `recording_id`
105
+ - **Query params**: None
106
+ - **Response codes**: `200`
107
+ - **Transport options**: None
108
+ - **TypeScript**: [Client interface](../types.ts)
109
+
110
+ **Inputs**
111
+
112
+ - Client input type: `{ [key: string]: unknown }`
113
+ - Client transport options: None
114
+
115
+ **Outputs**
116
+
117
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
118
+ - OpenAPI response codes: `200`
119
+
120
+ ```ts
121
+ import posthog from "@utdk/posthog";
122
+
123
+ type EnvironmentsSessionRecordingsSharingRefreshCreateInput = Parameters<typeof posthog.environmentsSessionRecordingsSharingRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
124
+ type EnvironmentsSessionRecordingsSharingRefreshCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSessionRecordingsSharingRefreshCreate>>;
125
+
126
+ const result: EnvironmentsSessionRecordingsSharingRefreshCreateOutput = await posthog.environmentsSessionRecordingsSharingRefreshCreate();
127
+
128
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
129
+ ```
130
+
131
+ ### `posthog.sessionRecordingsSharingList`
132
+
133
+ - **HTTP**: `GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing/`
134
+ - **OpenAPI operationId**: `session_recordings_sharing_list`
135
+ - **Path params**: `recording_id`
136
+ - **Query params**: None
137
+ - **Response codes**: `200`
138
+ - **Transport options**: None
139
+ - **TypeScript**: [Client interface](../types.ts)
140
+
141
+ **Inputs**
142
+
143
+ - Client input type: `{ [key: string]: unknown }`
144
+ - Client transport options: None
145
+
146
+ **Outputs**
147
+
148
+ - Client return type: `({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...`
149
+ - OpenAPI response codes: `200`
150
+
151
+ ```ts
152
+ import posthog from "@utdk/posthog";
153
+
154
+ type SessionRecordingsSharingListInput = Parameters<typeof posthog.sessionRecordingsSharingList> extends [infer T, ...unknown[]] ? T : undefined;
155
+ type SessionRecordingsSharingListOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsSharingList>>;
156
+
157
+ const result: SessionRecordingsSharingListOutput = await posthog.sessionRecordingsSharingList();
158
+
159
+ // Result shape (from schema): ({ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string;...
160
+ ```
161
+
162
+ ### `posthog.sessionRecordingsSharingPasswordsCreate`
163
+
164
+ - **HTTP**: `POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/`
165
+ - **What it does**: Create a new password for the sharing configuration.
166
+ - **OpenAPI operationId**: `session_recordings_sharing_passwords_create`
167
+ - **Path params**: `recording_id`
168
+ - **Query params**: None
169
+ - **Response codes**: `200`
170
+ - **Transport options**: None
171
+ - **TypeScript**: [Client interface](../types.ts)
172
+
173
+ **Inputs**
174
+
175
+ - Client input type: `{ [key: string]: unknown }`
176
+ - Client transport options: None
177
+
178
+ **Outputs**
179
+
180
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
181
+ - OpenAPI response codes: `200`
182
+
183
+ ```ts
184
+ import posthog from "@utdk/posthog";
185
+
186
+ type SessionRecordingsSharingPasswordsCreateInput = Parameters<typeof posthog.sessionRecordingsSharingPasswordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
187
+ type SessionRecordingsSharingPasswordsCreateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsSharingPasswordsCreate>>;
188
+
189
+ const result: SessionRecordingsSharingPasswordsCreateOutput = await posthog.sessionRecordingsSharingPasswordsCreate();
190
+
191
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
192
+ ```
193
+
194
+ ### `posthog.sessionRecordingsSharingPasswordsDestroy`
195
+
196
+ - **HTTP**: `DELETE /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/{password_id}/`
197
+ - **What it does**: Delete a password from the sharing configuration.
198
+ - **OpenAPI operationId**: `session_recordings_sharing_passwords_destroy`
199
+ - **Path params**: `password_id`, `recording_id`
200
+ - **Query params**: None
201
+ - **Response codes**: `204`
202
+ - **Transport options**: None
203
+ - **TypeScript**: [Client interface](../types.ts)
204
+
205
+ **Inputs**
206
+
207
+ - Client input type: `{ [key: string]: unknown }`
208
+ - Client transport options: None
209
+
210
+ **Outputs**
211
+
212
+ - Client return type: `unknown`
213
+ - OpenAPI response codes: `204`
214
+
215
+ ```ts
216
+ import posthog from "@utdk/posthog";
217
+
218
+ type SessionRecordingsSharingPasswordsDestroyInput = Parameters<typeof posthog.sessionRecordingsSharingPasswordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
219
+ type SessionRecordingsSharingPasswordsDestroyOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsSharingPasswordsDestroy>>;
220
+
221
+ const result: SessionRecordingsSharingPasswordsDestroyOutput = await posthog.sessionRecordingsSharingPasswordsDestroy();
222
+
223
+ // Result shape (from schema): unknown
224
+ ```
225
+
226
+ ### `posthog.sessionRecordingsSharingRefreshCreate`
227
+
228
+ - **HTTP**: `POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/refresh/`
229
+ - **OpenAPI operationId**: `session_recordings_sharing_refresh_create`
230
+ - **Path params**: `recording_id`
231
+ - **Query params**: None
232
+ - **Response codes**: `200`
233
+ - **Transport options**: None
234
+ - **TypeScript**: [Client interface](../types.ts)
235
+
236
+ **Inputs**
237
+
238
+ - Client input type: `{ [key: string]: unknown }`
239
+ - Client transport options: None
240
+
241
+ **Outputs**
242
+
243
+ - Client return type: `{ created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...`
244
+ - OpenAPI response codes: `200`
245
+
246
+ ```ts
247
+ import posthog from "@utdk/posthog";
248
+
249
+ type SessionRecordingsSharingRefreshCreateInput = Parameters<typeof posthog.sessionRecordingsSharingRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
250
+ type SessionRecordingsSharingRefreshCreateOutput = Awaited<ReturnType<typeof posthog.sessionRecordingsSharingRefreshCreate>>;
251
+
252
+ const result: SessionRecordingsSharingRefreshCreateOutput = await posthog.sessionRecordingsSharingRefreshCreate();
253
+
254
+ // Result shape (from schema): { created_at: string; enabled?: boolean; access_token: string | null; settings?: unknown; password_required?: boolean; share_passwords: ({ id: number; created_at: string; note?: string | null; created_by_email: string; ...
255
+ ```
256
+
257
+
258
+ <!-- prompt-hash:
259
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
260
+ -->
@@ -0,0 +1,200 @@
1
+ # Session Summaries
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsRetrieveSessionSummariesConfig`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/session_summaries/config/`
8
+ - **What it does**: Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).
9
+ - **OpenAPI operationId**: `environments_retrieve_session_summaries_config`
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: `{ product_context?: string; custom_tags?: { [key: string]: string | undefined } }`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type EnvironmentsRetrieveSessionSummariesConfigInput = Parameters<typeof posthog.environmentsRetrieveSessionSummariesConfig> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type EnvironmentsRetrieveSessionSummariesConfigOutput = Awaited<ReturnType<typeof posthog.environmentsRetrieveSessionSummariesConfig>>;
31
+
32
+ const result: EnvironmentsRetrieveSessionSummariesConfigOutput = await posthog.environmentsRetrieveSessionSummariesConfig();
33
+
34
+ // Result shape (from schema): { product_context?: string; custom_tags?: { [key: string]: string | undefined } }
35
+ ```
36
+
37
+ ### `posthog.environmentsUpdateSessionSummariesConfig`
38
+
39
+ - **HTTP**: `PATCH /api/environments/{environment_id}/session_summaries/config/`
40
+ - **What it does**: Update the team's session summaries configuration (product context used to tailor single-session replay summaries).
41
+ - **OpenAPI operationId**: `environments_update_session_summaries_config`
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: `{ product_context?: string; custom_tags?: { [key: string]: string | undefined } }`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type EnvironmentsUpdateSessionSummariesConfigInput = Parameters<typeof posthog.environmentsUpdateSessionSummariesConfig> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type EnvironmentsUpdateSessionSummariesConfigOutput = Awaited<ReturnType<typeof posthog.environmentsUpdateSessionSummariesConfig>>;
63
+
64
+ const result: EnvironmentsUpdateSessionSummariesConfigOutput = await posthog.environmentsUpdateSessionSummariesConfig();
65
+
66
+ // Result shape (from schema): { product_context?: string; custom_tags?: { [key: string]: string | undefined } }
67
+ ```
68
+
69
+ ### `posthog.environmentsCreateSessionSummaries`
70
+
71
+ - **HTTP**: `POST /api/environments/{environment_id}/session_summaries/create_session_summaries/`
72
+ - **What it does**: Generate AI summary for a group of session recordings to find patterns and generate a notebook.
73
+ - **OpenAPI operationId**: `environments_create_session_summaries`
74
+ - **Path params**: None
75
+ - **Query params**: None
76
+ - **Response codes**: `200`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `{ session_ids: (string)[]; focus_area?: string }`
88
+ - OpenAPI response codes: `200`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type EnvironmentsCreateSessionSummariesInput = Parameters<typeof posthog.environmentsCreateSessionSummaries> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type EnvironmentsCreateSessionSummariesOutput = Awaited<ReturnType<typeof posthog.environmentsCreateSessionSummaries>>;
95
+
96
+ const result: EnvironmentsCreateSessionSummariesOutput = await posthog.environmentsCreateSessionSummaries();
97
+
98
+ // Result shape (from schema): { session_ids: (string)[]; focus_area?: string }
99
+ ```
100
+
101
+ ### `posthog.retrieveSessionSummariesConfig`
102
+
103
+ - **HTTP**: `GET /api/projects/{project_id}/session_summaries/config/`
104
+ - **What it does**: Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries).
105
+ - **OpenAPI operationId**: `retrieve_session_summaries_config`
106
+ - **Path params**: None
107
+ - **Query params**: None
108
+ - **Response codes**: `200`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `{ product_context?: string; custom_tags?: { [key: string]: string | undefined } }`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type RetrieveSessionSummariesConfigInput = Parameters<typeof posthog.retrieveSessionSummariesConfig> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type RetrieveSessionSummariesConfigOutput = Awaited<ReturnType<typeof posthog.retrieveSessionSummariesConfig>>;
127
+
128
+ const result: RetrieveSessionSummariesConfigOutput = await posthog.retrieveSessionSummariesConfig();
129
+
130
+ // Result shape (from schema): { product_context?: string; custom_tags?: { [key: string]: string | undefined } }
131
+ ```
132
+
133
+ ### `posthog.updateSessionSummariesConfig`
134
+
135
+ - **HTTP**: `PATCH /api/projects/{project_id}/session_summaries/config/`
136
+ - **What it does**: Update the team's session summaries configuration (product context used to tailor single-session replay summaries).
137
+ - **OpenAPI operationId**: `update_session_summaries_config`
138
+ - **Path params**: None
139
+ - **Query params**: None
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ product_context?: string; custom_tags?: { [key: string]: string | undefined } }`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type UpdateSessionSummariesConfigInput = Parameters<typeof posthog.updateSessionSummariesConfig> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type UpdateSessionSummariesConfigOutput = Awaited<ReturnType<typeof posthog.updateSessionSummariesConfig>>;
159
+
160
+ const result: UpdateSessionSummariesConfigOutput = await posthog.updateSessionSummariesConfig();
161
+
162
+ // Result shape (from schema): { product_context?: string; custom_tags?: { [key: string]: string | undefined } }
163
+ ```
164
+
165
+ ### `posthog.createSessionSummaries`
166
+
167
+ - **HTTP**: `POST /api/projects/{project_id}/session_summaries/create_session_summaries/`
168
+ - **What it does**: Generate AI summary for a group of session recordings to find patterns and generate a notebook.
169
+ - **OpenAPI operationId**: `create_session_summaries`
170
+ - **Path params**: None
171
+ - **Query params**: None
172
+ - **Response codes**: `200`
173
+ - **Transport options**: None
174
+ - **TypeScript**: [Client interface](../types.ts)
175
+
176
+ **Inputs**
177
+
178
+ - Client input type: `{ [key: string]: unknown }`
179
+ - Client transport options: None
180
+
181
+ **Outputs**
182
+
183
+ - Client return type: `{ session_ids: (string)[]; focus_area?: string }`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type CreateSessionSummariesInput = Parameters<typeof posthog.createSessionSummaries> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type CreateSessionSummariesOutput = Awaited<ReturnType<typeof posthog.createSessionSummaries>>;
191
+
192
+ const result: CreateSessionSummariesOutput = await posthog.createSessionSummaries();
193
+
194
+ // Result shape (from schema): { session_ids: (string)[]; focus_area?: string }
195
+ ```
196
+
197
+
198
+ <!-- prompt-hash:
199
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
200
+ -->
@@ -0,0 +1,132 @@
1
+ # Sessions
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsSessionsPropertyDefinitionsRetrieve`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/sessions/property_definitions/`
8
+ - **OpenAPI operationId**: `environments_sessions_property_definitions_retrieve`
9
+ - **Path params**: None
10
+ - **Query params**: None
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: `unknown`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsSessionsPropertyDefinitionsRetrieveInput = Parameters<typeof posthog.environmentsSessionsPropertyDefinitionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsSessionsPropertyDefinitionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSessionsPropertyDefinitionsRetrieve>>;
30
+
31
+ const result: EnvironmentsSessionsPropertyDefinitionsRetrieveOutput = await posthog.environmentsSessionsPropertyDefinitionsRetrieve();
32
+
33
+ // Result shape (from schema): unknown
34
+ ```
35
+
36
+ ### `posthog.environmentsSessionsValuesRetrieve`
37
+
38
+ - **HTTP**: `GET /api/environments/{environment_id}/sessions/values/`
39
+ - **OpenAPI operationId**: `environments_sessions_values_retrieve`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `200`
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: `unknown`
54
+ - OpenAPI response codes: `200`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsSessionsValuesRetrieveInput = Parameters<typeof posthog.environmentsSessionsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsSessionsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSessionsValuesRetrieve>>;
61
+
62
+ const result: EnvironmentsSessionsValuesRetrieveOutput = await posthog.environmentsSessionsValuesRetrieve();
63
+
64
+ // Result shape (from schema): unknown
65
+ ```
66
+
67
+ ### `posthog.sessionsPropertyDefinitionsRetrieve`
68
+
69
+ - **HTTP**: `GET /api/projects/{project_id}/sessions/property_definitions/`
70
+ - **OpenAPI operationId**: `sessions_property_definitions_retrieve`
71
+ - **Path params**: None
72
+ - **Query params**: None
73
+ - **Response codes**: `200`
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: `200`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type SessionsPropertyDefinitionsRetrieveInput = Parameters<typeof posthog.sessionsPropertyDefinitionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type SessionsPropertyDefinitionsRetrieveOutput = Awaited<ReturnType<typeof posthog.sessionsPropertyDefinitionsRetrieve>>;
92
+
93
+ const result: SessionsPropertyDefinitionsRetrieveOutput = await posthog.sessionsPropertyDefinitionsRetrieve();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.sessionsValuesRetrieve`
99
+
100
+ - **HTTP**: `GET /api/projects/{project_id}/sessions/values/`
101
+ - **OpenAPI operationId**: `sessions_values_retrieve`
102
+ - **Path params**: None
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: `unknown`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type SessionsValuesRetrieveInput = Parameters<typeof posthog.sessionsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type SessionsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.sessionsValuesRetrieve>>;
123
+
124
+ const result: SessionsValuesRetrieveOutput = await posthog.sessionsValuesRetrieve();
125
+
126
+ // Result shape (from schema): unknown
127
+ ```
128
+
129
+
130
+ <!-- prompt-hash:
131
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
132
+ -->