@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,444 @@
1
+ # Project Secret Api Keys
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsProjectSecretApiKeysList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/project_secret_api_keys/`
8
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?:...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsProjectSecretApiKeysListInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsProjectSecretApiKeysListOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysList>>;
30
+
31
+ const result: EnvironmentsProjectSecretApiKeysListOutput = await posthog.environmentsProjectSecretApiKeysList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?:...
34
+ ```
35
+
36
+ ### `posthog.environmentsProjectSecretApiKeysCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/project_secret_api_keys/`
39
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsProjectSecretApiKeysCreateInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsProjectSecretApiKeysCreateOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysCreate>>;
61
+
62
+ const result: EnvironmentsProjectSecretApiKeysCreateOutput = await posthog.environmentsProjectSecretApiKeysCreate();
63
+
64
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
65
+ ```
66
+
67
+ ### `posthog.environmentsProjectSecretApiKeysDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/project_secret_api_keys/{id}/`
70
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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 EnvironmentsProjectSecretApiKeysDestroyInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsProjectSecretApiKeysDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysDestroy>>;
92
+
93
+ const result: EnvironmentsProjectSecretApiKeysDestroyOutput = await posthog.environmentsProjectSecretApiKeysDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsProjectSecretApiKeysRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/project_secret_api_keys/{id}/`
101
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsProjectSecretApiKeysRetrieveInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsProjectSecretApiKeysRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysRetrieve>>;
123
+
124
+ const result: EnvironmentsProjectSecretApiKeysRetrieveOutput = await posthog.environmentsProjectSecretApiKeysRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
127
+ ```
128
+
129
+ ### `posthog.environmentsProjectSecretApiKeysPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/project_secret_api_keys/{id}/`
132
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsProjectSecretApiKeysPartialUpdateInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsProjectSecretApiKeysPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysPartialUpdate>>;
154
+
155
+ const result: EnvironmentsProjectSecretApiKeysPartialUpdateOutput = await posthog.environmentsProjectSecretApiKeysPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
158
+ ```
159
+
160
+ ### `posthog.environmentsProjectSecretApiKeysUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/project_secret_api_keys/{id}/`
163
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_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; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsProjectSecretApiKeysUpdateInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsProjectSecretApiKeysUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysUpdate>>;
185
+
186
+ const result: EnvironmentsProjectSecretApiKeysUpdateOutput = await posthog.environmentsProjectSecretApiKeysUpdate();
187
+
188
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
189
+ ```
190
+
191
+ ### `posthog.environmentsProjectSecretApiKeysRollCreate`
192
+
193
+ - **HTTP**: `POST /api/environments/{environment_id}/project_secret_api_keys/{id}/roll/`
194
+ - **What it does**: Roll a project secret API key
195
+ - **OpenAPI operationId**: `environments_project_secret_api_keys_roll_create`
196
+ - **Path params**: `id`
197
+ - **Query params**: None
198
+ - **Response codes**: `200`
199
+ - **Transport options**: None
200
+ - **TypeScript**: [Client interface](../types.ts)
201
+
202
+ **Inputs**
203
+
204
+ - Client input type: `{ [key: string]: unknown }`
205
+ - Client transport options: None
206
+
207
+ **Outputs**
208
+
209
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
210
+ - OpenAPI response codes: `200`
211
+
212
+ ```ts
213
+ import posthog from "@utdk/posthog";
214
+
215
+ type EnvironmentsProjectSecretApiKeysRollCreateInput = Parameters<typeof posthog.environmentsProjectSecretApiKeysRollCreate> extends [infer T, ...unknown[]] ? T : undefined;
216
+ type EnvironmentsProjectSecretApiKeysRollCreateOutput = Awaited<ReturnType<typeof posthog.environmentsProjectSecretApiKeysRollCreate>>;
217
+
218
+ const result: EnvironmentsProjectSecretApiKeysRollCreateOutput = await posthog.environmentsProjectSecretApiKeysRollCreate();
219
+
220
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
221
+ ```
222
+
223
+ ### `posthog.projectSecretApiKeysList`
224
+
225
+ - **HTTP**: `GET /api/projects/{project_id}/project_secret_api_keys/`
226
+ - **OpenAPI operationId**: `project_secret_api_keys_list`
227
+ - **Path params**: None
228
+ - **Query params**: `limit`, `offset`
229
+ - **Response codes**: `200`
230
+ - **Transport options**: None
231
+ - **TypeScript**: [Client interface](../types.ts)
232
+
233
+ **Inputs**
234
+
235
+ - Client input type: `{ [key: string]: unknown }`
236
+ - Client transport options: None
237
+
238
+ **Outputs**
239
+
240
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?:...`
241
+ - OpenAPI response codes: `200`
242
+
243
+ ```ts
244
+ import posthog from "@utdk/posthog";
245
+
246
+ type ProjectSecretApiKeysListInput = Parameters<typeof posthog.projectSecretApiKeysList> extends [infer T, ...unknown[]] ? T : undefined;
247
+ type ProjectSecretApiKeysListOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysList>>;
248
+
249
+ const result: ProjectSecretApiKeysListOutput = await posthog.projectSecretApiKeysList();
250
+
251
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?:...
252
+ ```
253
+
254
+ ### `posthog.projectSecretApiKeysCreate`
255
+
256
+ - **HTTP**: `POST /api/projects/{project_id}/project_secret_api_keys/`
257
+ - **OpenAPI operationId**: `project_secret_api_keys_create`
258
+ - **Path params**: None
259
+ - **Query params**: None
260
+ - **Response codes**: `201`
261
+ - **Transport options**: None
262
+ - **TypeScript**: [Client interface](../types.ts)
263
+
264
+ **Inputs**
265
+
266
+ - Client input type: `{ [key: string]: unknown }`
267
+ - Client transport options: None
268
+
269
+ **Outputs**
270
+
271
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
272
+ - OpenAPI response codes: `201`
273
+
274
+ ```ts
275
+ import posthog from "@utdk/posthog";
276
+
277
+ type ProjectSecretApiKeysCreateInput = Parameters<typeof posthog.projectSecretApiKeysCreate> extends [infer T, ...unknown[]] ? T : undefined;
278
+ type ProjectSecretApiKeysCreateOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysCreate>>;
279
+
280
+ const result: ProjectSecretApiKeysCreateOutput = await posthog.projectSecretApiKeysCreate();
281
+
282
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
283
+ ```
284
+
285
+ ### `posthog.projectSecretApiKeysDestroy`
286
+
287
+ - **HTTP**: `DELETE /api/projects/{project_id}/project_secret_api_keys/{id}/`
288
+ - **OpenAPI operationId**: `project_secret_api_keys_destroy`
289
+ - **Path params**: `id`
290
+ - **Query params**: None
291
+ - **Response codes**: `204`
292
+ - **Transport options**: None
293
+ - **TypeScript**: [Client interface](../types.ts)
294
+
295
+ **Inputs**
296
+
297
+ - Client input type: `{ [key: string]: unknown }`
298
+ - Client transport options: None
299
+
300
+ **Outputs**
301
+
302
+ - Client return type: `unknown`
303
+ - OpenAPI response codes: `204`
304
+
305
+ ```ts
306
+ import posthog from "@utdk/posthog";
307
+
308
+ type ProjectSecretApiKeysDestroyInput = Parameters<typeof posthog.projectSecretApiKeysDestroy> extends [infer T, ...unknown[]] ? T : undefined;
309
+ type ProjectSecretApiKeysDestroyOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysDestroy>>;
310
+
311
+ const result: ProjectSecretApiKeysDestroyOutput = await posthog.projectSecretApiKeysDestroy();
312
+
313
+ // Result shape (from schema): unknown
314
+ ```
315
+
316
+ ### `posthog.projectSecretApiKeysRetrieve`
317
+
318
+ - **HTTP**: `GET /api/projects/{project_id}/project_secret_api_keys/{id}/`
319
+ - **OpenAPI operationId**: `project_secret_api_keys_retrieve`
320
+ - **Path params**: `id`
321
+ - **Query params**: None
322
+ - **Response codes**: `200`
323
+ - **Transport options**: None
324
+ - **TypeScript**: [Client interface](../types.ts)
325
+
326
+ **Inputs**
327
+
328
+ - Client input type: `{ [key: string]: unknown }`
329
+ - Client transport options: None
330
+
331
+ **Outputs**
332
+
333
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
334
+ - OpenAPI response codes: `200`
335
+
336
+ ```ts
337
+ import posthog from "@utdk/posthog";
338
+
339
+ type ProjectSecretApiKeysRetrieveInput = Parameters<typeof posthog.projectSecretApiKeysRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
340
+ type ProjectSecretApiKeysRetrieveOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysRetrieve>>;
341
+
342
+ const result: ProjectSecretApiKeysRetrieveOutput = await posthog.projectSecretApiKeysRetrieve();
343
+
344
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
345
+ ```
346
+
347
+ ### `posthog.projectSecretApiKeysPartialUpdate`
348
+
349
+ - **HTTP**: `PATCH /api/projects/{project_id}/project_secret_api_keys/{id}/`
350
+ - **OpenAPI operationId**: `project_secret_api_keys_partial_update`
351
+ - **Path params**: `id`
352
+ - **Query params**: None
353
+ - **Response codes**: `200`
354
+ - **Transport options**: None
355
+ - **TypeScript**: [Client interface](../types.ts)
356
+
357
+ **Inputs**
358
+
359
+ - Client input type: `{ [key: string]: unknown }`
360
+ - Client transport options: None
361
+
362
+ **Outputs**
363
+
364
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
365
+ - OpenAPI response codes: `200`
366
+
367
+ ```ts
368
+ import posthog from "@utdk/posthog";
369
+
370
+ type ProjectSecretApiKeysPartialUpdateInput = Parameters<typeof posthog.projectSecretApiKeysPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
371
+ type ProjectSecretApiKeysPartialUpdateOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysPartialUpdate>>;
372
+
373
+ const result: ProjectSecretApiKeysPartialUpdateOutput = await posthog.projectSecretApiKeysPartialUpdate();
374
+
375
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
376
+ ```
377
+
378
+ ### `posthog.projectSecretApiKeysUpdate`
379
+
380
+ - **HTTP**: `PUT /api/projects/{project_id}/project_secret_api_keys/{id}/`
381
+ - **OpenAPI operationId**: `project_secret_api_keys_update`
382
+ - **Path params**: `id`
383
+ - **Query params**: None
384
+ - **Response codes**: `200`
385
+ - **Transport options**: None
386
+ - **TypeScript**: [Client interface](../types.ts)
387
+
388
+ **Inputs**
389
+
390
+ - Client input type: `{ [key: string]: unknown }`
391
+ - Client transport options: None
392
+
393
+ **Outputs**
394
+
395
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
396
+ - OpenAPI response codes: `200`
397
+
398
+ ```ts
399
+ import posthog from "@utdk/posthog";
400
+
401
+ type ProjectSecretApiKeysUpdateInput = Parameters<typeof posthog.projectSecretApiKeysUpdate> extends [infer T, ...unknown[]] ? T : undefined;
402
+ type ProjectSecretApiKeysUpdateOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysUpdate>>;
403
+
404
+ const result: ProjectSecretApiKeysUpdateOutput = await posthog.projectSecretApiKeysUpdate();
405
+
406
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
407
+ ```
408
+
409
+ ### `posthog.projectSecretApiKeysRollCreate`
410
+
411
+ - **HTTP**: `POST /api/projects/{project_id}/project_secret_api_keys/{id}/roll/`
412
+ - **What it does**: Roll a project secret API key
413
+ - **OpenAPI operationId**: `project_secret_api_keys_roll_create`
414
+ - **Path params**: `id`
415
+ - **Query params**: None
416
+ - **Response codes**: `200`
417
+ - **Transport options**: None
418
+ - **TypeScript**: [Client interface](../types.ts)
419
+
420
+ **Inputs**
421
+
422
+ - Client input type: `{ [key: string]: unknown }`
423
+ - Client transport options: None
424
+
425
+ **Outputs**
426
+
427
+ - Client return type: `{ id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...`
428
+ - OpenAPI response codes: `200`
429
+
430
+ ```ts
431
+ import posthog from "@utdk/posthog";
432
+
433
+ type ProjectSecretApiKeysRollCreateInput = Parameters<typeof posthog.projectSecretApiKeysRollCreate> extends [infer T, ...unknown[]] ? T : undefined;
434
+ type ProjectSecretApiKeysRollCreateOutput = Awaited<ReturnType<typeof posthog.projectSecretApiKeysRollCreate>>;
435
+
436
+ const result: ProjectSecretApiKeysRollCreateOutput = await posthog.projectSecretApiKeysRollCreate();
437
+
438
+ // Result shape (from schema): { id: string; label: string; value: string; mask_value: string | null; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_...
439
+ ```
440
+
441
+
442
+ <!-- prompt-hash:
443
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
444
+ -->
@@ -0,0 +1,200 @@
1
+ # Property Access Controls
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsPropertyAccessControlsDestroy`
6
+
7
+ - **HTTP**: `DELETE /api/environments/{environment_id}/property_access_controls/`
8
+ - **What it does**: Delete a property access control rule. The rule is identified by `property_definition_id` plus an optional `organization_member` or `role` query parameter. Omitting both targets deletes the default rule.
9
+ - **OpenAPI operationId**: `environments_property_access_controls_destroy`
10
+ - **Path params**: None
11
+ - **Query params**: `organization_member`, `property_definition_id`, `role`
12
+ - **Response codes**: `204`
13
+ - **Transport options**: None
14
+ - **TypeScript**: [Client interface](../types.ts)
15
+
16
+ **Inputs**
17
+
18
+ - Client input type: `{ [key: string]: unknown }`
19
+ - Client transport options: None
20
+
21
+ **Outputs**
22
+
23
+ - Client return type: `unknown`
24
+ - OpenAPI response codes: `204`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type EnvironmentsPropertyAccessControlsDestroyInput = Parameters<typeof posthog.environmentsPropertyAccessControlsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type EnvironmentsPropertyAccessControlsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsPropertyAccessControlsDestroy>>;
31
+
32
+ const result: EnvironmentsPropertyAccessControlsDestroyOutput = await posthog.environmentsPropertyAccessControlsDestroy();
33
+
34
+ // Result shape (from schema): unknown
35
+ ```
36
+
37
+ ### `posthog.environmentsPropertyAccessControlsRetrieve`
38
+
39
+ - **HTTP**: `GET /api/environments/{environment_id}/property_access_controls/`
40
+ - **What it does**: Get all property access control rules for a property definition.
41
+ - **OpenAPI operationId**: `environments_property_access_controls_retrieve`
42
+ - **Path params**: None
43
+ - **Query params**: `property_definition_id`
44
+ - **Response codes**: `200`
45
+ - **Transport options**: None
46
+ - **TypeScript**: [Client interface](../types.ts)
47
+
48
+ **Inputs**
49
+
50
+ - Client input type: `{ [key: string]: unknown }`
51
+ - Client transport options: None
52
+
53
+ **Outputs**
54
+
55
+ - Client return type: `{ access_controls: ({ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string })[]; available_...`
56
+ - OpenAPI response codes: `200`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type EnvironmentsPropertyAccessControlsRetrieveInput = Parameters<typeof posthog.environmentsPropertyAccessControlsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type EnvironmentsPropertyAccessControlsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsPropertyAccessControlsRetrieve>>;
63
+
64
+ const result: EnvironmentsPropertyAccessControlsRetrieveOutput = await posthog.environmentsPropertyAccessControlsRetrieve();
65
+
66
+ // Result shape (from schema): { access_controls: ({ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string })[]; available_...
67
+ ```
68
+
69
+ ### `posthog.environmentsPropertyAccessControlsCreate`
70
+
71
+ - **HTTP**: `POST /api/environments/{environment_id}/property_access_controls/`
72
+ - **What it does**: Create or update a property access control rule.
73
+ - **OpenAPI operationId**: `environments_property_access_controls_create`
74
+ - **Path params**: None
75
+ - **Query params**: None
76
+ - **Response codes**: `200`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `{ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string }`
88
+ - OpenAPI response codes: `200`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type EnvironmentsPropertyAccessControlsCreateInput = Parameters<typeof posthog.environmentsPropertyAccessControlsCreate> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type EnvironmentsPropertyAccessControlsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsPropertyAccessControlsCreate>>;
95
+
96
+ const result: EnvironmentsPropertyAccessControlsCreateOutput = await posthog.environmentsPropertyAccessControlsCreate();
97
+
98
+ // Result shape (from schema): { id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string }
99
+ ```
100
+
101
+ ### `posthog.propertyAccessControlsDestroy`
102
+
103
+ - **HTTP**: `DELETE /api/projects/{project_id}/property_access_controls/`
104
+ - **What it does**: Delete a property access control rule. The rule is identified by `property_definition_id` plus an optional `organization_member` or `role` query parameter. Omitting both targets deletes the default rule.
105
+ - **OpenAPI operationId**: `property_access_controls_destroy`
106
+ - **Path params**: None
107
+ - **Query params**: `organization_member`, `property_definition_id`, `role`
108
+ - **Response codes**: `204`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `unknown`
120
+ - OpenAPI response codes: `204`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type PropertyAccessControlsDestroyInput = Parameters<typeof posthog.propertyAccessControlsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type PropertyAccessControlsDestroyOutput = Awaited<ReturnType<typeof posthog.propertyAccessControlsDestroy>>;
127
+
128
+ const result: PropertyAccessControlsDestroyOutput = await posthog.propertyAccessControlsDestroy();
129
+
130
+ // Result shape (from schema): unknown
131
+ ```
132
+
133
+ ### `posthog.propertyAccessControlsRetrieve`
134
+
135
+ - **HTTP**: `GET /api/projects/{project_id}/property_access_controls/`
136
+ - **What it does**: Get all property access control rules for a property definition.
137
+ - **OpenAPI operationId**: `property_access_controls_retrieve`
138
+ - **Path params**: None
139
+ - **Query params**: `property_definition_id`
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ access_controls: ({ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string })[]; available_...`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type PropertyAccessControlsRetrieveInput = Parameters<typeof posthog.propertyAccessControlsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type PropertyAccessControlsRetrieveOutput = Awaited<ReturnType<typeof posthog.propertyAccessControlsRetrieve>>;
159
+
160
+ const result: PropertyAccessControlsRetrieveOutput = await posthog.propertyAccessControlsRetrieve();
161
+
162
+ // Result shape (from schema): { access_controls: ({ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string })[]; available_...
163
+ ```
164
+
165
+ ### `posthog.propertyAccessControlsCreate`
166
+
167
+ - **HTTP**: `POST /api/projects/{project_id}/property_access_controls/`
168
+ - **What it does**: Create or update a property access control rule.
169
+ - **OpenAPI operationId**: `property_access_controls_create`
170
+ - **Path params**: None
171
+ - **Query params**: None
172
+ - **Response codes**: `200`
173
+ - **Transport options**: None
174
+ - **TypeScript**: [Client interface](../types.ts)
175
+
176
+ **Inputs**
177
+
178
+ - Client input type: `{ [key: string]: unknown }`
179
+ - Client transport options: None
180
+
181
+ **Outputs**
182
+
183
+ - Client return type: `{ id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string }`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type PropertyAccessControlsCreateInput = Parameters<typeof posthog.propertyAccessControlsCreate> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type PropertyAccessControlsCreateOutput = Awaited<ReturnType<typeof posthog.propertyAccessControlsCreate>>;
191
+
192
+ const result: PropertyAccessControlsCreateOutput = await posthog.propertyAccessControlsCreate();
193
+
194
+ // Result shape (from schema): { id: string; access_level: "read_write" | "read" | "none"; organization_member: string | null; role: string | null; created_by: number | null; created_at: string; updated_at: string }
195
+ ```
196
+
197
+
198
+ <!-- prompt-hash:
199
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
200
+ -->