@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,442 @@
1
+ # Custom Property Definitions
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsCustomPropertyDefinitionsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/custom_property_definitions/`
8
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boole...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsCustomPropertyDefinitionsListInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsCustomPropertyDefinitionsListOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsList>>;
30
+
31
+ const result: EnvironmentsCustomPropertyDefinitionsListOutput = await posthog.environmentsCustomPropertyDefinitionsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boole...
34
+ ```
35
+
36
+ ### `posthog.environmentsCustomPropertyDefinitionsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/custom_property_definitions/`
39
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsCustomPropertyDefinitionsCreateInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsCustomPropertyDefinitionsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsCreate>>;
61
+
62
+ const result: EnvironmentsCustomPropertyDefinitionsCreateOutput = await posthog.environmentsCustomPropertyDefinitionsCreate();
63
+
64
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
65
+ ```
66
+
67
+ ### `posthog.environmentsCustomPropertyDefinitionsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/custom_property_definitions/{id}/`
70
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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 EnvironmentsCustomPropertyDefinitionsDestroyInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsCustomPropertyDefinitionsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsDestroy>>;
92
+
93
+ const result: EnvironmentsCustomPropertyDefinitionsDestroyOutput = await posthog.environmentsCustomPropertyDefinitionsDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsCustomPropertyDefinitionsRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/custom_property_definitions/{id}/`
101
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsCustomPropertyDefinitionsRetrieveInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsCustomPropertyDefinitionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsRetrieve>>;
123
+
124
+ const result: EnvironmentsCustomPropertyDefinitionsRetrieveOutput = await posthog.environmentsCustomPropertyDefinitionsRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
127
+ ```
128
+
129
+ ### `posthog.environmentsCustomPropertyDefinitionsPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/custom_property_definitions/{id}/`
132
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsCustomPropertyDefinitionsPartialUpdateInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsCustomPropertyDefinitionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsPartialUpdate>>;
154
+
155
+ const result: EnvironmentsCustomPropertyDefinitionsPartialUpdateOutput = await posthog.environmentsCustomPropertyDefinitionsPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
158
+ ```
159
+
160
+ ### `posthog.environmentsCustomPropertyDefinitionsUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/custom_property_definitions/{id}/`
163
+ - **OpenAPI operationId**: `environments_custom_property_definitions_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; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsCustomPropertyDefinitionsUpdateInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsCustomPropertyDefinitionsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsUpdate>>;
185
+
186
+ const result: EnvironmentsCustomPropertyDefinitionsUpdateOutput = await posthog.environmentsCustomPropertyDefinitionsUpdate();
187
+
188
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
189
+ ```
190
+
191
+ ### `posthog.environmentsCustomPropertyDefinitionsValuesRetrieve`
192
+
193
+ - **HTTP**: `GET /api/environments/{environment_id}/custom_property_definitions/values/`
194
+ - **OpenAPI operationId**: `environments_custom_property_definitions_values_retrieve`
195
+ - **Path params**: None
196
+ - **Query params**: `key`, `value`
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: `{ results: ({ name: string })[]; refreshing: boolean }`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type EnvironmentsCustomPropertyDefinitionsValuesRetrieveInput = Parameters<typeof posthog.environmentsCustomPropertyDefinitionsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type EnvironmentsCustomPropertyDefinitionsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsCustomPropertyDefinitionsValuesRetrieve>>;
216
+
217
+ const result: EnvironmentsCustomPropertyDefinitionsValuesRetrieveOutput = await posthog.environmentsCustomPropertyDefinitionsValuesRetrieve();
218
+
219
+ // Result shape (from schema): { results: ({ name: string })[]; refreshing: boolean }
220
+ ```
221
+
222
+ ### `posthog.customPropertyDefinitionsList`
223
+
224
+ - **HTTP**: `GET /api/projects/{project_id}/custom_property_definitions/`
225
+ - **OpenAPI operationId**: `custom_property_definitions_list`
226
+ - **Path params**: None
227
+ - **Query params**: `limit`, `offset`
228
+ - **Response codes**: `200`
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boole...`
240
+ - OpenAPI response codes: `200`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type CustomPropertyDefinitionsListInput = Parameters<typeof posthog.customPropertyDefinitionsList> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type CustomPropertyDefinitionsListOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsList>>;
247
+
248
+ const result: CustomPropertyDefinitionsListOutput = await posthog.customPropertyDefinitionsList();
249
+
250
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boole...
251
+ ```
252
+
253
+ ### `posthog.customPropertyDefinitionsCreate`
254
+
255
+ - **HTTP**: `POST /api/projects/{project_id}/custom_property_definitions/`
256
+ - **OpenAPI operationId**: `custom_property_definitions_create`
257
+ - **Path params**: None
258
+ - **Query params**: None
259
+ - **Response codes**: `201`
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: `{ id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
271
+ - OpenAPI response codes: `201`
272
+
273
+ ```ts
274
+ import posthog from "@utdk/posthog";
275
+
276
+ type CustomPropertyDefinitionsCreateInput = Parameters<typeof posthog.customPropertyDefinitionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
277
+ type CustomPropertyDefinitionsCreateOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsCreate>>;
278
+
279
+ const result: CustomPropertyDefinitionsCreateOutput = await posthog.customPropertyDefinitionsCreate();
280
+
281
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
282
+ ```
283
+
284
+ ### `posthog.customPropertyDefinitionsDestroy`
285
+
286
+ - **HTTP**: `DELETE /api/projects/{project_id}/custom_property_definitions/{id}/`
287
+ - **OpenAPI operationId**: `custom_property_definitions_destroy`
288
+ - **Path params**: `id`
289
+ - **Query params**: None
290
+ - **Response codes**: `204`
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: `204`
303
+
304
+ ```ts
305
+ import posthog from "@utdk/posthog";
306
+
307
+ type CustomPropertyDefinitionsDestroyInput = Parameters<typeof posthog.customPropertyDefinitionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
308
+ type CustomPropertyDefinitionsDestroyOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsDestroy>>;
309
+
310
+ const result: CustomPropertyDefinitionsDestroyOutput = await posthog.customPropertyDefinitionsDestroy();
311
+
312
+ // Result shape (from schema): unknown
313
+ ```
314
+
315
+ ### `posthog.customPropertyDefinitionsRetrieve`
316
+
317
+ - **HTTP**: `GET /api/projects/{project_id}/custom_property_definitions/{id}/`
318
+ - **OpenAPI operationId**: `custom_property_definitions_retrieve`
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; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
333
+ - OpenAPI response codes: `200`
334
+
335
+ ```ts
336
+ import posthog from "@utdk/posthog";
337
+
338
+ type CustomPropertyDefinitionsRetrieveInput = Parameters<typeof posthog.customPropertyDefinitionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
339
+ type CustomPropertyDefinitionsRetrieveOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsRetrieve>>;
340
+
341
+ const result: CustomPropertyDefinitionsRetrieveOutput = await posthog.customPropertyDefinitionsRetrieve();
342
+
343
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
344
+ ```
345
+
346
+ ### `posthog.customPropertyDefinitionsPartialUpdate`
347
+
348
+ - **HTTP**: `PATCH /api/projects/{project_id}/custom_property_definitions/{id}/`
349
+ - **OpenAPI operationId**: `custom_property_definitions_partial_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; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
364
+ - OpenAPI response codes: `200`
365
+
366
+ ```ts
367
+ import posthog from "@utdk/posthog";
368
+
369
+ type CustomPropertyDefinitionsPartialUpdateInput = Parameters<typeof posthog.customPropertyDefinitionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
370
+ type CustomPropertyDefinitionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsPartialUpdate>>;
371
+
372
+ const result: CustomPropertyDefinitionsPartialUpdateOutput = await posthog.customPropertyDefinitionsPartialUpdate();
373
+
374
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
375
+ ```
376
+
377
+ ### `posthog.customPropertyDefinitionsUpdate`
378
+
379
+ - **HTTP**: `PUT /api/projects/{project_id}/custom_property_definitions/{id}/`
380
+ - **OpenAPI operationId**: `custom_property_definitions_update`
381
+ - **Path params**: `id`
382
+ - **Query params**: None
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: `{ id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...`
395
+ - OpenAPI response codes: `200`
396
+
397
+ ```ts
398
+ import posthog from "@utdk/posthog";
399
+
400
+ type CustomPropertyDefinitionsUpdateInput = Parameters<typeof posthog.customPropertyDefinitionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
401
+ type CustomPropertyDefinitionsUpdateOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsUpdate>>;
402
+
403
+ const result: CustomPropertyDefinitionsUpdateOutput = await posthog.customPropertyDefinitionsUpdate();
404
+
405
+ // Result shape (from schema): { id: string; name: string; description?: string | null; display_type: "text" | "number" | "currency" | "percent" | "date" | "datetime" | "boolean" | "select"; is_big_number?: boolean; options?: unknown[] | null; source...
406
+ ```
407
+
408
+ ### `posthog.customPropertyDefinitionsValuesRetrieve`
409
+
410
+ - **HTTP**: `GET /api/projects/{project_id}/custom_property_definitions/values/`
411
+ - **OpenAPI operationId**: `custom_property_definitions_values_retrieve`
412
+ - **Path params**: None
413
+ - **Query params**: `key`, `value`
414
+ - **Response codes**: `200`
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: `{ results: ({ name: string })[]; refreshing: boolean }`
426
+ - OpenAPI response codes: `200`
427
+
428
+ ```ts
429
+ import posthog from "@utdk/posthog";
430
+
431
+ type CustomPropertyDefinitionsValuesRetrieveInput = Parameters<typeof posthog.customPropertyDefinitionsValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
432
+ type CustomPropertyDefinitionsValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.customPropertyDefinitionsValuesRetrieve>>;
433
+
434
+ const result: CustomPropertyDefinitionsValuesRetrieveOutput = await posthog.customPropertyDefinitionsValuesRetrieve();
435
+
436
+ // Result shape (from schema): { results: ({ name: string })[]; refreshing: boolean }
437
+ ```
438
+
439
+
440
+ <!-- prompt-hash:
441
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
442
+ -->
@@ -0,0 +1,194 @@
1
+ # Custom Property Sources
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.customPropertySourcesList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/custom_property_sources/`
8
+ - **OpenAPI operationId**: `custom_property_sources_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; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: nu...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type CustomPropertySourcesListInput = Parameters<typeof posthog.customPropertySourcesList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type CustomPropertySourcesListOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesList>>;
30
+
31
+ const result: CustomPropertySourcesListOutput = await posthog.customPropertySourcesList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: nu...
34
+ ```
35
+
36
+ ### `posthog.customPropertySourcesCreate`
37
+
38
+ - **HTTP**: `POST /api/projects/{project_id}/custom_property_sources/`
39
+ - **OpenAPI operationId**: `custom_property_sources_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; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type CustomPropertySourcesCreateInput = Parameters<typeof posthog.customPropertySourcesCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type CustomPropertySourcesCreateOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesCreate>>;
61
+
62
+ const result: CustomPropertySourcesCreateOutput = await posthog.customPropertySourcesCreate();
63
+
64
+ // Result shape (from schema): { id: string; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...
65
+ ```
66
+
67
+ ### `posthog.customPropertySourcesDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/projects/{project_id}/custom_property_sources/{id}/`
70
+ - **OpenAPI operationId**: `custom_property_sources_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 CustomPropertySourcesDestroyInput = Parameters<typeof posthog.customPropertySourcesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type CustomPropertySourcesDestroyOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesDestroy>>;
92
+
93
+ const result: CustomPropertySourcesDestroyOutput = await posthog.customPropertySourcesDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.customPropertySourcesRetrieve`
99
+
100
+ - **HTTP**: `GET /api/projects/{project_id}/custom_property_sources/{id}/`
101
+ - **OpenAPI operationId**: `custom_property_sources_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; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type CustomPropertySourcesRetrieveInput = Parameters<typeof posthog.customPropertySourcesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type CustomPropertySourcesRetrieveOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesRetrieve>>;
123
+
124
+ const result: CustomPropertySourcesRetrieveOutput = await posthog.customPropertySourcesRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...
127
+ ```
128
+
129
+ ### `posthog.customPropertySourcesPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/projects/{project_id}/custom_property_sources/{id}/`
132
+ - **OpenAPI operationId**: `custom_property_sources_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; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type CustomPropertySourcesPartialUpdateInput = Parameters<typeof posthog.customPropertySourcesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type CustomPropertySourcesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesPartialUpdate>>;
154
+
155
+ const result: CustomPropertySourcesPartialUpdateOutput = await posthog.customPropertySourcesPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...
158
+ ```
159
+
160
+ ### `posthog.customPropertySourcesUpdate`
161
+
162
+ - **HTTP**: `PUT /api/projects/{project_id}/custom_property_sources/{id}/`
163
+ - **OpenAPI operationId**: `custom_property_sources_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; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type CustomPropertySourcesUpdateInput = Parameters<typeof posthog.customPropertySourcesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type CustomPropertySourcesUpdateOutput = Awaited<ReturnType<typeof posthog.customPropertySourcesUpdate>>;
185
+
186
+ const result: CustomPropertySourcesUpdateOutput = await posthog.customPropertySourcesUpdate();
187
+
188
+ // Result shape (from schema): { id: string; definition: string; saved_query: string; source_column: string; key_column: string; is_enabled?: boolean; consecutive_failures: number; last_synced_at: string | null; last_sync_error: string | null; create...
189
+ ```
190
+
191
+
192
+ <!-- prompt-hash:
193
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
194
+ -->