@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.
- package/LICENSE +373 -0
- package/README.md +172 -0
- package/docs/account_relationship_definitions.md +194 -0
- package/docs/accounts.md +380 -0
- package/docs/actions.md +274 -0
- package/docs/activity_logs.md +144 -0
- package/docs/advanced_activity_logs.md +101 -0
- package/docs/agent_platform.md +2525 -0
- package/docs/ai-observability.md +514 -0
- package/docs/alerts.md +444 -0
- package/docs/annotations.md +200 -0
- package/docs/batch_exports.md +2118 -0
- package/docs/business_knowledge.md +468 -0
- package/docs/code-invites.md +72 -0
- package/docs/cohorts.md +412 -0
- package/docs/comments.md +321 -0
- package/docs/conversations.md +695 -0
- package/docs/custom_property_definitions.md +442 -0
- package/docs/custom_property_sources.md +194 -0
- package/docs/customer_analytics.md +442 -0
- package/docs/customer_journeys.md +380 -0
- package/docs/customer_profile_configs.md +380 -0
- package/docs/dashboard_templates.md +258 -0
- package/docs/dashboards.md +1896 -0
- package/docs/data_color_themes.md +380 -0
- package/docs/data_modeling_jobs.md +264 -0
- package/docs/data_warehouse.md +928 -0
- package/docs/dataset_items.md +382 -0
- package/docs/datasets.md +382 -0
- package/docs/desktop_file_system.md +753 -0
- package/docs/desktop_file_system_shortcut.md +244 -0
- package/docs/docs.md +72 -0
- package/docs/early_access_feature.md +194 -0
- package/docs/elements.md +510 -0
- package/docs/endpoints.md +1030 -0
- package/docs/engineering_analytics.md +712 -0
- package/docs/environments.md +881 -0
- package/docs/error_tracking.md +5108 -0
- package/docs/evaluation_runs.md +78 -0
- package/docs/evaluations.md +446 -0
- package/docs/event_definitions.md +425 -0
- package/docs/event_filter.md +280 -0
- package/docs/event_schemas.md +163 -0
- package/docs/events.md +208 -0
- package/docs/experiment_holdouts.md +194 -0
- package/docs/experiment_saved_metrics.md +194 -0
- package/docs/experiments.md +1088 -0
- package/docs/exports.md +256 -0
- package/docs/external_data_schemas.md +752 -0
- package/docs/external_data_sources.md +2296 -0
- package/docs/feature_flags.md +808 -0
- package/docs/field_notes.md +206 -0
- package/docs/file_system.md +880 -0
- package/docs/file_system_shortcut.md +444 -0
- package/docs/flag_value.md +46 -0
- package/docs/groups.md +514 -0
- package/docs/groups_types.md +349 -0
- package/docs/health_issues.md +386 -0
- package/docs/heatmap_screenshots.md +72 -0
- package/docs/heatmaps.md +136 -0
- package/docs/hog_flows.md +1576 -0
- package/docs/hog_function_templates.md +101 -0
- package/docs/hog_functions.md +974 -0
- package/docs/ingestion_warnings_v2.md +40 -0
- package/docs/insight_variables.md +380 -0
- package/docs/insights.md +1722 -0
- package/docs/integrations.md +1954 -0
- package/docs/js-snippet.md +104 -0
- package/docs/live_debugger_breakpoints.md +264 -0
- package/docs/llm_analytics.md +3373 -0
- package/docs/llm_prompts.md +442 -0
- package/docs/llm_skills.md +952 -0
- package/docs/logs.md +2446 -0
- package/docs/managed_viewsets.md +140 -0
- package/docs/marketing_analytics.md +518 -0
- package/docs/max.md +772 -0
- package/docs/max_tools.md +70 -0
- package/docs/mcp_analytics.md +712 -0
- package/docs/mcp_server_installations.md +970 -0
- package/docs/mcp_servers.md +78 -0
- package/docs/mcp_tools.md +82 -0
- package/docs/messaging_templates.md +444 -0
- package/docs/metrics.md +462 -0
- package/docs/notebooks.md +838 -0
- package/docs/object_media_previews.md +228 -0
- package/docs/organizations.md +2958 -0
- package/docs/persons.md +1514 -0
- package/docs/platform_features.md +700 -0
- package/docs/plugin_configs.md +70 -0
- package/docs/product_enablement.md +39 -0
- package/docs/product_tours.md +357 -0
- package/docs/project_secret_api_keys.md +444 -0
- package/docs/property_access_controls.md +200 -0
- package/docs/property_definitions.md +244 -0
- package/docs/query.md +560 -0
- package/docs/quota_limits.md +40 -0
- package/docs/reminders.md +194 -0
- package/docs/replay.md +1020 -0
- package/docs/reverse_proxy.md +200 -0
- package/docs/sandbox-custom-images.md +209 -0
- package/docs/sandbox-environments.md +168 -0
- package/docs/saved.md +392 -0
- package/docs/saved_query_column_annotations.md +224 -0
- package/docs/scheduled_changes.md +200 -0
- package/docs/schema_property_groups.md +194 -0
- package/docs/sdk_health.md +40 -0
- package/docs/session_group_summaries.md +200 -0
- package/docs/session_recordings.md +260 -0
- package/docs/session_summaries.md +200 -0
- package/docs/sessions.md +132 -0
- package/docs/signals.md +1428 -0
- package/docs/single_session_summaries.md +72 -0
- package/docs/streamlit_apps.md +456 -0
- package/docs/subscriptions.md +634 -0
- package/docs/surveys.md +731 -0
- package/docs/taggers.md +446 -0
- package/docs/task-automations.md +200 -0
- package/docs/task-runs.md +654 -0
- package/docs/task_channels.md +136 -0
- package/docs/task_mentions.md +40 -0
- package/docs/tasks.md +776 -0
- package/docs/tracing.md +1186 -0
- package/docs/uploaded_media.md +44 -0
- package/docs/user_home_settings.md +72 -0
- package/docs/user_interview_topics.md +1288 -0
- package/docs/user_interviews.md +444 -0
- package/docs/users.md +1267 -0
- package/docs/vision.md +2022 -0
- package/docs/visual_review.md +816 -0
- package/docs/warehouse_column_annotations.md +224 -0
- package/docs/warehouse_column_statistics.md +80 -0
- package/docs/warehouse_dag.md +40 -0
- package/docs/warehouse_model_paths.md +70 -0
- package/docs/warehouse_saved_queries.md +1056 -0
- package/docs/warehouse_saved_query_folders.md +318 -0
- package/docs/warehouse_tables.md +584 -0
- package/docs/warehouse_view_link.md +456 -0
- package/docs/warehouse_view_links.md +456 -0
- package/docs/web_analytics.md +136 -0
- package/docs/web_analytics_achievements.md +200 -0
- package/docs/web_experiments.md +194 -0
- package/docs/web_vitals.md +74 -0
- package/docs/wizard.md +170 -0
- package/index.ts +22 -0
- package/metadata.ts +41419 -0
- package/openapi.json +297382 -0
- package/overlay.yaml +23 -0
- package/package.json +34 -0
- package/provenance.json +24 -0
- package/research.json +80 -0
- package/types/index.ts +17547 -0
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
# Desktop File System Shortcut
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.desktopFileSystemShortcutList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system_shortcut/`
|
|
8
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
9
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
10
|
+
the default "web" surface.
|
|
11
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_list`
|
|
12
|
+
- **Path params**: None
|
|
13
|
+
- **Query params**: `limit`, `offset`
|
|
14
|
+
- **Response codes**: `200`
|
|
15
|
+
- **Transport options**: None
|
|
16
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
17
|
+
|
|
18
|
+
**Inputs**
|
|
19
|
+
|
|
20
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
21
|
+
- Client transport options: None
|
|
22
|
+
|
|
23
|
+
**Outputs**
|
|
24
|
+
|
|
25
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...`
|
|
26
|
+
- OpenAPI response codes: `200`
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import posthog from "@utdk/posthog";
|
|
30
|
+
|
|
31
|
+
type DesktopFileSystemShortcutListInput = Parameters<typeof posthog.desktopFileSystemShortcutList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
32
|
+
type DesktopFileSystemShortcutListOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutList>>;
|
|
33
|
+
|
|
34
|
+
const result: DesktopFileSystemShortcutListOutput = await posthog.desktopFileSystemShortcutList();
|
|
35
|
+
|
|
36
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `posthog.desktopFileSystemShortcutCreate`
|
|
40
|
+
|
|
41
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system_shortcut/`
|
|
42
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
43
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
44
|
+
the default "web" surface.
|
|
45
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_create`
|
|
46
|
+
- **Path params**: None
|
|
47
|
+
- **Query params**: None
|
|
48
|
+
- **Response codes**: `201`
|
|
49
|
+
- **Transport options**: None
|
|
50
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
51
|
+
|
|
52
|
+
**Inputs**
|
|
53
|
+
|
|
54
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
55
|
+
- Client transport options: None
|
|
56
|
+
|
|
57
|
+
**Outputs**
|
|
58
|
+
|
|
59
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
60
|
+
- OpenAPI response codes: `201`
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import posthog from "@utdk/posthog";
|
|
64
|
+
|
|
65
|
+
type DesktopFileSystemShortcutCreateInput = Parameters<typeof posthog.desktopFileSystemShortcutCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
66
|
+
type DesktopFileSystemShortcutCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutCreate>>;
|
|
67
|
+
|
|
68
|
+
const result: DesktopFileSystemShortcutCreateOutput = await posthog.desktopFileSystemShortcutCreate();
|
|
69
|
+
|
|
70
|
+
// Result shape (from schema): { id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### `posthog.desktopFileSystemShortcutDestroy`
|
|
74
|
+
|
|
75
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/desktop_file_system_shortcut/{id}/`
|
|
76
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
77
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
78
|
+
the default "web" surface.
|
|
79
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_destroy`
|
|
80
|
+
- **Path params**: `id`
|
|
81
|
+
- **Query params**: None
|
|
82
|
+
- **Response codes**: `204`
|
|
83
|
+
- **Transport options**: None
|
|
84
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
85
|
+
|
|
86
|
+
**Inputs**
|
|
87
|
+
|
|
88
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
89
|
+
- Client transport options: None
|
|
90
|
+
|
|
91
|
+
**Outputs**
|
|
92
|
+
|
|
93
|
+
- Client return type: `unknown`
|
|
94
|
+
- OpenAPI response codes: `204`
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
import posthog from "@utdk/posthog";
|
|
98
|
+
|
|
99
|
+
type DesktopFileSystemShortcutDestroyInput = Parameters<typeof posthog.desktopFileSystemShortcutDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
100
|
+
type DesktopFileSystemShortcutDestroyOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutDestroy>>;
|
|
101
|
+
|
|
102
|
+
const result: DesktopFileSystemShortcutDestroyOutput = await posthog.desktopFileSystemShortcutDestroy();
|
|
103
|
+
|
|
104
|
+
// Result shape (from schema): unknown
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### `posthog.desktopFileSystemShortcutRetrieve`
|
|
108
|
+
|
|
109
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system_shortcut/{id}/`
|
|
110
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
111
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
112
|
+
the default "web" surface.
|
|
113
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_retrieve`
|
|
114
|
+
- **Path params**: `id`
|
|
115
|
+
- **Query params**: None
|
|
116
|
+
- **Response codes**: `200`
|
|
117
|
+
- **Transport options**: None
|
|
118
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
119
|
+
|
|
120
|
+
**Inputs**
|
|
121
|
+
|
|
122
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
123
|
+
- Client transport options: None
|
|
124
|
+
|
|
125
|
+
**Outputs**
|
|
126
|
+
|
|
127
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
128
|
+
- OpenAPI response codes: `200`
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
import posthog from "@utdk/posthog";
|
|
132
|
+
|
|
133
|
+
type DesktopFileSystemShortcutRetrieveInput = Parameters<typeof posthog.desktopFileSystemShortcutRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
134
|
+
type DesktopFileSystemShortcutRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutRetrieve>>;
|
|
135
|
+
|
|
136
|
+
const result: DesktopFileSystemShortcutRetrieveOutput = await posthog.desktopFileSystemShortcutRetrieve();
|
|
137
|
+
|
|
138
|
+
// Result shape (from schema): { id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### `posthog.desktopFileSystemShortcutPartialUpdate`
|
|
142
|
+
|
|
143
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/desktop_file_system_shortcut/{id}/`
|
|
144
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
145
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
146
|
+
the default "web" surface.
|
|
147
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_partial_update`
|
|
148
|
+
- **Path params**: `id`
|
|
149
|
+
- **Query params**: None
|
|
150
|
+
- **Response codes**: `200`
|
|
151
|
+
- **Transport options**: None
|
|
152
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
153
|
+
|
|
154
|
+
**Inputs**
|
|
155
|
+
|
|
156
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
157
|
+
- Client transport options: None
|
|
158
|
+
|
|
159
|
+
**Outputs**
|
|
160
|
+
|
|
161
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
162
|
+
- OpenAPI response codes: `200`
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
import posthog from "@utdk/posthog";
|
|
166
|
+
|
|
167
|
+
type DesktopFileSystemShortcutPartialUpdateInput = Parameters<typeof posthog.desktopFileSystemShortcutPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
168
|
+
type DesktopFileSystemShortcutPartialUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutPartialUpdate>>;
|
|
169
|
+
|
|
170
|
+
const result: DesktopFileSystemShortcutPartialUpdateOutput = await posthog.desktopFileSystemShortcutPartialUpdate();
|
|
171
|
+
|
|
172
|
+
// Result shape (from schema): { id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### `posthog.desktopFileSystemShortcutUpdate`
|
|
176
|
+
|
|
177
|
+
- **HTTP**: `PUT /api/projects/{project_id}/desktop_file_system_shortcut/{id}/`
|
|
178
|
+
- **What it does**: Sidebar shortcuts for the desktop product surface. Reuses all FileSystemShortcutViewSet
|
|
179
|
+
behaviour but is scoped to the "desktop" surface, so its shortcuts are fully isolated from
|
|
180
|
+
the default "web" surface.
|
|
181
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_update`
|
|
182
|
+
- **Path params**: `id`
|
|
183
|
+
- **Query params**: None
|
|
184
|
+
- **Response codes**: `200`
|
|
185
|
+
- **Transport options**: None
|
|
186
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
187
|
+
|
|
188
|
+
**Inputs**
|
|
189
|
+
|
|
190
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
191
|
+
- Client transport options: None
|
|
192
|
+
|
|
193
|
+
**Outputs**
|
|
194
|
+
|
|
195
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
196
|
+
- OpenAPI response codes: `200`
|
|
197
|
+
|
|
198
|
+
```ts
|
|
199
|
+
import posthog from "@utdk/posthog";
|
|
200
|
+
|
|
201
|
+
type DesktopFileSystemShortcutUpdateInput = Parameters<typeof posthog.desktopFileSystemShortcutUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
202
|
+
type DesktopFileSystemShortcutUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutUpdate>>;
|
|
203
|
+
|
|
204
|
+
const result: DesktopFileSystemShortcutUpdateOutput = await posthog.desktopFileSystemShortcutUpdate();
|
|
205
|
+
|
|
206
|
+
// Result shape (from schema): { id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### `posthog.desktopFileSystemShortcutReorderCreate`
|
|
210
|
+
|
|
211
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system_shortcut/reorder/`
|
|
212
|
+
- **What it does**: Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected.
|
|
213
|
+
- **OpenAPI operationId**: `desktop_file_system_shortcut_reorder_create`
|
|
214
|
+
- **Path params**: None
|
|
215
|
+
- **Query params**: None
|
|
216
|
+
- **Response codes**: `200`
|
|
217
|
+
- **Transport options**: None
|
|
218
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
219
|
+
|
|
220
|
+
**Inputs**
|
|
221
|
+
|
|
222
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
223
|
+
- Client transport options: None
|
|
224
|
+
|
|
225
|
+
**Outputs**
|
|
226
|
+
|
|
227
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...`
|
|
228
|
+
- OpenAPI response codes: `200`
|
|
229
|
+
|
|
230
|
+
```ts
|
|
231
|
+
import posthog from "@utdk/posthog";
|
|
232
|
+
|
|
233
|
+
type DesktopFileSystemShortcutReorderCreateInput = Parameters<typeof posthog.desktopFileSystemShortcutReorderCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
234
|
+
type DesktopFileSystemShortcutReorderCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemShortcutReorderCreate>>;
|
|
235
|
+
|
|
236
|
+
const result: DesktopFileSystemShortcutReorderCreateOutput = await posthog.desktopFileSystemShortcutReorderCreate();
|
|
237
|
+
|
|
238
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
<!-- prompt-hash:
|
|
243
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
244
|
+
-->
|
package/docs/docs.md
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Docs
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsDocsSearch`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `POST /api/environments/{environment_id}/mcp_tools/docs_search/`
|
|
8
|
+
- **What it does**: Search PostHog documentation
|
|
9
|
+
- **OpenAPI operationId**: `environments_docs_search`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: None
|
|
12
|
+
- **Response codes**: `200`
|
|
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: `{ content: string }`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type EnvironmentsDocsSearchInput = Parameters<typeof posthog.environmentsDocsSearch> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type EnvironmentsDocsSearchOutput = Awaited<ReturnType<typeof posthog.environmentsDocsSearch>>;
|
|
31
|
+
|
|
32
|
+
const result: EnvironmentsDocsSearchOutput = await posthog.environmentsDocsSearch();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { content: string }
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.docsSearch`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/mcp_tools/docs_search/`
|
|
40
|
+
- **What it does**: Search PostHog documentation
|
|
41
|
+
- **OpenAPI operationId**: `docs_search`
|
|
42
|
+
- **Path params**: None
|
|
43
|
+
- **Query params**: None
|
|
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: `{ content: string }`
|
|
56
|
+
- OpenAPI response codes: `200`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type DocsSearchInput = Parameters<typeof posthog.docsSearch> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type DocsSearchOutput = Awaited<ReturnType<typeof posthog.docsSearch>>;
|
|
63
|
+
|
|
64
|
+
const result: DocsSearchOutput = await posthog.docsSearch();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { content: string }
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- prompt-hash:
|
|
71
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
72
|
+
-->
|
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
# Early Access Feature
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.earlyAccessFeatureList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/early_access_feature/`
|
|
8
|
+
- **OpenAPI operationId**: `early_access_feature_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; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; ...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EarlyAccessFeatureListInput = Parameters<typeof posthog.earlyAccessFeatureList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EarlyAccessFeatureListOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeatureList>>;
|
|
30
|
+
|
|
31
|
+
const result: EarlyAccessFeatureListOutput = await posthog.earlyAccessFeatureList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; ...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.earlyAccessFeatureCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/projects/{project_id}/early_access_feature/`
|
|
39
|
+
- **OpenAPI operationId**: `early_access_feature_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; stage: "draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived"; documentation_url?: string; payload?: unknown; created_at: string; feature_flag_id?:...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EarlyAccessFeatureCreateInput = Parameters<typeof posthog.earlyAccessFeatureCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EarlyAccessFeatureCreateOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeatureCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EarlyAccessFeatureCreateOutput = await posthog.earlyAccessFeatureCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; description?: string; stage: "draft" | "concept" | "alpha" | "beta" | "general-availability" | "archived"; documentation_url?: string; payload?: unknown; created_at: string; feature_flag_id?:...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.earlyAccessFeatureDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/early_access_feature/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `early_access_feature_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 EarlyAccessFeatureDestroyInput = Parameters<typeof posthog.earlyAccessFeatureDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type EarlyAccessFeatureDestroyOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeatureDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: EarlyAccessFeatureDestroyOutput = await posthog.earlyAccessFeatureDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.earlyAccessFeatureRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/projects/{project_id}/early_access_feature/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `early_access_feature_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; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type EarlyAccessFeatureRetrieveInput = Parameters<typeof posthog.earlyAccessFeatureRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type EarlyAccessFeatureRetrieveOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeatureRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: EarlyAccessFeatureRetrieveOutput = await posthog.earlyAccessFeatureRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: string; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.earlyAccessFeaturePartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/early_access_feature/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `early_access_feature_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; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type EarlyAccessFeaturePartialUpdateInput = Parameters<typeof posthog.earlyAccessFeaturePartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type EarlyAccessFeaturePartialUpdateOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeaturePartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: EarlyAccessFeaturePartialUpdateOutput = await posthog.earlyAccessFeaturePartialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: string; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.earlyAccessFeatureUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/projects/{project_id}/early_access_feature/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `early_access_feature_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; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type EarlyAccessFeatureUpdateInput = Parameters<typeof posthog.earlyAccessFeatureUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type EarlyAccessFeatureUpdateOutput = Awaited<ReturnType<typeof posthog.earlyAccessFeatureUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: EarlyAccessFeatureUpdateOutput = await posthog.earlyAccessFeatureUpdate();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: string; feature_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_experience_continuity?: boolean | null; version?: ...
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<!-- prompt-hash:
|
|
193
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
194
|
+
-->
|