@utdk/posthog 1.0.0-20260712.5-dev.e2949a6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
@@ -0,0 +1,380 @@
1
+ # Customer Profile Configs
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsCustomerProfileConfigsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/customer_profile_configs/`
8
+ - **OpenAPI operationId**: `environments_customer_profile_configs_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; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: str...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsCustomerProfileConfigsListInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsCustomerProfileConfigsListOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsList>>;
30
+
31
+ const result: EnvironmentsCustomerProfileConfigsListOutput = await posthog.environmentsCustomerProfileConfigsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: str...
34
+ ```
35
+
36
+ ### `posthog.environmentsCustomerProfileConfigsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/customer_profile_configs/`
39
+ - **OpenAPI operationId**: `environments_customer_profile_configs_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; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsCustomerProfileConfigsCreateInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsCustomerProfileConfigsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsCreate>>;
61
+
62
+ const result: EnvironmentsCustomerProfileConfigsCreateOutput = await posthog.environmentsCustomerProfileConfigsCreate();
63
+
64
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
65
+ ```
66
+
67
+ ### `posthog.environmentsCustomerProfileConfigsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/customer_profile_configs/{id}/`
70
+ - **OpenAPI operationId**: `environments_customer_profile_configs_destroy`
71
+ - **Path params**: `id`
72
+ - **Query params**: None
73
+ - **Response codes**: `204`
74
+ - **Transport options**: None
75
+ - **TypeScript**: [Client interface](../types.ts)
76
+
77
+ **Inputs**
78
+
79
+ - Client input type: `{ [key: string]: unknown }`
80
+ - Client transport options: None
81
+
82
+ **Outputs**
83
+
84
+ - Client return type: `unknown`
85
+ - OpenAPI response codes: `204`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type EnvironmentsCustomerProfileConfigsDestroyInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsCustomerProfileConfigsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsDestroy>>;
92
+
93
+ const result: EnvironmentsCustomerProfileConfigsDestroyOutput = await posthog.environmentsCustomerProfileConfigsDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsCustomerProfileConfigsRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/customer_profile_configs/{id}/`
101
+ - **OpenAPI operationId**: `environments_customer_profile_configs_retrieve`
102
+ - **Path params**: `id`
103
+ - **Query params**: None
104
+ - **Response codes**: `200`
105
+ - **Transport options**: None
106
+ - **TypeScript**: [Client interface](../types.ts)
107
+
108
+ **Inputs**
109
+
110
+ - Client input type: `{ [key: string]: unknown }`
111
+ - Client transport options: None
112
+
113
+ **Outputs**
114
+
115
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsCustomerProfileConfigsRetrieveInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsCustomerProfileConfigsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsRetrieve>>;
123
+
124
+ const result: EnvironmentsCustomerProfileConfigsRetrieveOutput = await posthog.environmentsCustomerProfileConfigsRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
127
+ ```
128
+
129
+ ### `posthog.environmentsCustomerProfileConfigsPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/customer_profile_configs/{id}/`
132
+ - **OpenAPI operationId**: `environments_customer_profile_configs_partial_update`
133
+ - **Path params**: `id`
134
+ - **Query params**: None
135
+ - **Response codes**: `200`
136
+ - **Transport options**: None
137
+ - **TypeScript**: [Client interface](../types.ts)
138
+
139
+ **Inputs**
140
+
141
+ - Client input type: `{ [key: string]: unknown }`
142
+ - Client transport options: None
143
+
144
+ **Outputs**
145
+
146
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsCustomerProfileConfigsPartialUpdateInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsCustomerProfileConfigsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsPartialUpdate>>;
154
+
155
+ const result: EnvironmentsCustomerProfileConfigsPartialUpdateOutput = await posthog.environmentsCustomerProfileConfigsPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
158
+ ```
159
+
160
+ ### `posthog.environmentsCustomerProfileConfigsUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/customer_profile_configs/{id}/`
163
+ - **OpenAPI operationId**: `environments_customer_profile_configs_update`
164
+ - **Path params**: `id`
165
+ - **Query params**: None
166
+ - **Response codes**: `200`
167
+ - **Transport options**: None
168
+ - **TypeScript**: [Client interface](../types.ts)
169
+
170
+ **Inputs**
171
+
172
+ - Client input type: `{ [key: string]: unknown }`
173
+ - Client transport options: None
174
+
175
+ **Outputs**
176
+
177
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsCustomerProfileConfigsUpdateInput = Parameters<typeof posthog.environmentsCustomerProfileConfigsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsCustomerProfileConfigsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomerProfileConfigsUpdate>>;
185
+
186
+ const result: EnvironmentsCustomerProfileConfigsUpdateOutput = await posthog.environmentsCustomerProfileConfigsUpdate();
187
+
188
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
189
+ ```
190
+
191
+ ### `posthog.customerProfileConfigsList`
192
+
193
+ - **HTTP**: `GET /api/projects/{project_id}/customer_profile_configs/`
194
+ - **OpenAPI operationId**: `customer_profile_configs_list`
195
+ - **Path params**: None
196
+ - **Query params**: `limit`, `offset`
197
+ - **Response codes**: `200`
198
+ - **Transport options**: None
199
+ - **TypeScript**: [Client interface](../types.ts)
200
+
201
+ **Inputs**
202
+
203
+ - Client input type: `{ [key: string]: unknown }`
204
+ - Client transport options: None
205
+
206
+ **Outputs**
207
+
208
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: str...`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type CustomerProfileConfigsListInput = Parameters<typeof posthog.customerProfileConfigsList> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type CustomerProfileConfigsListOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsList>>;
216
+
217
+ const result: CustomerProfileConfigsListOutput = await posthog.customerProfileConfigsList();
218
+
219
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: str...
220
+ ```
221
+
222
+ ### `posthog.customerProfileConfigsCreate`
223
+
224
+ - **HTTP**: `POST /api/projects/{project_id}/customer_profile_configs/`
225
+ - **OpenAPI operationId**: `customer_profile_configs_create`
226
+ - **Path params**: None
227
+ - **Query params**: None
228
+ - **Response codes**: `201`
229
+ - **Transport options**: None
230
+ - **TypeScript**: [Client interface](../types.ts)
231
+
232
+ **Inputs**
233
+
234
+ - Client input type: `{ [key: string]: unknown }`
235
+ - Client transport options: None
236
+
237
+ **Outputs**
238
+
239
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
240
+ - OpenAPI response codes: `201`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type CustomerProfileConfigsCreateInput = Parameters<typeof posthog.customerProfileConfigsCreate> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type CustomerProfileConfigsCreateOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsCreate>>;
247
+
248
+ const result: CustomerProfileConfigsCreateOutput = await posthog.customerProfileConfigsCreate();
249
+
250
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
251
+ ```
252
+
253
+ ### `posthog.customerProfileConfigsDestroy`
254
+
255
+ - **HTTP**: `DELETE /api/projects/{project_id}/customer_profile_configs/{id}/`
256
+ - **OpenAPI operationId**: `customer_profile_configs_destroy`
257
+ - **Path params**: `id`
258
+ - **Query params**: None
259
+ - **Response codes**: `204`
260
+ - **Transport options**: None
261
+ - **TypeScript**: [Client interface](../types.ts)
262
+
263
+ **Inputs**
264
+
265
+ - Client input type: `{ [key: string]: unknown }`
266
+ - Client transport options: None
267
+
268
+ **Outputs**
269
+
270
+ - Client return type: `unknown`
271
+ - OpenAPI response codes: `204`
272
+
273
+ ```ts
274
+ import posthog from "@utdk/posthog";
275
+
276
+ type CustomerProfileConfigsDestroyInput = Parameters<typeof posthog.customerProfileConfigsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
277
+ type CustomerProfileConfigsDestroyOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsDestroy>>;
278
+
279
+ const result: CustomerProfileConfigsDestroyOutput = await posthog.customerProfileConfigsDestroy();
280
+
281
+ // Result shape (from schema): unknown
282
+ ```
283
+
284
+ ### `posthog.customerProfileConfigsRetrieve`
285
+
286
+ - **HTTP**: `GET /api/projects/{project_id}/customer_profile_configs/{id}/`
287
+ - **OpenAPI operationId**: `customer_profile_configs_retrieve`
288
+ - **Path params**: `id`
289
+ - **Query params**: None
290
+ - **Response codes**: `200`
291
+ - **Transport options**: None
292
+ - **TypeScript**: [Client interface](../types.ts)
293
+
294
+ **Inputs**
295
+
296
+ - Client input type: `{ [key: string]: unknown }`
297
+ - Client transport options: None
298
+
299
+ **Outputs**
300
+
301
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
302
+ - OpenAPI response codes: `200`
303
+
304
+ ```ts
305
+ import posthog from "@utdk/posthog";
306
+
307
+ type CustomerProfileConfigsRetrieveInput = Parameters<typeof posthog.customerProfileConfigsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
308
+ type CustomerProfileConfigsRetrieveOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsRetrieve>>;
309
+
310
+ const result: CustomerProfileConfigsRetrieveOutput = await posthog.customerProfileConfigsRetrieve();
311
+
312
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
313
+ ```
314
+
315
+ ### `posthog.customerProfileConfigsPartialUpdate`
316
+
317
+ - **HTTP**: `PATCH /api/projects/{project_id}/customer_profile_configs/{id}/`
318
+ - **OpenAPI operationId**: `customer_profile_configs_partial_update`
319
+ - **Path params**: `id`
320
+ - **Query params**: None
321
+ - **Response codes**: `200`
322
+ - **Transport options**: None
323
+ - **TypeScript**: [Client interface](../types.ts)
324
+
325
+ **Inputs**
326
+
327
+ - Client input type: `{ [key: string]: unknown }`
328
+ - Client transport options: None
329
+
330
+ **Outputs**
331
+
332
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
333
+ - OpenAPI response codes: `200`
334
+
335
+ ```ts
336
+ import posthog from "@utdk/posthog";
337
+
338
+ type CustomerProfileConfigsPartialUpdateInput = Parameters<typeof posthog.customerProfileConfigsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
339
+ type CustomerProfileConfigsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsPartialUpdate>>;
340
+
341
+ const result: CustomerProfileConfigsPartialUpdateOutput = await posthog.customerProfileConfigsPartialUpdate();
342
+
343
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
344
+ ```
345
+
346
+ ### `posthog.customerProfileConfigsUpdate`
347
+
348
+ - **HTTP**: `PUT /api/projects/{project_id}/customer_profile_configs/{id}/`
349
+ - **OpenAPI operationId**: `customer_profile_configs_update`
350
+ - **Path params**: `id`
351
+ - **Query params**: None
352
+ - **Response codes**: `200`
353
+ - **Transport options**: None
354
+ - **TypeScript**: [Client interface](../types.ts)
355
+
356
+ **Inputs**
357
+
358
+ - Client input type: `{ [key: string]: unknown }`
359
+ - Client transport options: None
360
+
361
+ **Outputs**
362
+
363
+ - Client return type: `{ id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }`
364
+ - OpenAPI response codes: `200`
365
+
366
+ ```ts
367
+ import posthog from "@utdk/posthog";
368
+
369
+ type CustomerProfileConfigsUpdateInput = Parameters<typeof posthog.customerProfileConfigsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
370
+ type CustomerProfileConfigsUpdateOutput = Awaited<ReturnType<typeof posthog.customerProfileConfigsUpdate>>;
371
+
372
+ const result: CustomerProfileConfigsUpdateOutput = await posthog.customerProfileConfigsUpdate();
373
+
374
+ // Result shape (from schema): { id: string; scope: "person" | "group_0" | "group_1" | "group_2" | "group_3" | "group_4"; content?: unknown; sidebar?: unknown; created_at: string; updated_at: string | null }
375
+ ```
376
+
377
+
378
+ <!-- prompt-hash:
379
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
380
+ -->
@@ -0,0 +1,258 @@
1
+ # Dashboard Templates
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.dashboardTemplatesList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/dashboard_templates/`
8
+ - **OpenAPI operationId**: `dashboard_templates_list`
9
+ - **Path params**: None
10
+ - **Query params**: `is_featured`, `limit`, `offset`, `ordering`, `scope`
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; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type DashboardTemplatesListInput = Parameters<typeof posthog.dashboardTemplatesList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type DashboardTemplatesListOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesList>>;
30
+
31
+ const result: DashboardTemplatesListOutput = await posthog.dashboardTemplatesList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?...
34
+ ```
35
+
36
+ ### `posthog.dashboardTemplatesCreate`
37
+
38
+ - **HTTP**: `POST /api/projects/{project_id}/dashboard_templates/`
39
+ - **OpenAPI operationId**: `dashboard_templates_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; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type DashboardTemplatesCreateInput = Parameters<typeof posthog.dashboardTemplatesCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type DashboardTemplatesCreateOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesCreate>>;
61
+
62
+ const result: DashboardTemplatesCreateOutput = await posthog.dashboardTemplatesCreate();
63
+
64
+ // Result shape (from schema): { id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...
65
+ ```
66
+
67
+ ### `posthog.dashboardTemplatesDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/projects/{project_id}/dashboard_templates/{id}/`
70
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
71
+ - **OpenAPI operationId**: `dashboard_templates_destroy`
72
+ - **Path params**: `id`
73
+ - **Query params**: None
74
+ - **Response codes**: `405`
75
+ - **Transport options**: None
76
+ - **TypeScript**: [Client interface](../types.ts)
77
+
78
+ **Inputs**
79
+
80
+ - Client input type: `{ [key: string]: unknown }`
81
+ - Client transport options: None
82
+
83
+ **Outputs**
84
+
85
+ - Client return type: `unknown`
86
+ - OpenAPI response codes: `405`
87
+
88
+ ```ts
89
+ import posthog from "@utdk/posthog";
90
+
91
+ type DashboardTemplatesDestroyInput = Parameters<typeof posthog.dashboardTemplatesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
92
+ type DashboardTemplatesDestroyOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesDestroy>>;
93
+
94
+ const result: DashboardTemplatesDestroyOutput = await posthog.dashboardTemplatesDestroy();
95
+
96
+ // Result shape (from schema): unknown
97
+ ```
98
+
99
+ ### `posthog.dashboardTemplatesRetrieve`
100
+
101
+ - **HTTP**: `GET /api/projects/{project_id}/dashboard_templates/{id}/`
102
+ - **OpenAPI operationId**: `dashboard_templates_retrieve`
103
+ - **Path params**: `id`
104
+ - **Query params**: None
105
+ - **Response codes**: `200`
106
+ - **Transport options**: None
107
+ - **TypeScript**: [Client interface](../types.ts)
108
+
109
+ **Inputs**
110
+
111
+ - Client input type: `{ [key: string]: unknown }`
112
+ - Client transport options: None
113
+
114
+ **Outputs**
115
+
116
+ - Client return type: `{ id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...`
117
+ - OpenAPI response codes: `200`
118
+
119
+ ```ts
120
+ import posthog from "@utdk/posthog";
121
+
122
+ type DashboardTemplatesRetrieveInput = Parameters<typeof posthog.dashboardTemplatesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
123
+ type DashboardTemplatesRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesRetrieve>>;
124
+
125
+ const result: DashboardTemplatesRetrieveOutput = await posthog.dashboardTemplatesRetrieve();
126
+
127
+ // Result shape (from schema): { id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...
128
+ ```
129
+
130
+ ### `posthog.dashboardTemplatesPartialUpdate`
131
+
132
+ - **HTTP**: `PATCH /api/projects/{project_id}/dashboard_templates/{id}/`
133
+ - **OpenAPI operationId**: `dashboard_templates_partial_update`
134
+ - **Path params**: `id`
135
+ - **Query params**: None
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: `{ id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...`
148
+ - OpenAPI response codes: `200`
149
+
150
+ ```ts
151
+ import posthog from "@utdk/posthog";
152
+
153
+ type DashboardTemplatesPartialUpdateInput = Parameters<typeof posthog.dashboardTemplatesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
154
+ type DashboardTemplatesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesPartialUpdate>>;
155
+
156
+ const result: DashboardTemplatesPartialUpdateOutput = await posthog.dashboardTemplatesPartialUpdate();
157
+
158
+ // Result shape (from schema): { id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...
159
+ ```
160
+
161
+ ### `posthog.dashboardTemplatesUpdate`
162
+
163
+ - **HTTP**: `PUT /api/projects/{project_id}/dashboard_templates/{id}/`
164
+ - **OpenAPI operationId**: `dashboard_templates_update`
165
+ - **Path params**: `id`
166
+ - **Query params**: None
167
+ - **Response codes**: `200`
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; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...`
179
+ - OpenAPI response codes: `200`
180
+
181
+ ```ts
182
+ import posthog from "@utdk/posthog";
183
+
184
+ type DashboardTemplatesUpdateInput = Parameters<typeof posthog.dashboardTemplatesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
185
+ type DashboardTemplatesUpdateOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesUpdate>>;
186
+
187
+ const result: DashboardTemplatesUpdateOutput = await posthog.dashboardTemplatesUpdate();
188
+
189
+ // Result shape (from schema): { id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...
190
+ ```
191
+
192
+ ### `posthog.dashboardTemplatesCopyBetweenProjectsCreate`
193
+
194
+ - **HTTP**: `POST /api/projects/{project_id}/dashboard_templates/copy_between_projects/`
195
+ - **What it does**: Copy a team template to this project
196
+ - **OpenAPI operationId**: `dashboard_templates_copy_between_projects_create`
197
+ - **Path params**: None
198
+ - **Query params**: None
199
+ - **Response codes**: `201`
200
+ - **Transport options**: None
201
+ - **TypeScript**: [Client interface](../types.ts)
202
+
203
+ **Inputs**
204
+
205
+ - Client input type: `{ [key: string]: unknown }`
206
+ - Client transport options: None
207
+
208
+ **Outputs**
209
+
210
+ - Client return type: `{ id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...`
211
+ - OpenAPI response codes: `201`
212
+
213
+ ```ts
214
+ import posthog from "@utdk/posthog";
215
+
216
+ type DashboardTemplatesCopyBetweenProjectsCreateInput = Parameters<typeof posthog.dashboardTemplatesCopyBetweenProjectsCreate> extends [infer T, ...unknown[]] ? T : undefined;
217
+ type DashboardTemplatesCopyBetweenProjectsCreateOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesCopyBetweenProjectsCreate>>;
218
+
219
+ const result: DashboardTemplatesCopyBetweenProjectsCreateOutput = await posthog.dashboardTemplatesCopyBetweenProjectsCreate();
220
+
221
+ // Result shape (from schema): { id: string; template_name?: string | null; dashboard_description?: string | null; dashboard_filters?: unknown; tags?: unknown[] | null; tiles?: unknown; variables?: unknown; deleted?: boolean | null; created_at: strin...
222
+ ```
223
+
224
+ ### `posthog.dashboardTemplatesJsonSchemaRetrieve`
225
+
226
+ - **HTTP**: `GET /api/projects/{project_id}/dashboard_templates/json_schema/`
227
+ - **OpenAPI operationId**: `dashboard_templates_json_schema_retrieve`
228
+ - **Path params**: None
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: `unknown`
242
+ - OpenAPI response codes: `200`
243
+
244
+ ```ts
245
+ import posthog from "@utdk/posthog";
246
+
247
+ type DashboardTemplatesJsonSchemaRetrieveInput = Parameters<typeof posthog.dashboardTemplatesJsonSchemaRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
248
+ type DashboardTemplatesJsonSchemaRetrieveOutput = Awaited<ReturnType<typeof posthog.dashboardTemplatesJsonSchemaRetrieve>>;
249
+
250
+ const result: DashboardTemplatesJsonSchemaRetrieveOutput = await posthog.dashboardTemplatesJsonSchemaRetrieve();
251
+
252
+ // Result shape (from schema): unknown
253
+ ```
254
+
255
+
256
+ <!-- prompt-hash:
257
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
258
+ -->