@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,695 @@
1
+ # Conversations
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsConversationsViewsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/conversations/views/`
8
+ - **OpenAPI operationId**: `environments_conversations_views_list`
9
+ - **Path params**: None
10
+ - **Query params**: `limit`, `offset`
11
+ - **Response codes**: `200`
12
+ - **Transport options**: None
13
+ - **TypeScript**: [Client interface](../types.ts)
14
+
15
+ **Inputs**
16
+
17
+ - Client input type: `{ [key: string]: unknown }`
18
+ - Client transport options: None
19
+
20
+ **Outputs**
21
+
22
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; ...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsConversationsViewsListInput = Parameters<typeof posthog.environmentsConversationsViewsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsConversationsViewsListOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsViewsList>>;
30
+
31
+ const result: EnvironmentsConversationsViewsListOutput = await posthog.environmentsConversationsViewsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; ...
34
+ ```
35
+
36
+ ### `posthog.environmentsConversationsViewsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/views/`
39
+ - **OpenAPI operationId**: `environments_conversations_views_create`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `201`
43
+ - **Transport options**: None
44
+ - **TypeScript**: [Client interface](../types.ts)
45
+
46
+ **Inputs**
47
+
48
+ - Client input type: `{ [key: string]: unknown }`
49
+ - Client transport options: None
50
+
51
+ **Outputs**
52
+
53
+ - Client return type: `{ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsConversationsViewsCreateInput = Parameters<typeof posthog.environmentsConversationsViewsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsConversationsViewsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsViewsCreate>>;
61
+
62
+ const result: EnvironmentsConversationsViewsCreateOutput = await posthog.environmentsConversationsViewsCreate();
63
+
64
+ // Result shape (from schema): { id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...
65
+ ```
66
+
67
+ ### `posthog.environmentsConversationsViewsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/conversations/views/{short_id}/`
70
+ - **OpenAPI operationId**: `environments_conversations_views_destroy`
71
+ - **Path params**: `short_id`
72
+ - **Query params**: None
73
+ - **Response codes**: `204`
74
+ - **Transport options**: None
75
+ - **TypeScript**: [Client interface](../types.ts)
76
+
77
+ **Inputs**
78
+
79
+ - Client input type: `{ [key: string]: unknown }`
80
+ - Client transport options: None
81
+
82
+ **Outputs**
83
+
84
+ - Client return type: `unknown`
85
+ - OpenAPI response codes: `204`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type EnvironmentsConversationsViewsDestroyInput = Parameters<typeof posthog.environmentsConversationsViewsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsConversationsViewsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsViewsDestroy>>;
92
+
93
+ const result: EnvironmentsConversationsViewsDestroyOutput = await posthog.environmentsConversationsViewsDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsConversationsViewsRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/conversations/views/{short_id}/`
101
+ - **OpenAPI operationId**: `environments_conversations_views_retrieve`
102
+ - **Path params**: `short_id`
103
+ - **Query params**: None
104
+ - **Response codes**: `200`
105
+ - **Transport options**: None
106
+ - **TypeScript**: [Client interface](../types.ts)
107
+
108
+ **Inputs**
109
+
110
+ - Client input type: `{ [key: string]: unknown }`
111
+ - Client transport options: None
112
+
113
+ **Outputs**
114
+
115
+ - Client return type: `{ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsConversationsViewsRetrieveInput = Parameters<typeof posthog.environmentsConversationsViewsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsConversationsViewsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsViewsRetrieve>>;
123
+
124
+ const result: EnvironmentsConversationsViewsRetrieveOutput = await posthog.environmentsConversationsViewsRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...
127
+ ```
128
+
129
+ ### `posthog.conversationsTicketsList`
130
+
131
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/tickets/`
132
+ - **What it does**: List tickets with person data attached.
133
+ - **OpenAPI operationId**: `conversations_tickets_list`
134
+ - **Path params**: None
135
+ - **Query params**: `assignee`, `channel_detail`, `channel_source`, `date_from`, `date_to`, `distinct_ids`, `limit`, `offset`, `order_by`, `priority`, `search`, `sla`, `status`, `tags`, `tags_all`, `tags_exclude`
136
+ - **Response codes**: `200`
137
+ - **Transport options**: None
138
+ - **TypeScript**: [Client interface](../types.ts)
139
+
140
+ **Inputs**
141
+
142
+ - Client input type: `{ [key: string]: unknown }`
143
+ - Client transport options: None
144
+
145
+ **Outputs**
146
+
147
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" ...`
148
+ - OpenAPI response codes: `200`
149
+
150
+ ```ts
151
+ import posthog from "@utdk/posthog";
152
+
153
+ type ConversationsTicketsListInput = Parameters<typeof posthog.conversationsTicketsList> extends [infer T, ...unknown[]] ? T : undefined;
154
+ type ConversationsTicketsListOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsList>>;
155
+
156
+ const result: ConversationsTicketsListOutput = await posthog.conversationsTicketsList();
157
+
158
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" ...
159
+ ```
160
+
161
+ ### `posthog.conversationsTicketsCreate`
162
+
163
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/`
164
+ - **OpenAPI operationId**: `conversations_tickets_create`
165
+ - **Path params**: None
166
+ - **Query params**: None
167
+ - **Response codes**: `201`
168
+ - **Transport options**: None
169
+ - **TypeScript**: [Client interface](../types.ts)
170
+
171
+ **Inputs**
172
+
173
+ - Client input type: `{ [key: string]: unknown }`
174
+ - Client transport options: None
175
+
176
+ **Outputs**
177
+
178
+ - Client return type: `{ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...`
179
+ - OpenAPI response codes: `201`
180
+
181
+ ```ts
182
+ import posthog from "@utdk/posthog";
183
+
184
+ type ConversationsTicketsCreateInput = Parameters<typeof posthog.conversationsTicketsCreate> extends [infer T, ...unknown[]] ? T : undefined;
185
+ type ConversationsTicketsCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsCreate>>;
186
+
187
+ const result: ConversationsTicketsCreateOutput = await posthog.conversationsTicketsCreate();
188
+
189
+ // Result shape (from schema): { id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...
190
+ ```
191
+
192
+ ### `posthog.conversationsTicketsDestroy`
193
+
194
+ - **HTTP**: `DELETE /api/projects/{project_id}/conversations/tickets/{id}/`
195
+ - **OpenAPI operationId**: `conversations_tickets_destroy`
196
+ - **Path params**: `id`
197
+ - **Query params**: None
198
+ - **Response codes**: `204`
199
+ - **Transport options**: None
200
+ - **TypeScript**: [Client interface](../types.ts)
201
+
202
+ **Inputs**
203
+
204
+ - Client input type: `{ [key: string]: unknown }`
205
+ - Client transport options: None
206
+
207
+ **Outputs**
208
+
209
+ - Client return type: `unknown`
210
+ - OpenAPI response codes: `204`
211
+
212
+ ```ts
213
+ import posthog from "@utdk/posthog";
214
+
215
+ type ConversationsTicketsDestroyInput = Parameters<typeof posthog.conversationsTicketsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
216
+ type ConversationsTicketsDestroyOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsDestroy>>;
217
+
218
+ const result: ConversationsTicketsDestroyOutput = await posthog.conversationsTicketsDestroy();
219
+
220
+ // Result shape (from schema): unknown
221
+ ```
222
+
223
+ ### `posthog.conversationsTicketsRetrieve`
224
+
225
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/tickets/{id}/`
226
+ - **What it does**: Get single ticket and mark as read by team.
227
+ - **OpenAPI operationId**: `conversations_tickets_retrieve`
228
+ - **Path params**: `id`
229
+ - **Query params**: None
230
+ - **Response codes**: `200`
231
+ - **Transport options**: None
232
+ - **TypeScript**: [Client interface](../types.ts)
233
+
234
+ **Inputs**
235
+
236
+ - Client input type: `{ [key: string]: unknown }`
237
+ - Client transport options: None
238
+
239
+ **Outputs**
240
+
241
+ - Client return type: `{ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...`
242
+ - OpenAPI response codes: `200`
243
+
244
+ ```ts
245
+ import posthog from "@utdk/posthog";
246
+
247
+ type ConversationsTicketsRetrieveInput = Parameters<typeof posthog.conversationsTicketsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
248
+ type ConversationsTicketsRetrieveOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsRetrieve>>;
249
+
250
+ const result: ConversationsTicketsRetrieveOutput = await posthog.conversationsTicketsRetrieve();
251
+
252
+ // Result shape (from schema): { id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...
253
+ ```
254
+
255
+ ### `posthog.conversationsTicketsPartialUpdate`
256
+
257
+ - **HTTP**: `PATCH /api/projects/{project_id}/conversations/tickets/{id}/`
258
+ - **OpenAPI operationId**: `conversations_tickets_partial_update`
259
+ - **Path params**: `id`
260
+ - **Query params**: None
261
+ - **Response codes**: `200`
262
+ - **Transport options**: None
263
+ - **TypeScript**: [Client interface](../types.ts)
264
+
265
+ **Inputs**
266
+
267
+ - Client input type: `{ [key: string]: unknown }`
268
+ - Client transport options: None
269
+
270
+ **Outputs**
271
+
272
+ - Client return type: `{ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...`
273
+ - OpenAPI response codes: `200`
274
+
275
+ ```ts
276
+ import posthog from "@utdk/posthog";
277
+
278
+ type ConversationsTicketsPartialUpdateInput = Parameters<typeof posthog.conversationsTicketsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
279
+ type ConversationsTicketsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsPartialUpdate>>;
280
+
281
+ const result: ConversationsTicketsPartialUpdateOutput = await posthog.conversationsTicketsPartialUpdate();
282
+
283
+ // Result shape (from schema): { id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...
284
+ ```
285
+
286
+ ### `posthog.conversationsTicketsUpdate`
287
+
288
+ - **HTTP**: `PUT /api/projects/{project_id}/conversations/tickets/{id}/`
289
+ - **What it does**: Handle ticket updates including assignee changes.
290
+ - **OpenAPI operationId**: `conversations_tickets_update`
291
+ - **Path params**: `id`
292
+ - **Query params**: None
293
+ - **Response codes**: `200`
294
+ - **Transport options**: None
295
+ - **TypeScript**: [Client interface](../types.ts)
296
+
297
+ **Inputs**
298
+
299
+ - Client input type: `{ [key: string]: unknown }`
300
+ - Client transport options: None
301
+
302
+ **Outputs**
303
+
304
+ - Client return type: `{ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...`
305
+ - OpenAPI response codes: `200`
306
+
307
+ ```ts
308
+ import posthog from "@utdk/posthog";
309
+
310
+ type ConversationsTicketsUpdateInput = Parameters<typeof posthog.conversationsTicketsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
311
+ type ConversationsTicketsUpdateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsUpdate>>;
312
+
313
+ const result: ConversationsTicketsUpdateOutput = await posthog.conversationsTicketsUpdate();
314
+
315
+ // Result shape (from schema): { id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...
316
+ ```
317
+
318
+ ### `posthog.conversationsTicketsAiFeedbackCreate`
319
+
320
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/{id}/ai_feedback/`
321
+ - **What it does**: Record reviewer feedback on an AI reply, captured to the internal analytics project.
322
+ - **OpenAPI operationId**: `conversations_tickets_ai_feedback_create`
323
+ - **Path params**: `id`
324
+ - **Query params**: None
325
+ - **Response codes**: `202`
326
+ - **Transport options**: None
327
+ - **TypeScript**: [Client interface](../types.ts)
328
+
329
+ **Inputs**
330
+
331
+ - Client input type: `{ [key: string]: unknown }`
332
+ - Client transport options: None
333
+
334
+ **Outputs**
335
+
336
+ - Client return type: `unknown`
337
+ - OpenAPI response codes: `202`
338
+
339
+ ```ts
340
+ import posthog from "@utdk/posthog";
341
+
342
+ type ConversationsTicketsAiFeedbackCreateInput = Parameters<typeof posthog.conversationsTicketsAiFeedbackCreate> extends [infer T, ...unknown[]] ? T : undefined;
343
+ type ConversationsTicketsAiFeedbackCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsAiFeedbackCreate>>;
344
+
345
+ const result: ConversationsTicketsAiFeedbackCreateOutput = await posthog.conversationsTicketsAiFeedbackCreate();
346
+
347
+ // Result shape (from schema): unknown
348
+ ```
349
+
350
+ ### `posthog.conversationsTicketsMessagesList`
351
+
352
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/tickets/{id}/messages/`
353
+ - **What it does**: Return the message thread for a ticket, ordered chronologically (paginated).
354
+ - **OpenAPI operationId**: `conversations_tickets_messages_list`
355
+ - **Path params**: `id`
356
+ - **Query params**: `limit`, `offset`
357
+ - **Response codes**: `200`
358
+ - **Transport options**: None
359
+ - **TypeScript**: [Client interface](../types.ts)
360
+
361
+ **Inputs**
362
+
363
+ - Client input type: `{ [key: string]: unknown }`
364
+ - Client transport options: None
365
+
366
+ **Outputs**
367
+
368
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; content: string; rich_content: unknown; author_type: string; author_name: string; is_private: boolean; created_at: string })[] }`
369
+ - OpenAPI response codes: `200`
370
+
371
+ ```ts
372
+ import posthog from "@utdk/posthog";
373
+
374
+ type ConversationsTicketsMessagesListInput = Parameters<typeof posthog.conversationsTicketsMessagesList> extends [infer T, ...unknown[]] ? T : undefined;
375
+ type ConversationsTicketsMessagesListOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsMessagesList>>;
376
+
377
+ const result: ConversationsTicketsMessagesListOutput = await posthog.conversationsTicketsMessagesList();
378
+
379
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; content: string; rich_content: unknown; author_type: string; author_name: string; is_private: boolean; created_at: string })[] }
380
+ ```
381
+
382
+ ### `posthog.conversationsTicketsReplyCreate`
383
+
384
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/{id}/reply/`
385
+ - **What it does**: Post a reply or internal note to a ticket.
386
+
387
+ With is_private=false, the reply is delivered to the customer via the
388
+ ticket's channel (email, Slack, Teams, GitHub). With is_private=true,
389
+ the message is stored as an internal note only visible to team members.
390
+ - **OpenAPI operationId**: `conversations_tickets_reply_create`
391
+ - **Path params**: `id`
392
+ - **Query params**: None
393
+ - **Response codes**: `201`
394
+ - **Transport options**: None
395
+ - **TypeScript**: [Client interface](../types.ts)
396
+
397
+ **Inputs**
398
+
399
+ - Client input type: `{ [key: string]: unknown }`
400
+ - Client transport options: None
401
+
402
+ **Outputs**
403
+
404
+ - Client return type: `{ id: string; content: string; rich_content: unknown; author_type: string; author_name: string; is_private: boolean; created_at: string }`
405
+ - OpenAPI response codes: `201`
406
+
407
+ ```ts
408
+ import posthog from "@utdk/posthog";
409
+
410
+ type ConversationsTicketsReplyCreateInput = Parameters<typeof posthog.conversationsTicketsReplyCreate> extends [infer T, ...unknown[]] ? T : undefined;
411
+ type ConversationsTicketsReplyCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsReplyCreate>>;
412
+
413
+ const result: ConversationsTicketsReplyCreateOutput = await posthog.conversationsTicketsReplyCreate();
414
+
415
+ // Result shape (from schema): { id: string; content: string; rich_content: unknown; author_type: string; author_name: string; is_private: boolean; created_at: string }
416
+ ```
417
+
418
+ ### `posthog.conversationsTicketsBulkUpdateStatusCreate`
419
+
420
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/bulk_update_status/`
421
+ - **What it does**: Update the status of multiple tickets in a single request.
422
+
423
+ Only tickets belonging to the current team are affected; other-team UUIDs
424
+ are silently ignored. Tickets already in the requested status are skipped.
425
+ - **OpenAPI operationId**: `conversations_tickets_bulk_update_status_create`
426
+ - **Path params**: None
427
+ - **Query params**: None
428
+ - **Response codes**: `200`
429
+ - **Transport options**: None
430
+ - **TypeScript**: [Client interface](../types.ts)
431
+
432
+ **Inputs**
433
+
434
+ - Client input type: `{ [key: string]: unknown }`
435
+ - Client transport options: None
436
+
437
+ **Outputs**
438
+
439
+ - Client return type: `{ updated: number; ids: (string)[] }`
440
+ - OpenAPI response codes: `200`
441
+
442
+ ```ts
443
+ import posthog from "@utdk/posthog";
444
+
445
+ type ConversationsTicketsBulkUpdateStatusCreateInput = Parameters<typeof posthog.conversationsTicketsBulkUpdateStatusCreate> extends [infer T, ...unknown[]] ? T : undefined;
446
+ type ConversationsTicketsBulkUpdateStatusCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsBulkUpdateStatusCreate>>;
447
+
448
+ const result: ConversationsTicketsBulkUpdateStatusCreateOutput = await posthog.conversationsTicketsBulkUpdateStatusCreate();
449
+
450
+ // Result shape (from schema): { updated: number; ids: (string)[] }
451
+ ```
452
+
453
+ ### `posthog.conversationsTicketsBulkUpdateTagsCreate`
454
+
455
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/bulk_update_tags/`
456
+ - **What it does**: Bulk update tags on multiple objects.
457
+
458
+ PAT access: this action has no ``required_scopes=`` on the decorator —
459
+ inheriting viewsets must add ``"bulk_update_tags"`` to their
460
+ ``scope_object_write_actions`` list to accept personal API keys.
461
+ Without that opt-in, ``APIScopePermission`` rejects PAT requests with
462
+ "This action does not support personal API key access". Done per-viewset
463
+ so granting ``<scope>:write`` for one resource doesn't leak access to
464
+ sibling resources that share this mixin.
465
+
466
+ Accepts:
467
+ - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}
468
+
469
+ Actions:
470
+ - "add": Add tags to existing tags on each object
471
+ - "remove": Remove specific tags from each object
472
+ - "set": Replace all tags on each object with the provided list
473
+ - **OpenAPI operationId**: `conversations_tickets_bulk_update_tags_create`
474
+ - **Path params**: None
475
+ - **Query params**: None
476
+ - **Response codes**: `200`
477
+ - **Transport options**: None
478
+ - **TypeScript**: [Client interface](../types.ts)
479
+
480
+ **Inputs**
481
+
482
+ - Client input type: `{ [key: string]: unknown }`
483
+ - Client transport options: None
484
+
485
+ **Outputs**
486
+
487
+ - Client return type: `{ updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }`
488
+ - OpenAPI response codes: `200`
489
+
490
+ ```ts
491
+ import posthog from "@utdk/posthog";
492
+
493
+ type ConversationsTicketsBulkUpdateTagsCreateInput = Parameters<typeof posthog.conversationsTicketsBulkUpdateTagsCreate> extends [infer T, ...unknown[]] ? T : undefined;
494
+ type ConversationsTicketsBulkUpdateTagsCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsBulkUpdateTagsCreate>>;
495
+
496
+ const result: ConversationsTicketsBulkUpdateTagsCreateOutput = await posthog.conversationsTicketsBulkUpdateTagsCreate();
497
+
498
+ // Result shape (from schema): { updated: ({ id: number; tags: (string)[] })[]; skipped: ({ id: number; reason: string })[] }
499
+ ```
500
+
501
+ ### `posthog.conversationsTicketsComposeCreate`
502
+
503
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/tickets/compose/`
504
+ - **What it does**: Create a new outbound ticket and send the first message to the customer.
505
+ - **OpenAPI operationId**: `conversations_tickets_compose_create`
506
+ - **Path params**: None
507
+ - **Query params**: None
508
+ - **Response codes**: `201`, `400`
509
+ - **Transport options**: None
510
+ - **TypeScript**: [Client interface](../types.ts)
511
+
512
+ **Inputs**
513
+
514
+ - Client input type: `{ [key: string]: unknown }`
515
+ - Client transport options: None
516
+
517
+ **Outputs**
518
+
519
+ - Client return type: `{ id: string; ticket_number: number }`
520
+ - OpenAPI response codes: `201`, `400`
521
+
522
+ ```ts
523
+ import posthog from "@utdk/posthog";
524
+
525
+ type ConversationsTicketsComposeCreateInput = Parameters<typeof posthog.conversationsTicketsComposeCreate> extends [infer T, ...unknown[]] ? T : undefined;
526
+ type ConversationsTicketsComposeCreateOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsComposeCreate>>;
527
+
528
+ const result: ConversationsTicketsComposeCreateOutput = await posthog.conversationsTicketsComposeCreate();
529
+
530
+ // Result shape (from schema): { id: string; ticket_number: number }
531
+ ```
532
+
533
+ ### `posthog.conversationsTicketsUnreadCountRetrieve`
534
+
535
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/tickets/unread_count/`
536
+ - **What it does**: Get total unread ticket count for the team.
537
+
538
+ Returns the sum of unread_team_count for all non-resolved tickets.
539
+ Cached in Redis for 30 seconds, invalidated on changes.
540
+ - **OpenAPI operationId**: `conversations_tickets_unread_count_retrieve`
541
+ - **Path params**: None
542
+ - **Query params**: None
543
+ - **Response codes**: `200`
544
+ - **Transport options**: None
545
+ - **TypeScript**: [Client interface](../types.ts)
546
+
547
+ **Inputs**
548
+
549
+ - Client input type: `{ [key: string]: unknown }`
550
+ - Client transport options: None
551
+
552
+ **Outputs**
553
+
554
+ - Client return type: `{ id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...`
555
+ - OpenAPI response codes: `200`
556
+
557
+ ```ts
558
+ import posthog from "@utdk/posthog";
559
+
560
+ type ConversationsTicketsUnreadCountRetrieveInput = Parameters<typeof posthog.conversationsTicketsUnreadCountRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
561
+ type ConversationsTicketsUnreadCountRetrieveOutput = Awaited<ReturnType<typeof posthog.conversationsTicketsUnreadCountRetrieve>>;
562
+
563
+ const result: ConversationsTicketsUnreadCountRetrieveOutput = await posthog.conversationsTicketsUnreadCountRetrieve();
564
+
565
+ // Result shape (from schema): { id: string; ticket_number: number; channel_source: "widget" | "email" | "slack" | "teams" | "github"; channel_detail: "slack_channel_message" | "slack_bot_mention" | "slack_emoji_reaction" | "teams_channel_message" | ...
566
+ ```
567
+
568
+ ### `posthog.conversationsViewsList`
569
+
570
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/views/`
571
+ - **OpenAPI operationId**: `conversations_views_list`
572
+ - **Path params**: None
573
+ - **Query params**: `limit`, `offset`
574
+ - **Response codes**: `200`
575
+ - **Transport options**: None
576
+ - **TypeScript**: [Client interface](../types.ts)
577
+
578
+ **Inputs**
579
+
580
+ - Client input type: `{ [key: string]: unknown }`
581
+ - Client transport options: None
582
+
583
+ **Outputs**
584
+
585
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; ...`
586
+ - OpenAPI response codes: `200`
587
+
588
+ ```ts
589
+ import posthog from "@utdk/posthog";
590
+
591
+ type ConversationsViewsListInput = Parameters<typeof posthog.conversationsViewsList> extends [infer T, ...unknown[]] ? T : undefined;
592
+ type ConversationsViewsListOutput = Awaited<ReturnType<typeof posthog.conversationsViewsList>>;
593
+
594
+ const result: ConversationsViewsListOutput = await posthog.conversationsViewsList();
595
+
596
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; ...
597
+ ```
598
+
599
+ ### `posthog.conversationsViewsCreate`
600
+
601
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/views/`
602
+ - **OpenAPI operationId**: `conversations_views_create`
603
+ - **Path params**: None
604
+ - **Query params**: None
605
+ - **Response codes**: `201`
606
+ - **Transport options**: None
607
+ - **TypeScript**: [Client interface](../types.ts)
608
+
609
+ **Inputs**
610
+
611
+ - Client input type: `{ [key: string]: unknown }`
612
+ - Client transport options: None
613
+
614
+ **Outputs**
615
+
616
+ - Client return type: `{ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...`
617
+ - OpenAPI response codes: `201`
618
+
619
+ ```ts
620
+ import posthog from "@utdk/posthog";
621
+
622
+ type ConversationsViewsCreateInput = Parameters<typeof posthog.conversationsViewsCreate> extends [infer T, ...unknown[]] ? T : undefined;
623
+ type ConversationsViewsCreateOutput = Awaited<ReturnType<typeof posthog.conversationsViewsCreate>>;
624
+
625
+ const result: ConversationsViewsCreateOutput = await posthog.conversationsViewsCreate();
626
+
627
+ // Result shape (from schema): { id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...
628
+ ```
629
+
630
+ ### `posthog.conversationsViewsDestroy`
631
+
632
+ - **HTTP**: `DELETE /api/projects/{project_id}/conversations/views/{short_id}/`
633
+ - **OpenAPI operationId**: `conversations_views_destroy`
634
+ - **Path params**: `short_id`
635
+ - **Query params**: None
636
+ - **Response codes**: `204`
637
+ - **Transport options**: None
638
+ - **TypeScript**: [Client interface](../types.ts)
639
+
640
+ **Inputs**
641
+
642
+ - Client input type: `{ [key: string]: unknown }`
643
+ - Client transport options: None
644
+
645
+ **Outputs**
646
+
647
+ - Client return type: `unknown`
648
+ - OpenAPI response codes: `204`
649
+
650
+ ```ts
651
+ import posthog from "@utdk/posthog";
652
+
653
+ type ConversationsViewsDestroyInput = Parameters<typeof posthog.conversationsViewsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
654
+ type ConversationsViewsDestroyOutput = Awaited<ReturnType<typeof posthog.conversationsViewsDestroy>>;
655
+
656
+ const result: ConversationsViewsDestroyOutput = await posthog.conversationsViewsDestroy();
657
+
658
+ // Result shape (from schema): unknown
659
+ ```
660
+
661
+ ### `posthog.conversationsViewsRetrieve`
662
+
663
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/views/{short_id}/`
664
+ - **OpenAPI operationId**: `conversations_views_retrieve`
665
+ - **Path params**: `short_id`
666
+ - **Query params**: None
667
+ - **Response codes**: `200`
668
+ - **Transport options**: None
669
+ - **TypeScript**: [Client interface](../types.ts)
670
+
671
+ **Inputs**
672
+
673
+ - Client input type: `{ [key: string]: unknown }`
674
+ - Client transport options: None
675
+
676
+ **Outputs**
677
+
678
+ - Client return type: `{ id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...`
679
+ - OpenAPI response codes: `200`
680
+
681
+ ```ts
682
+ import posthog from "@utdk/posthog";
683
+
684
+ type ConversationsViewsRetrieveInput = Parameters<typeof posthog.conversationsViewsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
685
+ type ConversationsViewsRetrieveOutput = Awaited<ReturnType<typeof posthog.conversationsViewsRetrieve>>;
686
+
687
+ const result: ConversationsViewsRetrieveOutput = await posthog.conversationsViewsRetrieve();
688
+
689
+ // Result shape (from schema): { id: string; short_id: string; name: string; filters?: { [key: string]: unknown }; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email...
690
+ ```
691
+
692
+
693
+ <!-- prompt-hash:
694
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
695
+ -->