@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,444 @@
|
|
|
1
|
+
# File System Shortcut
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsFileSystemShortcutList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_system_shortcut/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsFileSystemShortcutListInput = Parameters<typeof posthog.environmentsFileSystemShortcutList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsFileSystemShortcutListOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsFileSystemShortcutListOutput = await posthog.environmentsFileSystemShortcutList();
|
|
32
|
+
|
|
33
|
+
// 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...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.environmentsFileSystemShortcutCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/environments/{environment_id}/file_system_shortcut/`
|
|
39
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EnvironmentsFileSystemShortcutCreateInput = Parameters<typeof posthog.environmentsFileSystemShortcutCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EnvironmentsFileSystemShortcutCreateOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EnvironmentsFileSystemShortcutCreateOutput = await posthog.environmentsFileSystemShortcutCreate();
|
|
63
|
+
|
|
64
|
+
// 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 }
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.environmentsFileSystemShortcutDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/file_system_shortcut/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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 EnvironmentsFileSystemShortcutDestroyInput = Parameters<typeof posthog.environmentsFileSystemShortcutDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type EnvironmentsFileSystemShortcutDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: EnvironmentsFileSystemShortcutDestroyOutput = await posthog.environmentsFileSystemShortcutDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.environmentsFileSystemShortcutRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/environments/{environment_id}/file_system_shortcut/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type EnvironmentsFileSystemShortcutRetrieveInput = Parameters<typeof posthog.environmentsFileSystemShortcutRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type EnvironmentsFileSystemShortcutRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: EnvironmentsFileSystemShortcutRetrieveOutput = await posthog.environmentsFileSystemShortcutRetrieve();
|
|
125
|
+
|
|
126
|
+
// 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 }
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.environmentsFileSystemShortcutPartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/file_system_shortcut/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type EnvironmentsFileSystemShortcutPartialUpdateInput = Parameters<typeof posthog.environmentsFileSystemShortcutPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type EnvironmentsFileSystemShortcutPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutPartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: EnvironmentsFileSystemShortcutPartialUpdateOutput = await posthog.environmentsFileSystemShortcutPartialUpdate();
|
|
156
|
+
|
|
157
|
+
// 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 }
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.environmentsFileSystemShortcutUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/file_system_shortcut/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_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; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type EnvironmentsFileSystemShortcutUpdateInput = Parameters<typeof posthog.environmentsFileSystemShortcutUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type EnvironmentsFileSystemShortcutUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: EnvironmentsFileSystemShortcutUpdateOutput = await posthog.environmentsFileSystemShortcutUpdate();
|
|
187
|
+
|
|
188
|
+
// 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 }
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### `posthog.environmentsFileSystemShortcutReorderCreate`
|
|
192
|
+
|
|
193
|
+
- **HTTP**: `POST /api/environments/{environment_id}/file_system_shortcut/reorder/`
|
|
194
|
+
- **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.
|
|
195
|
+
- **OpenAPI operationId**: `environments_file_system_shortcut_reorder_create`
|
|
196
|
+
- **Path params**: None
|
|
197
|
+
- **Query params**: None
|
|
198
|
+
- **Response codes**: `200`
|
|
199
|
+
- **Transport options**: None
|
|
200
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
201
|
+
|
|
202
|
+
**Inputs**
|
|
203
|
+
|
|
204
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
205
|
+
- Client transport options: None
|
|
206
|
+
|
|
207
|
+
**Outputs**
|
|
208
|
+
|
|
209
|
+
- Client return type: `{ 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...`
|
|
210
|
+
- OpenAPI response codes: `200`
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import posthog from "@utdk/posthog";
|
|
214
|
+
|
|
215
|
+
type EnvironmentsFileSystemShortcutReorderCreateInput = Parameters<typeof posthog.environmentsFileSystemShortcutReorderCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
216
|
+
type EnvironmentsFileSystemShortcutReorderCreateOutput = Awaited<ReturnType<typeof posthog.environmentsFileSystemShortcutReorderCreate>>;
|
|
217
|
+
|
|
218
|
+
const result: EnvironmentsFileSystemShortcutReorderCreateOutput = await posthog.environmentsFileSystemShortcutReorderCreate();
|
|
219
|
+
|
|
220
|
+
// 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...
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### `posthog.fileSystemShortcutList`
|
|
224
|
+
|
|
225
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_system_shortcut/`
|
|
226
|
+
- **OpenAPI operationId**: `file_system_shortcut_list`
|
|
227
|
+
- **Path params**: None
|
|
228
|
+
- **Query params**: `limit`, `offset`
|
|
229
|
+
- **Response codes**: `200`
|
|
230
|
+
- **Transport options**: None
|
|
231
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
232
|
+
|
|
233
|
+
**Inputs**
|
|
234
|
+
|
|
235
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
236
|
+
- Client transport options: None
|
|
237
|
+
|
|
238
|
+
**Outputs**
|
|
239
|
+
|
|
240
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: str...`
|
|
241
|
+
- OpenAPI response codes: `200`
|
|
242
|
+
|
|
243
|
+
```ts
|
|
244
|
+
import posthog from "@utdk/posthog";
|
|
245
|
+
|
|
246
|
+
type FileSystemShortcutListInput = Parameters<typeof posthog.fileSystemShortcutList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
247
|
+
type FileSystemShortcutListOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutList>>;
|
|
248
|
+
|
|
249
|
+
const result: FileSystemShortcutListOutput = await posthog.fileSystemShortcutList();
|
|
250
|
+
|
|
251
|
+
// 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...
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### `posthog.fileSystemShortcutCreate`
|
|
255
|
+
|
|
256
|
+
- **HTTP**: `POST /api/projects/{project_id}/file_system_shortcut/`
|
|
257
|
+
- **OpenAPI operationId**: `file_system_shortcut_create`
|
|
258
|
+
- **Path params**: None
|
|
259
|
+
- **Query params**: None
|
|
260
|
+
- **Response codes**: `201`
|
|
261
|
+
- **Transport options**: None
|
|
262
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
263
|
+
|
|
264
|
+
**Inputs**
|
|
265
|
+
|
|
266
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
267
|
+
- Client transport options: None
|
|
268
|
+
|
|
269
|
+
**Outputs**
|
|
270
|
+
|
|
271
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
272
|
+
- OpenAPI response codes: `201`
|
|
273
|
+
|
|
274
|
+
```ts
|
|
275
|
+
import posthog from "@utdk/posthog";
|
|
276
|
+
|
|
277
|
+
type FileSystemShortcutCreateInput = Parameters<typeof posthog.fileSystemShortcutCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
278
|
+
type FileSystemShortcutCreateOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutCreate>>;
|
|
279
|
+
|
|
280
|
+
const result: FileSystemShortcutCreateOutput = await posthog.fileSystemShortcutCreate();
|
|
281
|
+
|
|
282
|
+
// 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 }
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### `posthog.fileSystemShortcutDestroy`
|
|
286
|
+
|
|
287
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/file_system_shortcut/{id}/`
|
|
288
|
+
- **OpenAPI operationId**: `file_system_shortcut_destroy`
|
|
289
|
+
- **Path params**: `id`
|
|
290
|
+
- **Query params**: None
|
|
291
|
+
- **Response codes**: `204`
|
|
292
|
+
- **Transport options**: None
|
|
293
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
294
|
+
|
|
295
|
+
**Inputs**
|
|
296
|
+
|
|
297
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
298
|
+
- Client transport options: None
|
|
299
|
+
|
|
300
|
+
**Outputs**
|
|
301
|
+
|
|
302
|
+
- Client return type: `unknown`
|
|
303
|
+
- OpenAPI response codes: `204`
|
|
304
|
+
|
|
305
|
+
```ts
|
|
306
|
+
import posthog from "@utdk/posthog";
|
|
307
|
+
|
|
308
|
+
type FileSystemShortcutDestroyInput = Parameters<typeof posthog.fileSystemShortcutDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
309
|
+
type FileSystemShortcutDestroyOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutDestroy>>;
|
|
310
|
+
|
|
311
|
+
const result: FileSystemShortcutDestroyOutput = await posthog.fileSystemShortcutDestroy();
|
|
312
|
+
|
|
313
|
+
// Result shape (from schema): unknown
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### `posthog.fileSystemShortcutRetrieve`
|
|
317
|
+
|
|
318
|
+
- **HTTP**: `GET /api/projects/{project_id}/file_system_shortcut/{id}/`
|
|
319
|
+
- **OpenAPI operationId**: `file_system_shortcut_retrieve`
|
|
320
|
+
- **Path params**: `id`
|
|
321
|
+
- **Query params**: None
|
|
322
|
+
- **Response codes**: `200`
|
|
323
|
+
- **Transport options**: None
|
|
324
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
325
|
+
|
|
326
|
+
**Inputs**
|
|
327
|
+
|
|
328
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
329
|
+
- Client transport options: None
|
|
330
|
+
|
|
331
|
+
**Outputs**
|
|
332
|
+
|
|
333
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
334
|
+
- OpenAPI response codes: `200`
|
|
335
|
+
|
|
336
|
+
```ts
|
|
337
|
+
import posthog from "@utdk/posthog";
|
|
338
|
+
|
|
339
|
+
type FileSystemShortcutRetrieveInput = Parameters<typeof posthog.fileSystemShortcutRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
340
|
+
type FileSystemShortcutRetrieveOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutRetrieve>>;
|
|
341
|
+
|
|
342
|
+
const result: FileSystemShortcutRetrieveOutput = await posthog.fileSystemShortcutRetrieve();
|
|
343
|
+
|
|
344
|
+
// 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 }
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
### `posthog.fileSystemShortcutPartialUpdate`
|
|
348
|
+
|
|
349
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/file_system_shortcut/{id}/`
|
|
350
|
+
- **OpenAPI operationId**: `file_system_shortcut_partial_update`
|
|
351
|
+
- **Path params**: `id`
|
|
352
|
+
- **Query params**: None
|
|
353
|
+
- **Response codes**: `200`
|
|
354
|
+
- **Transport options**: None
|
|
355
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
356
|
+
|
|
357
|
+
**Inputs**
|
|
358
|
+
|
|
359
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
360
|
+
- Client transport options: None
|
|
361
|
+
|
|
362
|
+
**Outputs**
|
|
363
|
+
|
|
364
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
365
|
+
- OpenAPI response codes: `200`
|
|
366
|
+
|
|
367
|
+
```ts
|
|
368
|
+
import posthog from "@utdk/posthog";
|
|
369
|
+
|
|
370
|
+
type FileSystemShortcutPartialUpdateInput = Parameters<typeof posthog.fileSystemShortcutPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
371
|
+
type FileSystemShortcutPartialUpdateOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutPartialUpdate>>;
|
|
372
|
+
|
|
373
|
+
const result: FileSystemShortcutPartialUpdateOutput = await posthog.fileSystemShortcutPartialUpdate();
|
|
374
|
+
|
|
375
|
+
// 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 }
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### `posthog.fileSystemShortcutUpdate`
|
|
379
|
+
|
|
380
|
+
- **HTTP**: `PUT /api/projects/{project_id}/file_system_shortcut/{id}/`
|
|
381
|
+
- **OpenAPI operationId**: `file_system_shortcut_update`
|
|
382
|
+
- **Path params**: `id`
|
|
383
|
+
- **Query params**: None
|
|
384
|
+
- **Response codes**: `200`
|
|
385
|
+
- **Transport options**: None
|
|
386
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
387
|
+
|
|
388
|
+
**Inputs**
|
|
389
|
+
|
|
390
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
391
|
+
- Client transport options: None
|
|
392
|
+
|
|
393
|
+
**Outputs**
|
|
394
|
+
|
|
395
|
+
- Client return type: `{ id: string; path: string; type?: string; ref?: string | null; href?: string | null; order?: number; created_at: string; user_access_level: string | null }`
|
|
396
|
+
- OpenAPI response codes: `200`
|
|
397
|
+
|
|
398
|
+
```ts
|
|
399
|
+
import posthog from "@utdk/posthog";
|
|
400
|
+
|
|
401
|
+
type FileSystemShortcutUpdateInput = Parameters<typeof posthog.fileSystemShortcutUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
402
|
+
type FileSystemShortcutUpdateOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutUpdate>>;
|
|
403
|
+
|
|
404
|
+
const result: FileSystemShortcutUpdateOutput = await posthog.fileSystemShortcutUpdate();
|
|
405
|
+
|
|
406
|
+
// 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 }
|
|
407
|
+
```
|
|
408
|
+
|
|
409
|
+
### `posthog.fileSystemShortcutReorderCreate`
|
|
410
|
+
|
|
411
|
+
- **HTTP**: `POST /api/projects/{project_id}/file_system_shortcut/reorder/`
|
|
412
|
+
- **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.
|
|
413
|
+
- **OpenAPI operationId**: `file_system_shortcut_reorder_create`
|
|
414
|
+
- **Path params**: None
|
|
415
|
+
- **Query params**: None
|
|
416
|
+
- **Response codes**: `200`
|
|
417
|
+
- **Transport options**: None
|
|
418
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
419
|
+
|
|
420
|
+
**Inputs**
|
|
421
|
+
|
|
422
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
423
|
+
- Client transport options: None
|
|
424
|
+
|
|
425
|
+
**Outputs**
|
|
426
|
+
|
|
427
|
+
- Client return type: `{ 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...`
|
|
428
|
+
- OpenAPI response codes: `200`
|
|
429
|
+
|
|
430
|
+
```ts
|
|
431
|
+
import posthog from "@utdk/posthog";
|
|
432
|
+
|
|
433
|
+
type FileSystemShortcutReorderCreateInput = Parameters<typeof posthog.fileSystemShortcutReorderCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
434
|
+
type FileSystemShortcutReorderCreateOutput = Awaited<ReturnType<typeof posthog.fileSystemShortcutReorderCreate>>;
|
|
435
|
+
|
|
436
|
+
const result: FileSystemShortcutReorderCreateOutput = await posthog.fileSystemShortcutReorderCreate();
|
|
437
|
+
|
|
438
|
+
// 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...
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<!-- prompt-hash:
|
|
443
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
444
|
+
-->
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Flag Value
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.flagValueValuesRetrieve`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/flag_value/values/`
|
|
8
|
+
- **What it does**: Get possible values for a feature flag.
|
|
9
|
+
|
|
10
|
+
Query parameters:
|
|
11
|
+
- key: The flag ID (required)
|
|
12
|
+
Returns:
|
|
13
|
+
|
|
14
|
+
- Array of objects with 'name' field containing possible values
|
|
15
|
+
- **OpenAPI operationId**: `flag_value_values_retrieve`
|
|
16
|
+
- **Path params**: None
|
|
17
|
+
- **Query params**: `key`
|
|
18
|
+
- **Response codes**: `200`, `400`, `404`
|
|
19
|
+
- **Transport options**: None
|
|
20
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
21
|
+
|
|
22
|
+
**Inputs**
|
|
23
|
+
|
|
24
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
25
|
+
- Client transport options: None
|
|
26
|
+
|
|
27
|
+
**Outputs**
|
|
28
|
+
|
|
29
|
+
- Client return type: `{ results: ({ name: unknown })[]; refreshing: boolean }`
|
|
30
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import posthog from "@utdk/posthog";
|
|
34
|
+
|
|
35
|
+
type FlagValueValuesRetrieveInput = Parameters<typeof posthog.flagValueValuesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
36
|
+
type FlagValueValuesRetrieveOutput = Awaited<ReturnType<typeof posthog.flagValueValuesRetrieve>>;
|
|
37
|
+
|
|
38
|
+
const result: FlagValueValuesRetrieveOutput = await posthog.flagValueValuesRetrieve();
|
|
39
|
+
|
|
40
|
+
// Result shape (from schema): { results: ({ name: unknown })[]; refreshing: boolean }
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
<!-- prompt-hash:
|
|
45
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
46
|
+
-->
|