@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,752 @@
1
+ # External Data Schemas
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsExternalDataSchemasList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/external_data_schemas/`
8
+ - **OpenAPI operationId**: `environments_external_data_schemas_list`
9
+ - **Path params**: None
10
+ - **Query params**: `limit`, `offset`, `search`
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; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsExternalDataSchemasListInput = Parameters<typeof posthog.environmentsExternalDataSchemasList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsExternalDataSchemasListOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasList>>;
30
+
31
+ const result: EnvironmentsExternalDataSchemasListOutput = await posthog.environmentsExternalDataSchemasList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null...
34
+ ```
35
+
36
+ ### `posthog.environmentsExternalDataSchemasCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/external_data_schemas/`
39
+ - **OpenAPI operationId**: `environments_external_data_schemas_create`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `201`
43
+ - **Transport options**: None
44
+ - **TypeScript**: [Client interface](../types.ts)
45
+
46
+ **Inputs**
47
+
48
+ - Client input type: `{ [key: string]: unknown }`
49
+ - Client transport options: None
50
+
51
+ **Outputs**
52
+
53
+ - Client return type: `{ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsExternalDataSchemasCreateInput = Parameters<typeof posthog.environmentsExternalDataSchemasCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsExternalDataSchemasCreateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasCreate>>;
61
+
62
+ const result: EnvironmentsExternalDataSchemasCreateOutput = await posthog.environmentsExternalDataSchemasCreate();
63
+
64
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
65
+ ```
66
+
67
+ ### `posthog.environmentsExternalDataSchemasDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/external_data_schemas/{id}/`
70
+ - **OpenAPI operationId**: `environments_external_data_schemas_destroy`
71
+ - **Path params**: `id`
72
+ - **Query params**: None
73
+ - **Response codes**: `204`
74
+ - **Transport options**: None
75
+ - **TypeScript**: [Client interface](../types.ts)
76
+
77
+ **Inputs**
78
+
79
+ - Client input type: `{ [key: string]: unknown }`
80
+ - Client transport options: None
81
+
82
+ **Outputs**
83
+
84
+ - Client return type: `unknown`
85
+ - OpenAPI response codes: `204`
86
+
87
+ ```ts
88
+ import posthog from "@utdk/posthog";
89
+
90
+ type EnvironmentsExternalDataSchemasDestroyInput = Parameters<typeof posthog.environmentsExternalDataSchemasDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsExternalDataSchemasDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasDestroy>>;
92
+
93
+ const result: EnvironmentsExternalDataSchemasDestroyOutput = await posthog.environmentsExternalDataSchemasDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsExternalDataSchemasRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/external_data_schemas/{id}/`
101
+ - **OpenAPI operationId**: `environments_external_data_schemas_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; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsExternalDataSchemasRetrieveInput = Parameters<typeof posthog.environmentsExternalDataSchemasRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsExternalDataSchemasRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasRetrieve>>;
123
+
124
+ const result: EnvironmentsExternalDataSchemasRetrieveOutput = await posthog.environmentsExternalDataSchemasRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
127
+ ```
128
+
129
+ ### `posthog.environmentsExternalDataSchemasPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/external_data_schemas/{id}/`
132
+ - **OpenAPI operationId**: `environments_external_data_schemas_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; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsExternalDataSchemasPartialUpdateInput = Parameters<typeof posthog.environmentsExternalDataSchemasPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsExternalDataSchemasPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasPartialUpdate>>;
154
+
155
+ const result: EnvironmentsExternalDataSchemasPartialUpdateOutput = await posthog.environmentsExternalDataSchemasPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
158
+ ```
159
+
160
+ ### `posthog.environmentsExternalDataSchemasUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/external_data_schemas/{id}/`
163
+ - **OpenAPI operationId**: `environments_external_data_schemas_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; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsExternalDataSchemasUpdateInput = Parameters<typeof posthog.environmentsExternalDataSchemasUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsExternalDataSchemasUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasUpdate>>;
185
+
186
+ const result: EnvironmentsExternalDataSchemasUpdateOutput = await posthog.environmentsExternalDataSchemasUpdate();
187
+
188
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
189
+ ```
190
+
191
+ ### `posthog.environmentsExternalDataSchemasCancelCreate`
192
+
193
+ - **HTTP**: `POST /api/environments/{environment_id}/external_data_schemas/{id}/cancel/`
194
+ - **OpenAPI operationId**: `environments_external_data_schemas_cancel_create`
195
+ - **Path params**: `id`
196
+ - **Query params**: None
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: `unknown`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type EnvironmentsExternalDataSchemasCancelCreateInput = Parameters<typeof posthog.environmentsExternalDataSchemasCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type EnvironmentsExternalDataSchemasCancelCreateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasCancelCreate>>;
216
+
217
+ const result: EnvironmentsExternalDataSchemasCancelCreateOutput = await posthog.environmentsExternalDataSchemasCancelCreate();
218
+
219
+ // Result shape (from schema): unknown
220
+ ```
221
+
222
+ ### `posthog.environmentsExternalDataSchemasDeleteDataDestroy`
223
+
224
+ - **HTTP**: `DELETE /api/environments/{environment_id}/external_data_schemas/{id}/delete_data/`
225
+ - **OpenAPI operationId**: `environments_external_data_schemas_delete_data_destroy`
226
+ - **Path params**: `id`
227
+ - **Query params**: None
228
+ - **Response codes**: `204`
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: `unknown`
240
+ - OpenAPI response codes: `204`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type EnvironmentsExternalDataSchemasDeleteDataDestroyInput = Parameters<typeof posthog.environmentsExternalDataSchemasDeleteDataDestroy> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type EnvironmentsExternalDataSchemasDeleteDataDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasDeleteDataDestroy>>;
247
+
248
+ const result: EnvironmentsExternalDataSchemasDeleteDataDestroyOutput = await posthog.environmentsExternalDataSchemasDeleteDataDestroy();
249
+
250
+ // Result shape (from schema): unknown
251
+ ```
252
+
253
+ ### `posthog.environmentsExternalDataSchemasIncrementalFieldsCreate`
254
+
255
+ - **HTTP**: `POST /api/environments/{environment_id}/external_data_schemas/{id}/incremental_fields/`
256
+ - **OpenAPI operationId**: `environments_external_data_schemas_incremental_fields_create`
257
+ - **Path params**: `id`
258
+ - **Query params**: None
259
+ - **Response codes**: `200`
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: `200`
272
+
273
+ ```ts
274
+ import posthog from "@utdk/posthog";
275
+
276
+ type EnvironmentsExternalDataSchemasIncrementalFieldsCreateInput = Parameters<typeof posthog.environmentsExternalDataSchemasIncrementalFieldsCreate> extends [infer T, ...unknown[]] ? T : undefined;
277
+ type EnvironmentsExternalDataSchemasIncrementalFieldsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasIncrementalFieldsCreate>>;
278
+
279
+ const result: EnvironmentsExternalDataSchemasIncrementalFieldsCreateOutput = await posthog.environmentsExternalDataSchemasIncrementalFieldsCreate();
280
+
281
+ // Result shape (from schema): unknown
282
+ ```
283
+
284
+ ### `posthog.environmentsExternalDataSchemasLogsRetrieve`
285
+
286
+ - **HTTP**: `GET /api/environments/{environment_id}/external_data_schemas/{id}/logs/`
287
+ - **OpenAPI operationId**: `environments_external_data_schemas_logs_retrieve`
288
+ - **Path params**: `id`
289
+ - **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
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: `unknown`
302
+ - OpenAPI response codes: `200`
303
+
304
+ ```ts
305
+ import posthog from "@utdk/posthog";
306
+
307
+ type EnvironmentsExternalDataSchemasLogsRetrieveInput = Parameters<typeof posthog.environmentsExternalDataSchemasLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
308
+ type EnvironmentsExternalDataSchemasLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasLogsRetrieve>>;
309
+
310
+ const result: EnvironmentsExternalDataSchemasLogsRetrieveOutput = await posthog.environmentsExternalDataSchemasLogsRetrieve();
311
+
312
+ // Result shape (from schema): unknown
313
+ ```
314
+
315
+ ### `posthog.environmentsExternalDataSchemasReloadCreate`
316
+
317
+ - **HTTP**: `POST /api/environments/{environment_id}/external_data_schemas/{id}/reload/`
318
+ - **OpenAPI operationId**: `environments_external_data_schemas_reload_create`
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: `unknown`
333
+ - OpenAPI response codes: `200`
334
+
335
+ ```ts
336
+ import posthog from "@utdk/posthog";
337
+
338
+ type EnvironmentsExternalDataSchemasReloadCreateInput = Parameters<typeof posthog.environmentsExternalDataSchemasReloadCreate> extends [infer T, ...unknown[]] ? T : undefined;
339
+ type EnvironmentsExternalDataSchemasReloadCreateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasReloadCreate>>;
340
+
341
+ const result: EnvironmentsExternalDataSchemasReloadCreateOutput = await posthog.environmentsExternalDataSchemasReloadCreate();
342
+
343
+ // Result shape (from schema): unknown
344
+ ```
345
+
346
+ ### `posthog.environmentsExternalDataSchemasResyncCreate`
347
+
348
+ - **HTTP**: `POST /api/environments/{environment_id}/external_data_schemas/{id}/resync/`
349
+ - **OpenAPI operationId**: `environments_external_data_schemas_resync_create`
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: `unknown`
364
+ - OpenAPI response codes: `200`
365
+
366
+ ```ts
367
+ import posthog from "@utdk/posthog";
368
+
369
+ type EnvironmentsExternalDataSchemasResyncCreateInput = Parameters<typeof posthog.environmentsExternalDataSchemasResyncCreate> extends [infer T, ...unknown[]] ? T : undefined;
370
+ type EnvironmentsExternalDataSchemasResyncCreateOutput = Awaited<ReturnType<typeof posthog.environmentsExternalDataSchemasResyncCreate>>;
371
+
372
+ const result: EnvironmentsExternalDataSchemasResyncCreateOutput = await posthog.environmentsExternalDataSchemasResyncCreate();
373
+
374
+ // Result shape (from schema): unknown
375
+ ```
376
+
377
+ ### `posthog.externalDataSchemasList`
378
+
379
+ - **HTTP**: `GET /api/projects/{project_id}/external_data_schemas/`
380
+ - **OpenAPI operationId**: `external_data_schemas_list`
381
+ - **Path params**: None
382
+ - **Query params**: `limit`, `offset`, `search`
383
+ - **Response codes**: `200`
384
+ - **Transport options**: None
385
+ - **TypeScript**: [Client interface](../types.ts)
386
+
387
+ **Inputs**
388
+
389
+ - Client input type: `{ [key: string]: unknown }`
390
+ - Client transport options: None
391
+
392
+ **Outputs**
393
+
394
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null...`
395
+ - OpenAPI response codes: `200`
396
+
397
+ ```ts
398
+ import posthog from "@utdk/posthog";
399
+
400
+ type ExternalDataSchemasListInput = Parameters<typeof posthog.externalDataSchemasList> extends [infer T, ...unknown[]] ? T : undefined;
401
+ type ExternalDataSchemasListOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasList>>;
402
+
403
+ const result: ExternalDataSchemasListOutput = await posthog.externalDataSchemasList();
404
+
405
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null...
406
+ ```
407
+
408
+ ### `posthog.externalDataSchemasCreate`
409
+
410
+ - **HTTP**: `POST /api/projects/{project_id}/external_data_schemas/`
411
+ - **OpenAPI operationId**: `external_data_schemas_create`
412
+ - **Path params**: None
413
+ - **Query params**: None
414
+ - **Response codes**: `201`
415
+ - **Transport options**: None
416
+ - **TypeScript**: [Client interface](../types.ts)
417
+
418
+ **Inputs**
419
+
420
+ - Client input type: `{ [key: string]: unknown }`
421
+ - Client transport options: None
422
+
423
+ **Outputs**
424
+
425
+ - Client return type: `{ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
426
+ - OpenAPI response codes: `201`
427
+
428
+ ```ts
429
+ import posthog from "@utdk/posthog";
430
+
431
+ type ExternalDataSchemasCreateInput = Parameters<typeof posthog.externalDataSchemasCreate> extends [infer T, ...unknown[]] ? T : undefined;
432
+ type ExternalDataSchemasCreateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasCreate>>;
433
+
434
+ const result: ExternalDataSchemasCreateOutput = await posthog.externalDataSchemasCreate();
435
+
436
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
437
+ ```
438
+
439
+ ### `posthog.externalDataSchemasDestroy`
440
+
441
+ - **HTTP**: `DELETE /api/projects/{project_id}/external_data_schemas/{id}/`
442
+ - **OpenAPI operationId**: `external_data_schemas_destroy`
443
+ - **Path params**: `id`
444
+ - **Query params**: None
445
+ - **Response codes**: `204`
446
+ - **Transport options**: None
447
+ - **TypeScript**: [Client interface](../types.ts)
448
+
449
+ **Inputs**
450
+
451
+ - Client input type: `{ [key: string]: unknown }`
452
+ - Client transport options: None
453
+
454
+ **Outputs**
455
+
456
+ - Client return type: `unknown`
457
+ - OpenAPI response codes: `204`
458
+
459
+ ```ts
460
+ import posthog from "@utdk/posthog";
461
+
462
+ type ExternalDataSchemasDestroyInput = Parameters<typeof posthog.externalDataSchemasDestroy> extends [infer T, ...unknown[]] ? T : undefined;
463
+ type ExternalDataSchemasDestroyOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasDestroy>>;
464
+
465
+ const result: ExternalDataSchemasDestroyOutput = await posthog.externalDataSchemasDestroy();
466
+
467
+ // Result shape (from schema): unknown
468
+ ```
469
+
470
+ ### `posthog.externalDataSchemasRetrieve`
471
+
472
+ - **HTTP**: `GET /api/projects/{project_id}/external_data_schemas/{id}/`
473
+ - **OpenAPI operationId**: `external_data_schemas_retrieve`
474
+ - **Path params**: `id`
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: `{ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
488
+ - OpenAPI response codes: `200`
489
+
490
+ ```ts
491
+ import posthog from "@utdk/posthog";
492
+
493
+ type ExternalDataSchemasRetrieveInput = Parameters<typeof posthog.externalDataSchemasRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
494
+ type ExternalDataSchemasRetrieveOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasRetrieve>>;
495
+
496
+ const result: ExternalDataSchemasRetrieveOutput = await posthog.externalDataSchemasRetrieve();
497
+
498
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
499
+ ```
500
+
501
+ ### `posthog.externalDataSchemasPartialUpdate`
502
+
503
+ - **HTTP**: `PATCH /api/projects/{project_id}/external_data_schemas/{id}/`
504
+ - **OpenAPI operationId**: `external_data_schemas_partial_update`
505
+ - **Path params**: `id`
506
+ - **Query params**: None
507
+ - **Response codes**: `200`
508
+ - **Transport options**: None
509
+ - **TypeScript**: [Client interface](../types.ts)
510
+
511
+ **Inputs**
512
+
513
+ - Client input type: `{ [key: string]: unknown }`
514
+ - Client transport options: None
515
+
516
+ **Outputs**
517
+
518
+ - Client return type: `{ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
519
+ - OpenAPI response codes: `200`
520
+
521
+ ```ts
522
+ import posthog from "@utdk/posthog";
523
+
524
+ type ExternalDataSchemasPartialUpdateInput = Parameters<typeof posthog.externalDataSchemasPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
525
+ type ExternalDataSchemasPartialUpdateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasPartialUpdate>>;
526
+
527
+ const result: ExternalDataSchemasPartialUpdateOutput = await posthog.externalDataSchemasPartialUpdate();
528
+
529
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
530
+ ```
531
+
532
+ ### `posthog.externalDataSchemasUpdate`
533
+
534
+ - **HTTP**: `PUT /api/projects/{project_id}/external_data_schemas/{id}/`
535
+ - **OpenAPI operationId**: `external_data_schemas_update`
536
+ - **Path params**: `id`
537
+ - **Query params**: None
538
+ - **Response codes**: `200`
539
+ - **Transport options**: None
540
+ - **TypeScript**: [Client interface](../types.ts)
541
+
542
+ **Inputs**
543
+
544
+ - Client input type: `{ [key: string]: unknown }`
545
+ - Client transport options: None
546
+
547
+ **Outputs**
548
+
549
+ - Client return type: `{ id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...`
550
+ - OpenAPI response codes: `200`
551
+
552
+ ```ts
553
+ import posthog from "@utdk/posthog";
554
+
555
+ type ExternalDataSchemasUpdateInput = Parameters<typeof posthog.externalDataSchemasUpdate> extends [infer T, ...unknown[]] ? T : undefined;
556
+ type ExternalDataSchemasUpdateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasUpdate>>;
557
+
558
+ const result: ExternalDataSchemasUpdateOutput = await posthog.externalDataSchemasUpdate();
559
+
560
+ // Result shape (from schema): { id: string; name: string; label: string | null; table: { [key: string]: unknown } | null; should_sync?: boolean; last_synced_at: string | null; latest_error: string | null; incremental: boolean; status: string | null;...
561
+ ```
562
+
563
+ ### `posthog.externalDataSchemasCancelCreate`
564
+
565
+ - **HTTP**: `POST /api/projects/{project_id}/external_data_schemas/{id}/cancel/`
566
+ - **OpenAPI operationId**: `external_data_schemas_cancel_create`
567
+ - **Path params**: `id`
568
+ - **Query params**: None
569
+ - **Response codes**: `200`
570
+ - **Transport options**: None
571
+ - **TypeScript**: [Client interface](../types.ts)
572
+
573
+ **Inputs**
574
+
575
+ - Client input type: `{ [key: string]: unknown }`
576
+ - Client transport options: None
577
+
578
+ **Outputs**
579
+
580
+ - Client return type: `unknown`
581
+ - OpenAPI response codes: `200`
582
+
583
+ ```ts
584
+ import posthog from "@utdk/posthog";
585
+
586
+ type ExternalDataSchemasCancelCreateInput = Parameters<typeof posthog.externalDataSchemasCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
587
+ type ExternalDataSchemasCancelCreateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasCancelCreate>>;
588
+
589
+ const result: ExternalDataSchemasCancelCreateOutput = await posthog.externalDataSchemasCancelCreate();
590
+
591
+ // Result shape (from schema): unknown
592
+ ```
593
+
594
+ ### `posthog.externalDataSchemasDeleteDataDestroy`
595
+
596
+ - **HTTP**: `DELETE /api/projects/{project_id}/external_data_schemas/{id}/delete_data/`
597
+ - **OpenAPI operationId**: `external_data_schemas_delete_data_destroy`
598
+ - **Path params**: `id`
599
+ - **Query params**: None
600
+ - **Response codes**: `204`
601
+ - **Transport options**: None
602
+ - **TypeScript**: [Client interface](../types.ts)
603
+
604
+ **Inputs**
605
+
606
+ - Client input type: `{ [key: string]: unknown }`
607
+ - Client transport options: None
608
+
609
+ **Outputs**
610
+
611
+ - Client return type: `unknown`
612
+ - OpenAPI response codes: `204`
613
+
614
+ ```ts
615
+ import posthog from "@utdk/posthog";
616
+
617
+ type ExternalDataSchemasDeleteDataDestroyInput = Parameters<typeof posthog.externalDataSchemasDeleteDataDestroy> extends [infer T, ...unknown[]] ? T : undefined;
618
+ type ExternalDataSchemasDeleteDataDestroyOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasDeleteDataDestroy>>;
619
+
620
+ const result: ExternalDataSchemasDeleteDataDestroyOutput = await posthog.externalDataSchemasDeleteDataDestroy();
621
+
622
+ // Result shape (from schema): unknown
623
+ ```
624
+
625
+ ### `posthog.externalDataSchemasIncrementalFieldsCreate`
626
+
627
+ - **HTTP**: `POST /api/projects/{project_id}/external_data_schemas/{id}/incremental_fields/`
628
+ - **OpenAPI operationId**: `external_data_schemas_incremental_fields_create`
629
+ - **Path params**: `id`
630
+ - **Query params**: None
631
+ - **Response codes**: `200`
632
+ - **Transport options**: None
633
+ - **TypeScript**: [Client interface](../types.ts)
634
+
635
+ **Inputs**
636
+
637
+ - Client input type: `{ [key: string]: unknown }`
638
+ - Client transport options: None
639
+
640
+ **Outputs**
641
+
642
+ - Client return type: `unknown`
643
+ - OpenAPI response codes: `200`
644
+
645
+ ```ts
646
+ import posthog from "@utdk/posthog";
647
+
648
+ type ExternalDataSchemasIncrementalFieldsCreateInput = Parameters<typeof posthog.externalDataSchemasIncrementalFieldsCreate> extends [infer T, ...unknown[]] ? T : undefined;
649
+ type ExternalDataSchemasIncrementalFieldsCreateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasIncrementalFieldsCreate>>;
650
+
651
+ const result: ExternalDataSchemasIncrementalFieldsCreateOutput = await posthog.externalDataSchemasIncrementalFieldsCreate();
652
+
653
+ // Result shape (from schema): unknown
654
+ ```
655
+
656
+ ### `posthog.externalDataSchemasLogsRetrieve`
657
+
658
+ - **HTTP**: `GET /api/projects/{project_id}/external_data_schemas/{id}/logs/`
659
+ - **OpenAPI operationId**: `external_data_schemas_logs_retrieve`
660
+ - **Path params**: `id`
661
+ - **Query params**: `after`, `before`, `instance_id`, `level`, `limit`, `search`
662
+ - **Response codes**: `200`
663
+ - **Transport options**: None
664
+ - **TypeScript**: [Client interface](../types.ts)
665
+
666
+ **Inputs**
667
+
668
+ - Client input type: `{ [key: string]: unknown }`
669
+ - Client transport options: None
670
+
671
+ **Outputs**
672
+
673
+ - Client return type: `unknown`
674
+ - OpenAPI response codes: `200`
675
+
676
+ ```ts
677
+ import posthog from "@utdk/posthog";
678
+
679
+ type ExternalDataSchemasLogsRetrieveInput = Parameters<typeof posthog.externalDataSchemasLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
680
+ type ExternalDataSchemasLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasLogsRetrieve>>;
681
+
682
+ const result: ExternalDataSchemasLogsRetrieveOutput = await posthog.externalDataSchemasLogsRetrieve();
683
+
684
+ // Result shape (from schema): unknown
685
+ ```
686
+
687
+ ### `posthog.externalDataSchemasReloadCreate`
688
+
689
+ - **HTTP**: `POST /api/projects/{project_id}/external_data_schemas/{id}/reload/`
690
+ - **OpenAPI operationId**: `external_data_schemas_reload_create`
691
+ - **Path params**: `id`
692
+ - **Query params**: None
693
+ - **Response codes**: `200`
694
+ - **Transport options**: None
695
+ - **TypeScript**: [Client interface](../types.ts)
696
+
697
+ **Inputs**
698
+
699
+ - Client input type: `{ [key: string]: unknown }`
700
+ - Client transport options: None
701
+
702
+ **Outputs**
703
+
704
+ - Client return type: `unknown`
705
+ - OpenAPI response codes: `200`
706
+
707
+ ```ts
708
+ import posthog from "@utdk/posthog";
709
+
710
+ type ExternalDataSchemasReloadCreateInput = Parameters<typeof posthog.externalDataSchemasReloadCreate> extends [infer T, ...unknown[]] ? T : undefined;
711
+ type ExternalDataSchemasReloadCreateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasReloadCreate>>;
712
+
713
+ const result: ExternalDataSchemasReloadCreateOutput = await posthog.externalDataSchemasReloadCreate();
714
+
715
+ // Result shape (from schema): unknown
716
+ ```
717
+
718
+ ### `posthog.externalDataSchemasResyncCreate`
719
+
720
+ - **HTTP**: `POST /api/projects/{project_id}/external_data_schemas/{id}/resync/`
721
+ - **OpenAPI operationId**: `external_data_schemas_resync_create`
722
+ - **Path params**: `id`
723
+ - **Query params**: None
724
+ - **Response codes**: `200`
725
+ - **Transport options**: None
726
+ - **TypeScript**: [Client interface](../types.ts)
727
+
728
+ **Inputs**
729
+
730
+ - Client input type: `{ [key: string]: unknown }`
731
+ - Client transport options: None
732
+
733
+ **Outputs**
734
+
735
+ - Client return type: `unknown`
736
+ - OpenAPI response codes: `200`
737
+
738
+ ```ts
739
+ import posthog from "@utdk/posthog";
740
+
741
+ type ExternalDataSchemasResyncCreateInput = Parameters<typeof posthog.externalDataSchemasResyncCreate> extends [infer T, ...unknown[]] ? T : undefined;
742
+ type ExternalDataSchemasResyncCreateOutput = Awaited<ReturnType<typeof posthog.externalDataSchemasResyncCreate>>;
743
+
744
+ const result: ExternalDataSchemasResyncCreateOutput = await posthog.externalDataSchemasResyncCreate();
745
+
746
+ // Result shape (from schema): unknown
747
+ ```
748
+
749
+
750
+ <!-- prompt-hash:
751
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
752
+ -->