@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,753 @@
|
|
|
1
|
+
# Desktop File System
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.desktopFileSystemList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/`
|
|
8
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
9
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
10
|
+
|
|
11
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
12
|
+
- **OpenAPI operationId**: `desktop_file_system_list`
|
|
13
|
+
- **Path params**: None
|
|
14
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
15
|
+
- **Response codes**: `200`
|
|
16
|
+
- **Transport options**: None
|
|
17
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
18
|
+
|
|
19
|
+
**Inputs**
|
|
20
|
+
|
|
21
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
22
|
+
- Client transport options: None
|
|
23
|
+
|
|
24
|
+
**Outputs**
|
|
25
|
+
|
|
26
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean |...`
|
|
27
|
+
- OpenAPI response codes: `200`
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import posthog from "@utdk/posthog";
|
|
31
|
+
|
|
32
|
+
type DesktopFileSystemListInput = Parameters<typeof posthog.desktopFileSystemList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
33
|
+
type DesktopFileSystemListOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemList>>;
|
|
34
|
+
|
|
35
|
+
const result: DesktopFileSystemListOutput = await posthog.desktopFileSystemList();
|
|
36
|
+
|
|
37
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean |...
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### `posthog.desktopFileSystemCreate`
|
|
41
|
+
|
|
42
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/`
|
|
43
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
44
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
45
|
+
|
|
46
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
47
|
+
- **OpenAPI operationId**: `desktop_file_system_create`
|
|
48
|
+
- **Path params**: None
|
|
49
|
+
- **Query params**: None
|
|
50
|
+
- **Response codes**: `201`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
53
|
+
|
|
54
|
+
**Inputs**
|
|
55
|
+
|
|
56
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
57
|
+
- Client transport options: None
|
|
58
|
+
|
|
59
|
+
**Outputs**
|
|
60
|
+
|
|
61
|
+
- Client return type: `{ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...`
|
|
62
|
+
- OpenAPI response codes: `201`
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
import posthog from "@utdk/posthog";
|
|
66
|
+
|
|
67
|
+
type DesktopFileSystemCreateInput = Parameters<typeof posthog.desktopFileSystemCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
68
|
+
type DesktopFileSystemCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemCreate>>;
|
|
69
|
+
|
|
70
|
+
const result: DesktopFileSystemCreateOutput = await posthog.desktopFileSystemCreate();
|
|
71
|
+
|
|
72
|
+
// Result shape (from schema): { id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### `posthog.desktopFileSystemDestroy`
|
|
76
|
+
|
|
77
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/desktop_file_system/{id}/`
|
|
78
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
79
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
80
|
+
|
|
81
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
82
|
+
- **OpenAPI operationId**: `desktop_file_system_destroy`
|
|
83
|
+
- **Path params**: `id`
|
|
84
|
+
- **Query params**: None
|
|
85
|
+
- **Response codes**: `204`
|
|
86
|
+
- **Transport options**: None
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `unknown`
|
|
97
|
+
- OpenAPI response codes: `204`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import posthog from "@utdk/posthog";
|
|
101
|
+
|
|
102
|
+
type DesktopFileSystemDestroyInput = Parameters<typeof posthog.desktopFileSystemDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type DesktopFileSystemDestroyOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemDestroy>>;
|
|
104
|
+
|
|
105
|
+
const result: DesktopFileSystemDestroyOutput = await posthog.desktopFileSystemDestroy();
|
|
106
|
+
|
|
107
|
+
// Result shape (from schema): unknown
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### `posthog.desktopFileSystemRetrieve`
|
|
111
|
+
|
|
112
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/{id}/`
|
|
113
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
114
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
115
|
+
|
|
116
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
117
|
+
- **OpenAPI operationId**: `desktop_file_system_retrieve`
|
|
118
|
+
- **Path params**: `id`
|
|
119
|
+
- **Query params**: None
|
|
120
|
+
- **Response codes**: `200`
|
|
121
|
+
- **Transport options**: None
|
|
122
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
123
|
+
|
|
124
|
+
**Inputs**
|
|
125
|
+
|
|
126
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
127
|
+
- Client transport options: None
|
|
128
|
+
|
|
129
|
+
**Outputs**
|
|
130
|
+
|
|
131
|
+
- Client return type: `{ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...`
|
|
132
|
+
- OpenAPI response codes: `200`
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
import posthog from "@utdk/posthog";
|
|
136
|
+
|
|
137
|
+
type DesktopFileSystemRetrieveInput = Parameters<typeof posthog.desktopFileSystemRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
138
|
+
type DesktopFileSystemRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemRetrieve>>;
|
|
139
|
+
|
|
140
|
+
const result: DesktopFileSystemRetrieveOutput = await posthog.desktopFileSystemRetrieve();
|
|
141
|
+
|
|
142
|
+
// Result shape (from schema): { id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### `posthog.desktopFileSystemPartialUpdate`
|
|
146
|
+
|
|
147
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/desktop_file_system/{id}/`
|
|
148
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
149
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
150
|
+
|
|
151
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
152
|
+
- **OpenAPI operationId**: `desktop_file_system_partial_update`
|
|
153
|
+
- **Path params**: `id`
|
|
154
|
+
- **Query params**: None
|
|
155
|
+
- **Response codes**: `200`
|
|
156
|
+
- **Transport options**: None
|
|
157
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
158
|
+
|
|
159
|
+
**Inputs**
|
|
160
|
+
|
|
161
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
162
|
+
- Client transport options: None
|
|
163
|
+
|
|
164
|
+
**Outputs**
|
|
165
|
+
|
|
166
|
+
- Client return type: `{ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...`
|
|
167
|
+
- OpenAPI response codes: `200`
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
import posthog from "@utdk/posthog";
|
|
171
|
+
|
|
172
|
+
type DesktopFileSystemPartialUpdateInput = Parameters<typeof posthog.desktopFileSystemPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
173
|
+
type DesktopFileSystemPartialUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemPartialUpdate>>;
|
|
174
|
+
|
|
175
|
+
const result: DesktopFileSystemPartialUpdateOutput = await posthog.desktopFileSystemPartialUpdate();
|
|
176
|
+
|
|
177
|
+
// Result shape (from schema): { id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### `posthog.desktopFileSystemUpdate`
|
|
181
|
+
|
|
182
|
+
- **HTTP**: `PUT /api/projects/{project_id}/desktop_file_system/{id}/`
|
|
183
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
184
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
185
|
+
|
|
186
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
187
|
+
- **OpenAPI operationId**: `desktop_file_system_update`
|
|
188
|
+
- **Path params**: `id`
|
|
189
|
+
- **Query params**: None
|
|
190
|
+
- **Response codes**: `200`
|
|
191
|
+
- **Transport options**: None
|
|
192
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
193
|
+
|
|
194
|
+
**Inputs**
|
|
195
|
+
|
|
196
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
197
|
+
- Client transport options: None
|
|
198
|
+
|
|
199
|
+
**Outputs**
|
|
200
|
+
|
|
201
|
+
- Client return type: `{ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...`
|
|
202
|
+
- OpenAPI response codes: `200`
|
|
203
|
+
|
|
204
|
+
```ts
|
|
205
|
+
import posthog from "@utdk/posthog";
|
|
206
|
+
|
|
207
|
+
type DesktopFileSystemUpdateInput = Parameters<typeof posthog.desktopFileSystemUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
208
|
+
type DesktopFileSystemUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemUpdate>>;
|
|
209
|
+
|
|
210
|
+
const result: DesktopFileSystemUpdateOutput = await posthog.desktopFileSystemUpdate();
|
|
211
|
+
|
|
212
|
+
// Result shape (from schema): { id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### `posthog.desktopFileSystemCanvasPartialUpdate`
|
|
216
|
+
|
|
217
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/desktop_file_system/{id}/canvas/`
|
|
218
|
+
- **What it does**: Publish a new version of a freeform canvas's React source.
|
|
219
|
+
|
|
220
|
+
Merges into the dashboard row's `meta` (never replaces it), so existing
|
|
221
|
+
keys like `channelId`/`templateId` survive. Appends a full-file version
|
|
222
|
+
snapshot and points `currentVersionId` at it — the server-side mirror of
|
|
223
|
+
the app's dashboardsService.saveFreeform.
|
|
224
|
+
- **OpenAPI operationId**: `desktop_file_system_canvas_partial_update`
|
|
225
|
+
- **Path params**: `id`
|
|
226
|
+
- **Query params**: None
|
|
227
|
+
- **Response codes**: `200`
|
|
228
|
+
- **Transport options**: None
|
|
229
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
230
|
+
|
|
231
|
+
**Inputs**
|
|
232
|
+
|
|
233
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
234
|
+
- Client transport options: None
|
|
235
|
+
|
|
236
|
+
**Outputs**
|
|
237
|
+
|
|
238
|
+
- Client return type: `{ id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...`
|
|
239
|
+
- OpenAPI response codes: `200`
|
|
240
|
+
|
|
241
|
+
```ts
|
|
242
|
+
import posthog from "@utdk/posthog";
|
|
243
|
+
|
|
244
|
+
type DesktopFileSystemCanvasPartialUpdateInput = Parameters<typeof posthog.desktopFileSystemCanvasPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
245
|
+
type DesktopFileSystemCanvasPartialUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemCanvasPartialUpdate>>;
|
|
246
|
+
|
|
247
|
+
const result: DesktopFileSystemCanvasPartialUpdateOutput = await posthog.desktopFileSystemCanvasPartialUpdate();
|
|
248
|
+
|
|
249
|
+
// Result shape (from schema): { id: string; path: string; depth: number | null; type?: string; ref?: string | null; href?: string | null; meta?: unknown; shortcut?: boolean | null; created_at: string; last_viewed_at: string | null; user_access_level...
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### `posthog.desktopFileSystemContextGenerationRetrieve`
|
|
253
|
+
|
|
254
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/{id}/context_generation/`
|
|
255
|
+
- **What it does**: Return the Task currently generating this folder's CONTEXT.md, or null if none.
|
|
256
|
+
- **OpenAPI operationId**: `desktop_file_system_context_generation_retrieve`
|
|
257
|
+
- **Path params**: `id`
|
|
258
|
+
- **Query params**: None
|
|
259
|
+
- **Response codes**: `200`
|
|
260
|
+
- **Transport options**: None
|
|
261
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
262
|
+
|
|
263
|
+
**Inputs**
|
|
264
|
+
|
|
265
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
266
|
+
- Client transport options: None
|
|
267
|
+
|
|
268
|
+
**Outputs**
|
|
269
|
+
|
|
270
|
+
- Client return type: `{ task_id: string | null }`
|
|
271
|
+
- OpenAPI response codes: `200`
|
|
272
|
+
|
|
273
|
+
```ts
|
|
274
|
+
import posthog from "@utdk/posthog";
|
|
275
|
+
|
|
276
|
+
type DesktopFileSystemContextGenerationRetrieveInput = Parameters<typeof posthog.desktopFileSystemContextGenerationRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
277
|
+
type DesktopFileSystemContextGenerationRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemContextGenerationRetrieve>>;
|
|
278
|
+
|
|
279
|
+
const result: DesktopFileSystemContextGenerationRetrieveOutput = await posthog.desktopFileSystemContextGenerationRetrieve();
|
|
280
|
+
|
|
281
|
+
// Result shape (from schema): { task_id: string | null }
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### `posthog.desktopFileSystemContextGenerationUpdate`
|
|
285
|
+
|
|
286
|
+
- **HTTP**: `PUT /api/projects/{project_id}/desktop_file_system/{id}/context_generation/`
|
|
287
|
+
- **What it does**: Set or clear the Task associated with this folder's CONTEXT.md generation.
|
|
288
|
+
- **OpenAPI operationId**: `desktop_file_system_context_generation_update`
|
|
289
|
+
- **Path params**: `id`
|
|
290
|
+
- **Query params**: None
|
|
291
|
+
- **Response codes**: `200`
|
|
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: `{ task_id: string | null }`
|
|
303
|
+
- OpenAPI response codes: `200`
|
|
304
|
+
|
|
305
|
+
```ts
|
|
306
|
+
import posthog from "@utdk/posthog";
|
|
307
|
+
|
|
308
|
+
type DesktopFileSystemContextGenerationUpdateInput = Parameters<typeof posthog.desktopFileSystemContextGenerationUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
309
|
+
type DesktopFileSystemContextGenerationUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemContextGenerationUpdate>>;
|
|
310
|
+
|
|
311
|
+
const result: DesktopFileSystemContextGenerationUpdateOutput = await posthog.desktopFileSystemContextGenerationUpdate();
|
|
312
|
+
|
|
313
|
+
// Result shape (from schema): { task_id: string | null }
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### `posthog.desktopFileSystemCountCreate`
|
|
317
|
+
|
|
318
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/{id}/count/`
|
|
319
|
+
- **What it does**: Get count of all files in a folder.
|
|
320
|
+
- **OpenAPI operationId**: `desktop_file_system_count_create`
|
|
321
|
+
- **Path params**: `id`
|
|
322
|
+
- **Query params**: None
|
|
323
|
+
- **Response codes**: `200`
|
|
324
|
+
- **Transport options**: None
|
|
325
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
326
|
+
|
|
327
|
+
**Inputs**
|
|
328
|
+
|
|
329
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
330
|
+
- Client transport options: None
|
|
331
|
+
|
|
332
|
+
**Outputs**
|
|
333
|
+
|
|
334
|
+
- Client return type: `unknown`
|
|
335
|
+
- OpenAPI response codes: `200`
|
|
336
|
+
|
|
337
|
+
```ts
|
|
338
|
+
import posthog from "@utdk/posthog";
|
|
339
|
+
|
|
340
|
+
type DesktopFileSystemCountCreateInput = Parameters<typeof posthog.desktopFileSystemCountCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
341
|
+
type DesktopFileSystemCountCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemCountCreate>>;
|
|
342
|
+
|
|
343
|
+
const result: DesktopFileSystemCountCreateOutput = await posthog.desktopFileSystemCountCreate();
|
|
344
|
+
|
|
345
|
+
// Result shape (from schema): unknown
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### `posthog.desktopFileSystemInstructionsDestroy`
|
|
349
|
+
|
|
350
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/desktop_file_system/{id}/instructions/`
|
|
351
|
+
- **What it does**: Soft-delete every version of this folder's instructions.
|
|
352
|
+
- **OpenAPI operationId**: `desktop_file_system_instructions_destroy`
|
|
353
|
+
- **Path params**: `id`
|
|
354
|
+
- **Query params**: None
|
|
355
|
+
- **Response codes**: `204`
|
|
356
|
+
- **Transport options**: None
|
|
357
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
358
|
+
|
|
359
|
+
**Inputs**
|
|
360
|
+
|
|
361
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
362
|
+
- Client transport options: None
|
|
363
|
+
|
|
364
|
+
**Outputs**
|
|
365
|
+
|
|
366
|
+
- Client return type: `unknown`
|
|
367
|
+
- OpenAPI response codes: `204`
|
|
368
|
+
|
|
369
|
+
```ts
|
|
370
|
+
import posthog from "@utdk/posthog";
|
|
371
|
+
|
|
372
|
+
type DesktopFileSystemInstructionsDestroyInput = Parameters<typeof posthog.desktopFileSystemInstructionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
373
|
+
type DesktopFileSystemInstructionsDestroyOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemInstructionsDestroy>>;
|
|
374
|
+
|
|
375
|
+
const result: DesktopFileSystemInstructionsDestroyOutput = await posthog.desktopFileSystemInstructionsDestroy();
|
|
376
|
+
|
|
377
|
+
// Result shape (from schema): unknown
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
### `posthog.desktopFileSystemInstructionsRetrieve`
|
|
381
|
+
|
|
382
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/{id}/instructions/`
|
|
383
|
+
- **What it does**: Return the latest non-deleted instructions for this folder.
|
|
384
|
+
- **OpenAPI operationId**: `desktop_file_system_instructions_retrieve`
|
|
385
|
+
- **Path params**: `id`
|
|
386
|
+
- **Query params**: None
|
|
387
|
+
- **Response codes**: `200`
|
|
388
|
+
- **Transport options**: None
|
|
389
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
390
|
+
|
|
391
|
+
**Inputs**
|
|
392
|
+
|
|
393
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
394
|
+
- Client transport options: None
|
|
395
|
+
|
|
396
|
+
**Outputs**
|
|
397
|
+
|
|
398
|
+
- Client return type: `{ id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...`
|
|
399
|
+
- OpenAPI response codes: `200`
|
|
400
|
+
|
|
401
|
+
```ts
|
|
402
|
+
import posthog from "@utdk/posthog";
|
|
403
|
+
|
|
404
|
+
type DesktopFileSystemInstructionsRetrieveInput = Parameters<typeof posthog.desktopFileSystemInstructionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
405
|
+
type DesktopFileSystemInstructionsRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemInstructionsRetrieve>>;
|
|
406
|
+
|
|
407
|
+
const result: DesktopFileSystemInstructionsRetrieveOutput = await posthog.desktopFileSystemInstructionsRetrieve();
|
|
408
|
+
|
|
409
|
+
// Result shape (from schema): { id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...
|
|
410
|
+
```
|
|
411
|
+
|
|
412
|
+
### `posthog.desktopFileSystemInstructionsPartialUpdate`
|
|
413
|
+
|
|
414
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/desktop_file_system/{id}/instructions/`
|
|
415
|
+
- **What it does**: Publish a new version of the folder's instructions.
|
|
416
|
+
- **OpenAPI operationId**: `desktop_file_system_instructions_partial_update`
|
|
417
|
+
- **Path params**: `id`
|
|
418
|
+
- **Query params**: None
|
|
419
|
+
- **Response codes**: `200`
|
|
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: `{ id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...`
|
|
431
|
+
- OpenAPI response codes: `200`
|
|
432
|
+
|
|
433
|
+
```ts
|
|
434
|
+
import posthog from "@utdk/posthog";
|
|
435
|
+
|
|
436
|
+
type DesktopFileSystemInstructionsPartialUpdateInput = Parameters<typeof posthog.desktopFileSystemInstructionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
437
|
+
type DesktopFileSystemInstructionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemInstructionsPartialUpdate>>;
|
|
438
|
+
|
|
439
|
+
const result: DesktopFileSystemInstructionsPartialUpdateOutput = await posthog.desktopFileSystemInstructionsPartialUpdate();
|
|
440
|
+
|
|
441
|
+
// Result shape (from schema): { id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### `posthog.desktopFileSystemInstructionsUpdate`
|
|
445
|
+
|
|
446
|
+
- **HTTP**: `PUT /api/projects/{project_id}/desktop_file_system/{id}/instructions/`
|
|
447
|
+
- **What it does**: Publish a new version of the folder's instructions.
|
|
448
|
+
- **OpenAPI operationId**: `desktop_file_system_instructions_update`
|
|
449
|
+
- **Path params**: `id`
|
|
450
|
+
- **Query params**: None
|
|
451
|
+
- **Response codes**: `200`
|
|
452
|
+
- **Transport options**: None
|
|
453
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
454
|
+
|
|
455
|
+
**Inputs**
|
|
456
|
+
|
|
457
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
458
|
+
- Client transport options: None
|
|
459
|
+
|
|
460
|
+
**Outputs**
|
|
461
|
+
|
|
462
|
+
- Client return type: `{ id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...`
|
|
463
|
+
- OpenAPI response codes: `200`
|
|
464
|
+
|
|
465
|
+
```ts
|
|
466
|
+
import posthog from "@utdk/posthog";
|
|
467
|
+
|
|
468
|
+
type DesktopFileSystemInstructionsUpdateInput = Parameters<typeof posthog.desktopFileSystemInstructionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
469
|
+
type DesktopFileSystemInstructionsUpdateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemInstructionsUpdate>>;
|
|
470
|
+
|
|
471
|
+
const result: DesktopFileSystemInstructionsUpdateOutput = await posthog.desktopFileSystemInstructionsUpdate();
|
|
472
|
+
|
|
473
|
+
// Result shape (from schema): { id: string; content: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolea...
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
### `posthog.desktopFileSystemInstructionsVersionsList`
|
|
477
|
+
|
|
478
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/{id}/instructions/versions/`
|
|
479
|
+
- **What it does**: List the version history for this folder's instructions, newest first.
|
|
480
|
+
- **OpenAPI operationId**: `desktop_file_system_instructions_versions_list`
|
|
481
|
+
- **Path params**: `id`
|
|
482
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
483
|
+
- **Response codes**: `200`
|
|
484
|
+
- **Transport options**: None
|
|
485
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
486
|
+
|
|
487
|
+
**Inputs**
|
|
488
|
+
|
|
489
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
490
|
+
- Client transport options: None
|
|
491
|
+
|
|
492
|
+
**Outputs**
|
|
493
|
+
|
|
494
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; las...`
|
|
495
|
+
- OpenAPI response codes: `200`
|
|
496
|
+
|
|
497
|
+
```ts
|
|
498
|
+
import posthog from "@utdk/posthog";
|
|
499
|
+
|
|
500
|
+
type DesktopFileSystemInstructionsVersionsListInput = Parameters<typeof posthog.desktopFileSystemInstructionsVersionsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
501
|
+
type DesktopFileSystemInstructionsVersionsListOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemInstructionsVersionsList>>;
|
|
502
|
+
|
|
503
|
+
const result: DesktopFileSystemInstructionsVersionsListOutput = await posthog.desktopFileSystemInstructionsVersionsList();
|
|
504
|
+
|
|
505
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; version: number; is_latest: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; las...
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
### `posthog.desktopFileSystemLinkCreate`
|
|
509
|
+
|
|
510
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/{id}/link/`
|
|
511
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
512
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
513
|
+
|
|
514
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
515
|
+
- **OpenAPI operationId**: `desktop_file_system_link_create`
|
|
516
|
+
- **Path params**: `id`
|
|
517
|
+
- **Query params**: None
|
|
518
|
+
- **Response codes**: `200`
|
|
519
|
+
- **Transport options**: None
|
|
520
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
521
|
+
|
|
522
|
+
**Inputs**
|
|
523
|
+
|
|
524
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
525
|
+
- Client transport options: None
|
|
526
|
+
|
|
527
|
+
**Outputs**
|
|
528
|
+
|
|
529
|
+
- Client return type: `unknown`
|
|
530
|
+
- OpenAPI response codes: `200`
|
|
531
|
+
|
|
532
|
+
```ts
|
|
533
|
+
import posthog from "@utdk/posthog";
|
|
534
|
+
|
|
535
|
+
type DesktopFileSystemLinkCreateInput = Parameters<typeof posthog.desktopFileSystemLinkCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
536
|
+
type DesktopFileSystemLinkCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemLinkCreate>>;
|
|
537
|
+
|
|
538
|
+
const result: DesktopFileSystemLinkCreateOutput = await posthog.desktopFileSystemLinkCreate();
|
|
539
|
+
|
|
540
|
+
// Result shape (from schema): unknown
|
|
541
|
+
```
|
|
542
|
+
|
|
543
|
+
### `posthog.desktopFileSystemMoveCreate`
|
|
544
|
+
|
|
545
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/{id}/move/`
|
|
546
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
547
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
548
|
+
|
|
549
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
550
|
+
- **OpenAPI operationId**: `desktop_file_system_move_create`
|
|
551
|
+
- **Path params**: `id`
|
|
552
|
+
- **Query params**: None
|
|
553
|
+
- **Response codes**: `200`
|
|
554
|
+
- **Transport options**: None
|
|
555
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
556
|
+
|
|
557
|
+
**Inputs**
|
|
558
|
+
|
|
559
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
560
|
+
- Client transport options: None
|
|
561
|
+
|
|
562
|
+
**Outputs**
|
|
563
|
+
|
|
564
|
+
- Client return type: `unknown`
|
|
565
|
+
- OpenAPI response codes: `200`
|
|
566
|
+
|
|
567
|
+
```ts
|
|
568
|
+
import posthog from "@utdk/posthog";
|
|
569
|
+
|
|
570
|
+
type DesktopFileSystemMoveCreateInput = Parameters<typeof posthog.desktopFileSystemMoveCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
571
|
+
type DesktopFileSystemMoveCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemMoveCreate>>;
|
|
572
|
+
|
|
573
|
+
const result: DesktopFileSystemMoveCreateOutput = await posthog.desktopFileSystemMoveCreate();
|
|
574
|
+
|
|
575
|
+
// Result shape (from schema): unknown
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### `posthog.desktopFileSystemCountByPathCreate`
|
|
579
|
+
|
|
580
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/count_by_path/`
|
|
581
|
+
- **What it does**: Get count of all files in a folder.
|
|
582
|
+
- **OpenAPI operationId**: `desktop_file_system_count_by_path_create`
|
|
583
|
+
- **Path params**: None
|
|
584
|
+
- **Query params**: None
|
|
585
|
+
- **Response codes**: `200`
|
|
586
|
+
- **Transport options**: None
|
|
587
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
588
|
+
|
|
589
|
+
**Inputs**
|
|
590
|
+
|
|
591
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
592
|
+
- Client transport options: None
|
|
593
|
+
|
|
594
|
+
**Outputs**
|
|
595
|
+
|
|
596
|
+
- Client return type: `unknown`
|
|
597
|
+
- OpenAPI response codes: `200`
|
|
598
|
+
|
|
599
|
+
```ts
|
|
600
|
+
import posthog from "@utdk/posthog";
|
|
601
|
+
|
|
602
|
+
type DesktopFileSystemCountByPathCreateInput = Parameters<typeof posthog.desktopFileSystemCountByPathCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
603
|
+
type DesktopFileSystemCountByPathCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemCountByPathCreate>>;
|
|
604
|
+
|
|
605
|
+
const result: DesktopFileSystemCountByPathCreateOutput = await posthog.desktopFileSystemCountByPathCreate();
|
|
606
|
+
|
|
607
|
+
// Result shape (from schema): unknown
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
### `posthog.desktopFileSystemLogViewRetrieve`
|
|
611
|
+
|
|
612
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/log_view/`
|
|
613
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
614
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
615
|
+
|
|
616
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
617
|
+
- **OpenAPI operationId**: `desktop_file_system_log_view_retrieve`
|
|
618
|
+
- **Path params**: None
|
|
619
|
+
- **Query params**: None
|
|
620
|
+
- **Response codes**: `200`
|
|
621
|
+
- **Transport options**: None
|
|
622
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
623
|
+
|
|
624
|
+
**Inputs**
|
|
625
|
+
|
|
626
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
627
|
+
- Client transport options: None
|
|
628
|
+
|
|
629
|
+
**Outputs**
|
|
630
|
+
|
|
631
|
+
- Client return type: `unknown`
|
|
632
|
+
- OpenAPI response codes: `200`
|
|
633
|
+
|
|
634
|
+
```ts
|
|
635
|
+
import posthog from "@utdk/posthog";
|
|
636
|
+
|
|
637
|
+
type DesktopFileSystemLogViewRetrieveInput = Parameters<typeof posthog.desktopFileSystemLogViewRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
638
|
+
type DesktopFileSystemLogViewRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemLogViewRetrieve>>;
|
|
639
|
+
|
|
640
|
+
const result: DesktopFileSystemLogViewRetrieveOutput = await posthog.desktopFileSystemLogViewRetrieve();
|
|
641
|
+
|
|
642
|
+
// Result shape (from schema): unknown
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### `posthog.desktopFileSystemLogViewCreate`
|
|
646
|
+
|
|
647
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/log_view/`
|
|
648
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
649
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
650
|
+
|
|
651
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
652
|
+
- **OpenAPI operationId**: `desktop_file_system_log_view_create`
|
|
653
|
+
- **Path params**: None
|
|
654
|
+
- **Query params**: None
|
|
655
|
+
- **Response codes**: `200`
|
|
656
|
+
- **Transport options**: None
|
|
657
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
658
|
+
|
|
659
|
+
**Inputs**
|
|
660
|
+
|
|
661
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
662
|
+
- Client transport options: None
|
|
663
|
+
|
|
664
|
+
**Outputs**
|
|
665
|
+
|
|
666
|
+
- Client return type: `unknown`
|
|
667
|
+
- OpenAPI response codes: `200`
|
|
668
|
+
|
|
669
|
+
```ts
|
|
670
|
+
import posthog from "@utdk/posthog";
|
|
671
|
+
|
|
672
|
+
type DesktopFileSystemLogViewCreateInput = Parameters<typeof posthog.desktopFileSystemLogViewCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
673
|
+
type DesktopFileSystemLogViewCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemLogViewCreate>>;
|
|
674
|
+
|
|
675
|
+
const result: DesktopFileSystemLogViewCreateOutput = await posthog.desktopFileSystemLogViewCreate();
|
|
676
|
+
|
|
677
|
+
// Result shape (from schema): unknown
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
### `posthog.desktopFileSystemUndoDeleteCreate`
|
|
681
|
+
|
|
682
|
+
- **HTTP**: `POST /api/projects/{project_id}/desktop_file_system/undo_delete/`
|
|
683
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
684
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
685
|
+
|
|
686
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
687
|
+
- **OpenAPI operationId**: `desktop_file_system_undo_delete_create`
|
|
688
|
+
- **Path params**: None
|
|
689
|
+
- **Query params**: None
|
|
690
|
+
- **Response codes**: `200`
|
|
691
|
+
- **Transport options**: None
|
|
692
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
693
|
+
|
|
694
|
+
**Inputs**
|
|
695
|
+
|
|
696
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
697
|
+
- Client transport options: None
|
|
698
|
+
|
|
699
|
+
**Outputs**
|
|
700
|
+
|
|
701
|
+
- Client return type: `unknown`
|
|
702
|
+
- OpenAPI response codes: `200`
|
|
703
|
+
|
|
704
|
+
```ts
|
|
705
|
+
import posthog from "@utdk/posthog";
|
|
706
|
+
|
|
707
|
+
type DesktopFileSystemUndoDeleteCreateInput = Parameters<typeof posthog.desktopFileSystemUndoDeleteCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
708
|
+
type DesktopFileSystemUndoDeleteCreateOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemUndoDeleteCreate>>;
|
|
709
|
+
|
|
710
|
+
const result: DesktopFileSystemUndoDeleteCreateOutput = await posthog.desktopFileSystemUndoDeleteCreate();
|
|
711
|
+
|
|
712
|
+
// Result shape (from schema): unknown
|
|
713
|
+
```
|
|
714
|
+
|
|
715
|
+
### `posthog.desktopFileSystemUnfiledRetrieve`
|
|
716
|
+
|
|
717
|
+
- **HTTP**: `GET /api/projects/{project_id}/desktop_file_system/unfiled/`
|
|
718
|
+
- **What it does**: The file tree for the desktop product surface. Reuses all FileSystemViewSet behaviour but is
|
|
719
|
+
scoped to the "desktop" surface, so its tree is fully isolated from the default "web" tree.
|
|
720
|
+
|
|
721
|
+
Adds per-folder, versioned markdown instructions describing the contents of a folder.
|
|
722
|
+
- **OpenAPI operationId**: `desktop_file_system_unfiled_retrieve`
|
|
723
|
+
- **Path params**: None
|
|
724
|
+
- **Query params**: None
|
|
725
|
+
- **Response codes**: `200`
|
|
726
|
+
- **Transport options**: None
|
|
727
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
728
|
+
|
|
729
|
+
**Inputs**
|
|
730
|
+
|
|
731
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
732
|
+
- Client transport options: None
|
|
733
|
+
|
|
734
|
+
**Outputs**
|
|
735
|
+
|
|
736
|
+
- Client return type: `unknown`
|
|
737
|
+
- OpenAPI response codes: `200`
|
|
738
|
+
|
|
739
|
+
```ts
|
|
740
|
+
import posthog from "@utdk/posthog";
|
|
741
|
+
|
|
742
|
+
type DesktopFileSystemUnfiledRetrieveInput = Parameters<typeof posthog.desktopFileSystemUnfiledRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
743
|
+
type DesktopFileSystemUnfiledRetrieveOutput = Awaited<ReturnType<typeof posthog.desktopFileSystemUnfiledRetrieve>>;
|
|
744
|
+
|
|
745
|
+
const result: DesktopFileSystemUnfiledRetrieveOutput = await posthog.desktopFileSystemUnfiledRetrieve();
|
|
746
|
+
|
|
747
|
+
// Result shape (from schema): unknown
|
|
748
|
+
```
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
<!-- prompt-hash:
|
|
752
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
753
|
+
-->
|