@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,700 @@
1
+ # Platform Features
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsApprovalPoliciesList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/approval_policies/`
8
+ - **OpenAPI operationId**: `environments_approval_policies_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; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: u...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsApprovalPoliciesListInput = Parameters<typeof posthog.environmentsApprovalPoliciesList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsApprovalPoliciesListOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesList>>;
30
+
31
+ const result: EnvironmentsApprovalPoliciesListOutput = await posthog.environmentsApprovalPoliciesList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: u...
34
+ ```
35
+
36
+ ### `posthog.environmentsApprovalPoliciesCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/approval_policies/`
39
+ - **OpenAPI operationId**: `environments_approval_policies_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; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsApprovalPoliciesCreateInput = Parameters<typeof posthog.environmentsApprovalPoliciesCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsApprovalPoliciesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesCreate>>;
61
+
62
+ const result: EnvironmentsApprovalPoliciesCreateOutput = await posthog.environmentsApprovalPoliciesCreate();
63
+
64
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
65
+ ```
66
+
67
+ ### `posthog.environmentsApprovalPoliciesDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/approval_policies/{id}/`
70
+ - **OpenAPI operationId**: `environments_approval_policies_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 EnvironmentsApprovalPoliciesDestroyInput = Parameters<typeof posthog.environmentsApprovalPoliciesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
91
+ type EnvironmentsApprovalPoliciesDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesDestroy>>;
92
+
93
+ const result: EnvironmentsApprovalPoliciesDestroyOutput = await posthog.environmentsApprovalPoliciesDestroy();
94
+
95
+ // Result shape (from schema): unknown
96
+ ```
97
+
98
+ ### `posthog.environmentsApprovalPoliciesRetrieve`
99
+
100
+ - **HTTP**: `GET /api/environments/{environment_id}/approval_policies/{id}/`
101
+ - **OpenAPI operationId**: `environments_approval_policies_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; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
116
+ - OpenAPI response codes: `200`
117
+
118
+ ```ts
119
+ import posthog from "@utdk/posthog";
120
+
121
+ type EnvironmentsApprovalPoliciesRetrieveInput = Parameters<typeof posthog.environmentsApprovalPoliciesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
122
+ type EnvironmentsApprovalPoliciesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesRetrieve>>;
123
+
124
+ const result: EnvironmentsApprovalPoliciesRetrieveOutput = await posthog.environmentsApprovalPoliciesRetrieve();
125
+
126
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
127
+ ```
128
+
129
+ ### `posthog.environmentsApprovalPoliciesPartialUpdate`
130
+
131
+ - **HTTP**: `PATCH /api/environments/{environment_id}/approval_policies/{id}/`
132
+ - **OpenAPI operationId**: `environments_approval_policies_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; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
147
+ - OpenAPI response codes: `200`
148
+
149
+ ```ts
150
+ import posthog from "@utdk/posthog";
151
+
152
+ type EnvironmentsApprovalPoliciesPartialUpdateInput = Parameters<typeof posthog.environmentsApprovalPoliciesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
153
+ type EnvironmentsApprovalPoliciesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesPartialUpdate>>;
154
+
155
+ const result: EnvironmentsApprovalPoliciesPartialUpdateOutput = await posthog.environmentsApprovalPoliciesPartialUpdate();
156
+
157
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
158
+ ```
159
+
160
+ ### `posthog.environmentsApprovalPoliciesUpdate`
161
+
162
+ - **HTTP**: `PUT /api/environments/{environment_id}/approval_policies/{id}/`
163
+ - **OpenAPI operationId**: `environments_approval_policies_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; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
178
+ - OpenAPI response codes: `200`
179
+
180
+ ```ts
181
+ import posthog from "@utdk/posthog";
182
+
183
+ type EnvironmentsApprovalPoliciesUpdateInput = Parameters<typeof posthog.environmentsApprovalPoliciesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
184
+ type EnvironmentsApprovalPoliciesUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsApprovalPoliciesUpdate>>;
185
+
186
+ const result: EnvironmentsApprovalPoliciesUpdateOutput = await posthog.environmentsApprovalPoliciesUpdate();
187
+
188
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
189
+ ```
190
+
191
+ ### `posthog.environmentsChangeRequestsList`
192
+
193
+ - **HTTP**: `GET /api/environments/{environment_id}/change_requests/`
194
+ - **OpenAPI operationId**: `environments_change_requests_list`
195
+ - **Path params**: None
196
+ - **Query params**: `action_key`, `limit`, `offset`, `requester`, `resource_id`, `resource_type`, `state`
197
+ - **Response codes**: `200`
198
+ - **Transport options**: None
199
+ - **TypeScript**: [Client interface](../types.ts)
200
+
201
+ **Inputs**
202
+
203
+ - Client input type: `{ [key: string]: unknown }`
204
+ - Client transport options: None
205
+
206
+ **Outputs**
207
+
208
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: un...`
209
+ - OpenAPI response codes: `200`
210
+
211
+ ```ts
212
+ import posthog from "@utdk/posthog";
213
+
214
+ type EnvironmentsChangeRequestsListInput = Parameters<typeof posthog.environmentsChangeRequestsList> extends [infer T, ...unknown[]] ? T : undefined;
215
+ type EnvironmentsChangeRequestsListOutput = Awaited<ReturnType<typeof posthog.environmentsChangeRequestsList>>;
216
+
217
+ const result: EnvironmentsChangeRequestsListOutput = await posthog.environmentsChangeRequestsList();
218
+
219
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: un...
220
+ ```
221
+
222
+ ### `posthog.environmentsChangeRequestsRetrieve`
223
+
224
+ - **HTTP**: `GET /api/environments/{environment_id}/change_requests/{id}/`
225
+ - **OpenAPI operationId**: `environments_change_requests_retrieve`
226
+ - **Path params**: `id`
227
+ - **Query params**: None
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: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
240
+ - OpenAPI response codes: `200`
241
+
242
+ ```ts
243
+ import posthog from "@utdk/posthog";
244
+
245
+ type EnvironmentsChangeRequestsRetrieveInput = Parameters<typeof posthog.environmentsChangeRequestsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
246
+ type EnvironmentsChangeRequestsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsChangeRequestsRetrieve>>;
247
+
248
+ const result: EnvironmentsChangeRequestsRetrieveOutput = await posthog.environmentsChangeRequestsRetrieve();
249
+
250
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
251
+ ```
252
+
253
+ ### `posthog.environmentsChangeRequestsApproveCreate`
254
+
255
+ - **HTTP**: `POST /api/environments/{environment_id}/change_requests/{id}/approve/`
256
+ - **What it does**: Approve a change request.
257
+ If quorum is reached, automatically applies the change immediately.
258
+ - **OpenAPI operationId**: `environments_change_requests_approve_create`
259
+ - **Path params**: `id`
260
+ - **Query params**: None
261
+ - **Response codes**: `200`
262
+ - **Transport options**: None
263
+ - **TypeScript**: [Client interface](../types.ts)
264
+
265
+ **Inputs**
266
+
267
+ - Client input type: `{ [key: string]: unknown }`
268
+ - Client transport options: None
269
+
270
+ **Outputs**
271
+
272
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
273
+ - OpenAPI response codes: `200`
274
+
275
+ ```ts
276
+ import posthog from "@utdk/posthog";
277
+
278
+ type EnvironmentsChangeRequestsApproveCreateInput = Parameters<typeof posthog.environmentsChangeRequestsApproveCreate> extends [infer T, ...unknown[]] ? T : undefined;
279
+ type EnvironmentsChangeRequestsApproveCreateOutput = Awaited<ReturnType<typeof posthog.environmentsChangeRequestsApproveCreate>>;
280
+
281
+ const result: EnvironmentsChangeRequestsApproveCreateOutput = await posthog.environmentsChangeRequestsApproveCreate();
282
+
283
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
284
+ ```
285
+
286
+ ### `posthog.environmentsChangeRequestsCancelCreate`
287
+
288
+ - **HTTP**: `POST /api/environments/{environment_id}/change_requests/{id}/cancel/`
289
+ - **What it does**: Cancel a change request.
290
+ Only the requester can cancel their own pending change request.
291
+ - **OpenAPI operationId**: `environments_change_requests_cancel_create`
292
+ - **Path params**: `id`
293
+ - **Query params**: None
294
+ - **Response codes**: `200`
295
+ - **Transport options**: None
296
+ - **TypeScript**: [Client interface](../types.ts)
297
+
298
+ **Inputs**
299
+
300
+ - Client input type: `{ [key: string]: unknown }`
301
+ - Client transport options: None
302
+
303
+ **Outputs**
304
+
305
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
306
+ - OpenAPI response codes: `200`
307
+
308
+ ```ts
309
+ import posthog from "@utdk/posthog";
310
+
311
+ type EnvironmentsChangeRequestsCancelCreateInput = Parameters<typeof posthog.environmentsChangeRequestsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
312
+ type EnvironmentsChangeRequestsCancelCreateOutput = Awaited<ReturnType<typeof posthog.environmentsChangeRequestsCancelCreate>>;
313
+
314
+ const result: EnvironmentsChangeRequestsCancelCreateOutput = await posthog.environmentsChangeRequestsCancelCreate();
315
+
316
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
317
+ ```
318
+
319
+ ### `posthog.environmentsChangeRequestsRejectCreate`
320
+
321
+ - **HTTP**: `POST /api/environments/{environment_id}/change_requests/{id}/reject/`
322
+ - **What it does**: Reject a change request.
323
+ - **OpenAPI operationId**: `environments_change_requests_reject_create`
324
+ - **Path params**: `id`
325
+ - **Query params**: None
326
+ - **Response codes**: `200`
327
+ - **Transport options**: None
328
+ - **TypeScript**: [Client interface](../types.ts)
329
+
330
+ **Inputs**
331
+
332
+ - Client input type: `{ [key: string]: unknown }`
333
+ - Client transport options: None
334
+
335
+ **Outputs**
336
+
337
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
338
+ - OpenAPI response codes: `200`
339
+
340
+ ```ts
341
+ import posthog from "@utdk/posthog";
342
+
343
+ type EnvironmentsChangeRequestsRejectCreateInput = Parameters<typeof posthog.environmentsChangeRequestsRejectCreate> extends [infer T, ...unknown[]] ? T : undefined;
344
+ type EnvironmentsChangeRequestsRejectCreateOutput = Awaited<ReturnType<typeof posthog.environmentsChangeRequestsRejectCreate>>;
345
+
346
+ const result: EnvironmentsChangeRequestsRejectCreateOutput = await posthog.environmentsChangeRequestsRejectCreate();
347
+
348
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
349
+ ```
350
+
351
+ ### `posthog.approvalPoliciesList`
352
+
353
+ - **HTTP**: `GET /api/projects/{project_id}/approval_policies/`
354
+ - **OpenAPI operationId**: `approval_policies_list`
355
+ - **Path params**: None
356
+ - **Query params**: `limit`, `offset`
357
+ - **Response codes**: `200`
358
+ - **Transport options**: None
359
+ - **TypeScript**: [Client interface](../types.ts)
360
+
361
+ **Inputs**
362
+
363
+ - Client input type: `{ [key: string]: unknown }`
364
+ - Client transport options: None
365
+
366
+ **Outputs**
367
+
368
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: u...`
369
+ - OpenAPI response codes: `200`
370
+
371
+ ```ts
372
+ import posthog from "@utdk/posthog";
373
+
374
+ type ApprovalPoliciesListInput = Parameters<typeof posthog.approvalPoliciesList> extends [infer T, ...unknown[]] ? T : undefined;
375
+ type ApprovalPoliciesListOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesList>>;
376
+
377
+ const result: ApprovalPoliciesListOutput = await posthog.approvalPoliciesList();
378
+
379
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: u...
380
+ ```
381
+
382
+ ### `posthog.approvalPoliciesCreate`
383
+
384
+ - **HTTP**: `POST /api/projects/{project_id}/approval_policies/`
385
+ - **OpenAPI operationId**: `approval_policies_create`
386
+ - **Path params**: None
387
+ - **Query params**: None
388
+ - **Response codes**: `201`
389
+ - **Transport options**: None
390
+ - **TypeScript**: [Client interface](../types.ts)
391
+
392
+ **Inputs**
393
+
394
+ - Client input type: `{ [key: string]: unknown }`
395
+ - Client transport options: None
396
+
397
+ **Outputs**
398
+
399
+ - Client return type: `{ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
400
+ - OpenAPI response codes: `201`
401
+
402
+ ```ts
403
+ import posthog from "@utdk/posthog";
404
+
405
+ type ApprovalPoliciesCreateInput = Parameters<typeof posthog.approvalPoliciesCreate> extends [infer T, ...unknown[]] ? T : undefined;
406
+ type ApprovalPoliciesCreateOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesCreate>>;
407
+
408
+ const result: ApprovalPoliciesCreateOutput = await posthog.approvalPoliciesCreate();
409
+
410
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
411
+ ```
412
+
413
+ ### `posthog.approvalPoliciesDestroy`
414
+
415
+ - **HTTP**: `DELETE /api/projects/{project_id}/approval_policies/{id}/`
416
+ - **OpenAPI operationId**: `approval_policies_destroy`
417
+ - **Path params**: `id`
418
+ - **Query params**: None
419
+ - **Response codes**: `204`
420
+ - **Transport options**: None
421
+ - **TypeScript**: [Client interface](../types.ts)
422
+
423
+ **Inputs**
424
+
425
+ - Client input type: `{ [key: string]: unknown }`
426
+ - Client transport options: None
427
+
428
+ **Outputs**
429
+
430
+ - Client return type: `unknown`
431
+ - OpenAPI response codes: `204`
432
+
433
+ ```ts
434
+ import posthog from "@utdk/posthog";
435
+
436
+ type ApprovalPoliciesDestroyInput = Parameters<typeof posthog.approvalPoliciesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
437
+ type ApprovalPoliciesDestroyOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesDestroy>>;
438
+
439
+ const result: ApprovalPoliciesDestroyOutput = await posthog.approvalPoliciesDestroy();
440
+
441
+ // Result shape (from schema): unknown
442
+ ```
443
+
444
+ ### `posthog.approvalPoliciesRetrieve`
445
+
446
+ - **HTTP**: `GET /api/projects/{project_id}/approval_policies/{id}/`
447
+ - **OpenAPI operationId**: `approval_policies_retrieve`
448
+ - **Path params**: `id`
449
+ - **Query params**: None
450
+ - **Response codes**: `200`
451
+ - **Transport options**: None
452
+ - **TypeScript**: [Client interface](../types.ts)
453
+
454
+ **Inputs**
455
+
456
+ - Client input type: `{ [key: string]: unknown }`
457
+ - Client transport options: None
458
+
459
+ **Outputs**
460
+
461
+ - Client return type: `{ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
462
+ - OpenAPI response codes: `200`
463
+
464
+ ```ts
465
+ import posthog from "@utdk/posthog";
466
+
467
+ type ApprovalPoliciesRetrieveInput = Parameters<typeof posthog.approvalPoliciesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
468
+ type ApprovalPoliciesRetrieveOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesRetrieve>>;
469
+
470
+ const result: ApprovalPoliciesRetrieveOutput = await posthog.approvalPoliciesRetrieve();
471
+
472
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
473
+ ```
474
+
475
+ ### `posthog.approvalPoliciesPartialUpdate`
476
+
477
+ - **HTTP**: `PATCH /api/projects/{project_id}/approval_policies/{id}/`
478
+ - **OpenAPI operationId**: `approval_policies_partial_update`
479
+ - **Path params**: `id`
480
+ - **Query params**: None
481
+ - **Response codes**: `200`
482
+ - **Transport options**: None
483
+ - **TypeScript**: [Client interface](../types.ts)
484
+
485
+ **Inputs**
486
+
487
+ - Client input type: `{ [key: string]: unknown }`
488
+ - Client transport options: None
489
+
490
+ **Outputs**
491
+
492
+ - Client return type: `{ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
493
+ - OpenAPI response codes: `200`
494
+
495
+ ```ts
496
+ import posthog from "@utdk/posthog";
497
+
498
+ type ApprovalPoliciesPartialUpdateInput = Parameters<typeof posthog.approvalPoliciesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
499
+ type ApprovalPoliciesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesPartialUpdate>>;
500
+
501
+ const result: ApprovalPoliciesPartialUpdateOutput = await posthog.approvalPoliciesPartialUpdate();
502
+
503
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
504
+ ```
505
+
506
+ ### `posthog.approvalPoliciesUpdate`
507
+
508
+ - **HTTP**: `PUT /api/projects/{project_id}/approval_policies/{id}/`
509
+ - **OpenAPI operationId**: `approval_policies_update`
510
+ - **Path params**: `id`
511
+ - **Query params**: None
512
+ - **Response codes**: `200`
513
+ - **Transport options**: None
514
+ - **TypeScript**: [Client interface](../types.ts)
515
+
516
+ **Inputs**
517
+
518
+ - Client input type: `{ [key: string]: unknown }`
519
+ - Client transport options: None
520
+
521
+ **Outputs**
522
+
523
+ - Client return type: `{ id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...`
524
+ - OpenAPI response codes: `200`
525
+
526
+ ```ts
527
+ import posthog from "@utdk/posthog";
528
+
529
+ type ApprovalPoliciesUpdateInput = Parameters<typeof posthog.approvalPoliciesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
530
+ type ApprovalPoliciesUpdateOutput = Awaited<ReturnType<typeof posthog.approvalPoliciesUpdate>>;
531
+
532
+ const result: ApprovalPoliciesUpdateOutput = await posthog.approvalPoliciesUpdate();
533
+
534
+ // Result shape (from schema): { id: string; action_key: string; conditions?: unknown; approver_config: unknown; allow_self_approve?: boolean; bypass_org_membership_levels?: unknown; bypass_roles?: (string)[]; expires_after?: string; enabled?: boolea...
535
+ ```
536
+
537
+ ### `posthog.changeRequestsList`
538
+
539
+ - **HTTP**: `GET /api/projects/{project_id}/change_requests/`
540
+ - **OpenAPI operationId**: `change_requests_list`
541
+ - **Path params**: None
542
+ - **Query params**: `action_key`, `limit`, `offset`, `requester`, `resource_id`, `resource_type`, `state`
543
+ - **Response codes**: `200`
544
+ - **Transport options**: None
545
+ - **TypeScript**: [Client interface](../types.ts)
546
+
547
+ **Inputs**
548
+
549
+ - Client input type: `{ [key: string]: unknown }`
550
+ - Client transport options: None
551
+
552
+ **Outputs**
553
+
554
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: un...`
555
+ - OpenAPI response codes: `200`
556
+
557
+ ```ts
558
+ import posthog from "@utdk/posthog";
559
+
560
+ type ChangeRequestsListInput = Parameters<typeof posthog.changeRequestsList> extends [infer T, ...unknown[]] ? T : undefined;
561
+ type ChangeRequestsListOutput = Awaited<ReturnType<typeof posthog.changeRequestsList>>;
562
+
563
+ const result: ChangeRequestsListOutput = await posthog.changeRequestsList();
564
+
565
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: un...
566
+ ```
567
+
568
+ ### `posthog.changeRequestsRetrieve`
569
+
570
+ - **HTTP**: `GET /api/projects/{project_id}/change_requests/{id}/`
571
+ - **OpenAPI operationId**: `change_requests_retrieve`
572
+ - **Path params**: `id`
573
+ - **Query params**: None
574
+ - **Response codes**: `200`
575
+ - **Transport options**: None
576
+ - **TypeScript**: [Client interface](../types.ts)
577
+
578
+ **Inputs**
579
+
580
+ - Client input type: `{ [key: string]: unknown }`
581
+ - Client transport options: None
582
+
583
+ **Outputs**
584
+
585
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
586
+ - OpenAPI response codes: `200`
587
+
588
+ ```ts
589
+ import posthog from "@utdk/posthog";
590
+
591
+ type ChangeRequestsRetrieveInput = Parameters<typeof posthog.changeRequestsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
592
+ type ChangeRequestsRetrieveOutput = Awaited<ReturnType<typeof posthog.changeRequestsRetrieve>>;
593
+
594
+ const result: ChangeRequestsRetrieveOutput = await posthog.changeRequestsRetrieve();
595
+
596
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
597
+ ```
598
+
599
+ ### `posthog.changeRequestsApproveCreate`
600
+
601
+ - **HTTP**: `POST /api/projects/{project_id}/change_requests/{id}/approve/`
602
+ - **What it does**: Approve a change request.
603
+ If quorum is reached, automatically applies the change immediately.
604
+ - **OpenAPI operationId**: `change_requests_approve_create`
605
+ - **Path params**: `id`
606
+ - **Query params**: None
607
+ - **Response codes**: `200`
608
+ - **Transport options**: None
609
+ - **TypeScript**: [Client interface](../types.ts)
610
+
611
+ **Inputs**
612
+
613
+ - Client input type: `{ [key: string]: unknown }`
614
+ - Client transport options: None
615
+
616
+ **Outputs**
617
+
618
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
619
+ - OpenAPI response codes: `200`
620
+
621
+ ```ts
622
+ import posthog from "@utdk/posthog";
623
+
624
+ type ChangeRequestsApproveCreateInput = Parameters<typeof posthog.changeRequestsApproveCreate> extends [infer T, ...unknown[]] ? T : undefined;
625
+ type ChangeRequestsApproveCreateOutput = Awaited<ReturnType<typeof posthog.changeRequestsApproveCreate>>;
626
+
627
+ const result: ChangeRequestsApproveCreateOutput = await posthog.changeRequestsApproveCreate();
628
+
629
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
630
+ ```
631
+
632
+ ### `posthog.changeRequestsCancelCreate`
633
+
634
+ - **HTTP**: `POST /api/projects/{project_id}/change_requests/{id}/cancel/`
635
+ - **What it does**: Cancel a change request.
636
+ Only the requester can cancel their own pending change request.
637
+ - **OpenAPI operationId**: `change_requests_cancel_create`
638
+ - **Path params**: `id`
639
+ - **Query params**: None
640
+ - **Response codes**: `200`
641
+ - **Transport options**: None
642
+ - **TypeScript**: [Client interface](../types.ts)
643
+
644
+ **Inputs**
645
+
646
+ - Client input type: `{ [key: string]: unknown }`
647
+ - Client transport options: None
648
+
649
+ **Outputs**
650
+
651
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
652
+ - OpenAPI response codes: `200`
653
+
654
+ ```ts
655
+ import posthog from "@utdk/posthog";
656
+
657
+ type ChangeRequestsCancelCreateInput = Parameters<typeof posthog.changeRequestsCancelCreate> extends [infer T, ...unknown[]] ? T : undefined;
658
+ type ChangeRequestsCancelCreateOutput = Awaited<ReturnType<typeof posthog.changeRequestsCancelCreate>>;
659
+
660
+ const result: ChangeRequestsCancelCreateOutput = await posthog.changeRequestsCancelCreate();
661
+
662
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
663
+ ```
664
+
665
+ ### `posthog.changeRequestsRejectCreate`
666
+
667
+ - **HTTP**: `POST /api/projects/{project_id}/change_requests/{id}/reject/`
668
+ - **What it does**: Reject a change request.
669
+ - **OpenAPI operationId**: `change_requests_reject_create`
670
+ - **Path params**: `id`
671
+ - **Query params**: None
672
+ - **Response codes**: `200`
673
+ - **Transport options**: None
674
+ - **TypeScript**: [Client interface](../types.ts)
675
+
676
+ **Inputs**
677
+
678
+ - Client input type: `{ [key: string]: unknown }`
679
+ - Client transport options: None
680
+
681
+ **Outputs**
682
+
683
+ - Client return type: `{ id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...`
684
+ - OpenAPI response codes: `200`
685
+
686
+ ```ts
687
+ import posthog from "@utdk/posthog";
688
+
689
+ type ChangeRequestsRejectCreateInput = Parameters<typeof posthog.changeRequestsRejectCreate> extends [infer T, ...unknown[]] ? T : undefined;
690
+ type ChangeRequestsRejectCreateOutput = Awaited<ReturnType<typeof posthog.changeRequestsRejectCreate>>;
691
+
692
+ const result: ChangeRequestsRejectCreateOutput = await posthog.changeRequestsRejectCreate();
693
+
694
+ // Result shape (from schema): { id: string; action_key: string; action_version: number; resource_type: string; resource_id: string | null; intent: unknown; intent_display: unknown; policy_snapshot: unknown; validation_status: "valid" | "invalid" | "...
695
+ ```
696
+
697
+
698
+ <!-- prompt-hash:
699
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
700
+ -->