@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,72 @@
|
|
|
1
|
+
# Single Session Summaries
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.singleSessionSummariesList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/single_session_summaries/`
|
|
8
|
+
- **What it does**: List stored AI-generated session summaries for the team, one row per session (latest summary kept). Use to discover which sessions have been summarized and to filter for sessions with specific problems — `has_exceptions=true`, `outcome=failure`, or a custom `session_ids` narrowing. Returns lightweight rows without the full summary JSON; use the retrieve endpoint for the per-segment / per-action detail.
|
|
9
|
+
- **OpenAPI operationId**: `single_session_summaries_list`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `created_by`, `date_from`, `date_to`, `distinct_id`, `has_exceptions`, `has_visual_confirmation`, `limit`, `offset`, `order`, `outcome`, `session_ids`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; session_id: string; distinct_id: string | null; session_start_time: string | null; session_duration: number | null; session_outcom...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type SingleSessionSummariesListInput = Parameters<typeof posthog.singleSessionSummariesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type SingleSessionSummariesListOutput = Awaited<ReturnType<typeof posthog.singleSessionSummariesList>>;
|
|
31
|
+
|
|
32
|
+
const result: SingleSessionSummariesListOutput = await posthog.singleSessionSummariesList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; session_id: string; distinct_id: string | null; session_start_time: string | null; session_duration: number | null; session_outcom...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.singleSessionSummariesRetrieve`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `GET /api/projects/{project_id}/single_session_summaries/{session_id}/`
|
|
40
|
+
- **What it does**: Get the latest stored AI summary for a single session by `session_id`. Returns the full `summary` JSON (segments with named timeline, per-action `abandonment` / `confusion` / `exception` flags, segment outcomes, headline `session_outcome`, optional `sentiment`), the `exception_event_ids` array, the `extra_summary_context` (e.g. `focus_area`) used at generation time, and the `run_metadata` (LLM model used, whether visual confirmation was applied). 404 if no summary has been generated for this session yet — to trigger generation, use the existing `session-recording-summarize` flow rather than this endpoint.
|
|
41
|
+
- **OpenAPI operationId**: `single_session_summaries_retrieve`
|
|
42
|
+
- **Path params**: `session_id`
|
|
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: `{ id: string; session_id: string; distinct_id: string | null; session_start_time: string | null; session_duration: number | null; summary: { [key: string]: unknown }; exception_event_ids: (string)[]; extra_summary_conte...`
|
|
56
|
+
- OpenAPI response codes: `200`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type SingleSessionSummariesRetrieveInput = Parameters<typeof posthog.singleSessionSummariesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type SingleSessionSummariesRetrieveOutput = Awaited<ReturnType<typeof posthog.singleSessionSummariesRetrieve>>;
|
|
63
|
+
|
|
64
|
+
const result: SingleSessionSummariesRetrieveOutput = await posthog.singleSessionSummariesRetrieve();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { id: string; session_id: string; distinct_id: string | null; session_start_time: string | null; session_duration: number | null; summary: { [key: string]: unknown }; exception_event_ids: (string)[]; extra_summary_conte...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- prompt-hash:
|
|
71
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
72
|
+
-->
|
|
@@ -0,0 +1,456 @@
|
|
|
1
|
+
# Streamlit Apps
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.streamlitAppsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/streamlit_apps/`
|
|
8
|
+
- **What it does**: List streamlit apps
|
|
9
|
+
- **OpenAPI operationId**: `streamlit_apps_list`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `limit`, `offset`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: ...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type StreamlitAppsListInput = Parameters<typeof posthog.streamlitAppsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type StreamlitAppsListOutput = Awaited<ReturnType<typeof posthog.streamlitAppsList>>;
|
|
31
|
+
|
|
32
|
+
const result: StreamlitAppsListOutput = await posthog.streamlitAppsList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: ...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.streamlitAppsCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/`
|
|
40
|
+
- **What it does**: Create a streamlit app
|
|
41
|
+
- **OpenAPI operationId**: `streamlit_apps_create`
|
|
42
|
+
- **Path params**: None
|
|
43
|
+
- **Query params**: None
|
|
44
|
+
- **Response codes**: `201`
|
|
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: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
56
|
+
- OpenAPI response codes: `201`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type StreamlitAppsCreateInput = Parameters<typeof posthog.streamlitAppsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type StreamlitAppsCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: StreamlitAppsCreateOutput = await posthog.streamlitAppsCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.streamlitAppsDestroy`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/streamlit_apps/{short_id}/`
|
|
72
|
+
- **What it does**: Delete a streamlit app
|
|
73
|
+
- **OpenAPI operationId**: `streamlit_apps_destroy`
|
|
74
|
+
- **Path params**: `short_id`
|
|
75
|
+
- **Query params**: None
|
|
76
|
+
- **Response codes**: `204`
|
|
77
|
+
- **Transport options**: None
|
|
78
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
79
|
+
|
|
80
|
+
**Inputs**
|
|
81
|
+
|
|
82
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
83
|
+
- Client transport options: None
|
|
84
|
+
|
|
85
|
+
**Outputs**
|
|
86
|
+
|
|
87
|
+
- Client return type: `unknown`
|
|
88
|
+
- OpenAPI response codes: `204`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type StreamlitAppsDestroyInput = Parameters<typeof posthog.streamlitAppsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type StreamlitAppsDestroyOutput = Awaited<ReturnType<typeof posthog.streamlitAppsDestroy>>;
|
|
95
|
+
|
|
96
|
+
const result: StreamlitAppsDestroyOutput = await posthog.streamlitAppsDestroy();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): unknown
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.streamlitAppsRetrieve`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `GET /api/projects/{project_id}/streamlit_apps/{short_id}/`
|
|
104
|
+
- **What it does**: Retrieve a streamlit app
|
|
105
|
+
- **OpenAPI operationId**: `streamlit_apps_retrieve`
|
|
106
|
+
- **Path params**: `short_id`
|
|
107
|
+
- **Query params**: None
|
|
108
|
+
- **Response codes**: `200`
|
|
109
|
+
- **Transport options**: None
|
|
110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
111
|
+
|
|
112
|
+
**Inputs**
|
|
113
|
+
|
|
114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
115
|
+
- Client transport options: None
|
|
116
|
+
|
|
117
|
+
**Outputs**
|
|
118
|
+
|
|
119
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
120
|
+
- OpenAPI response codes: `200`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type StreamlitAppsRetrieveInput = Parameters<typeof posthog.streamlitAppsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type StreamlitAppsRetrieveOutput = Awaited<ReturnType<typeof posthog.streamlitAppsRetrieve>>;
|
|
127
|
+
|
|
128
|
+
const result: StreamlitAppsRetrieveOutput = await posthog.streamlitAppsRetrieve();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.streamlitAppsPartialUpdate`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/streamlit_apps/{short_id}/`
|
|
136
|
+
- **What it does**: Partially update a streamlit app
|
|
137
|
+
- **OpenAPI operationId**: `streamlit_apps_partial_update`
|
|
138
|
+
- **Path params**: `short_id`
|
|
139
|
+
- **Query params**: None
|
|
140
|
+
- **Response codes**: `200`
|
|
141
|
+
- **Transport options**: None
|
|
142
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
143
|
+
|
|
144
|
+
**Inputs**
|
|
145
|
+
|
|
146
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
147
|
+
- Client transport options: None
|
|
148
|
+
|
|
149
|
+
**Outputs**
|
|
150
|
+
|
|
151
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
152
|
+
- OpenAPI response codes: `200`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type StreamlitAppsPartialUpdateInput = Parameters<typeof posthog.streamlitAppsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type StreamlitAppsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsPartialUpdate>>;
|
|
159
|
+
|
|
160
|
+
const result: StreamlitAppsPartialUpdateOutput = await posthog.streamlitAppsPartialUpdate();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.streamlitAppsUpdate`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `PUT /api/projects/{project_id}/streamlit_apps/{short_id}/`
|
|
168
|
+
- **What it does**: Update a streamlit app
|
|
169
|
+
- **OpenAPI operationId**: `streamlit_apps_update`
|
|
170
|
+
- **Path params**: `short_id`
|
|
171
|
+
- **Query params**: None
|
|
172
|
+
- **Response codes**: `200`
|
|
173
|
+
- **Transport options**: None
|
|
174
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
175
|
+
|
|
176
|
+
**Inputs**
|
|
177
|
+
|
|
178
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
179
|
+
- Client transport options: None
|
|
180
|
+
|
|
181
|
+
**Outputs**
|
|
182
|
+
|
|
183
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
184
|
+
- OpenAPI response codes: `200`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type StreamlitAppsUpdateInput = Parameters<typeof posthog.streamlitAppsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type StreamlitAppsUpdateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsUpdate>>;
|
|
191
|
+
|
|
192
|
+
const result: StreamlitAppsUpdateOutput = await posthog.streamlitAppsUpdate();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### `posthog.streamlitAppsActivateVersionCreate`
|
|
198
|
+
|
|
199
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/{short_id}/activate_version/`
|
|
200
|
+
- **What it does**: Activate an existing app version
|
|
201
|
+
- **OpenAPI operationId**: `streamlit_apps_activate_version_create`
|
|
202
|
+
- **Path params**: `short_id`
|
|
203
|
+
- **Query params**: None
|
|
204
|
+
- **Response codes**: `200`
|
|
205
|
+
- **Transport options**: None
|
|
206
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
207
|
+
|
|
208
|
+
**Inputs**
|
|
209
|
+
|
|
210
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
211
|
+
- Client transport options: None
|
|
212
|
+
|
|
213
|
+
**Outputs**
|
|
214
|
+
|
|
215
|
+
- Client return type: `{ active_version: { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown...`
|
|
216
|
+
- OpenAPI response codes: `200`
|
|
217
|
+
|
|
218
|
+
```ts
|
|
219
|
+
import posthog from "@utdk/posthog";
|
|
220
|
+
|
|
221
|
+
type StreamlitAppsActivateVersionCreateInput = Parameters<typeof posthog.streamlitAppsActivateVersionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
222
|
+
type StreamlitAppsActivateVersionCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsActivateVersionCreate>>;
|
|
223
|
+
|
|
224
|
+
const result: StreamlitAppsActivateVersionCreateOutput = await posthog.streamlitAppsActivateVersionCreate();
|
|
225
|
+
|
|
226
|
+
// Result shape (from schema): { active_version: { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown...
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### `posthog.streamlitAppsConnectInfoRetrieve`
|
|
230
|
+
|
|
231
|
+
- **HTTP**: `GET /api/projects/{project_id}/streamlit_apps/{short_id}/connect_info/`
|
|
232
|
+
- **What it does**: Get iframe connection info for a running app
|
|
233
|
+
- **OpenAPI operationId**: `streamlit_apps_connect_info_retrieve`
|
|
234
|
+
- **Path params**: `short_id`
|
|
235
|
+
- **Query params**: None
|
|
236
|
+
- **Response codes**: `200`
|
|
237
|
+
- **Transport options**: None
|
|
238
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
239
|
+
|
|
240
|
+
**Inputs**
|
|
241
|
+
|
|
242
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
243
|
+
- Client transport options: None
|
|
244
|
+
|
|
245
|
+
**Outputs**
|
|
246
|
+
|
|
247
|
+
- Client return type: `{ iframe_url: string; expires_in: number }`
|
|
248
|
+
- OpenAPI response codes: `200`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type StreamlitAppsConnectInfoRetrieveInput = Parameters<typeof posthog.streamlitAppsConnectInfoRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type StreamlitAppsConnectInfoRetrieveOutput = Awaited<ReturnType<typeof posthog.streamlitAppsConnectInfoRetrieve>>;
|
|
255
|
+
|
|
256
|
+
const result: StreamlitAppsConnectInfoRetrieveOutput = await posthog.streamlitAppsConnectInfoRetrieve();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): { iframe_url: string; expires_in: number }
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.streamlitAppsRestartCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/{short_id}/restart/`
|
|
264
|
+
- **What it does**: Restart the app sandbox
|
|
265
|
+
- **OpenAPI operationId**: `streamlit_apps_restart_create`
|
|
266
|
+
- **Path params**: `short_id`
|
|
267
|
+
- **Query params**: None
|
|
268
|
+
- **Response codes**: `202`
|
|
269
|
+
- **Transport options**: None
|
|
270
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
271
|
+
|
|
272
|
+
**Inputs**
|
|
273
|
+
|
|
274
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
275
|
+
- Client transport options: None
|
|
276
|
+
|
|
277
|
+
**Outputs**
|
|
278
|
+
|
|
279
|
+
- Client return type: `unknown`
|
|
280
|
+
- OpenAPI response codes: `202`
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import posthog from "@utdk/posthog";
|
|
284
|
+
|
|
285
|
+
type StreamlitAppsRestartCreateInput = Parameters<typeof posthog.streamlitAppsRestartCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type StreamlitAppsRestartCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsRestartCreate>>;
|
|
287
|
+
|
|
288
|
+
const result: StreamlitAppsRestartCreateOutput = await posthog.streamlitAppsRestartCreate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): unknown
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.streamlitAppsStartCreate`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/{short_id}/start/`
|
|
296
|
+
- **What it does**: Start the app sandbox
|
|
297
|
+
- **OpenAPI operationId**: `streamlit_apps_start_create`
|
|
298
|
+
- **Path params**: `short_id`
|
|
299
|
+
- **Query params**: None
|
|
300
|
+
- **Response codes**: `200`, `202`
|
|
301
|
+
- **Transport options**: None
|
|
302
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
303
|
+
|
|
304
|
+
**Inputs**
|
|
305
|
+
|
|
306
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
307
|
+
- Client transport options: None
|
|
308
|
+
|
|
309
|
+
**Outputs**
|
|
310
|
+
|
|
311
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
312
|
+
- OpenAPI response codes: `200`, `202`
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import posthog from "@utdk/posthog";
|
|
316
|
+
|
|
317
|
+
type StreamlitAppsStartCreateInput = Parameters<typeof posthog.streamlitAppsStartCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
318
|
+
type StreamlitAppsStartCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsStartCreate>>;
|
|
319
|
+
|
|
320
|
+
const result: StreamlitAppsStartCreateOutput = await posthog.streamlitAppsStartCreate();
|
|
321
|
+
|
|
322
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### `posthog.streamlitAppsStatusRetrieve`
|
|
326
|
+
|
|
327
|
+
- **HTTP**: `GET /api/projects/{project_id}/streamlit_apps/{short_id}/status/`
|
|
328
|
+
- **What it does**: Get app sandbox status
|
|
329
|
+
- **OpenAPI operationId**: `streamlit_apps_status_retrieve`
|
|
330
|
+
- **Path params**: `short_id`
|
|
331
|
+
- **Query params**: None
|
|
332
|
+
- **Response codes**: `200`
|
|
333
|
+
- **Transport options**: None
|
|
334
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
335
|
+
|
|
336
|
+
**Inputs**
|
|
337
|
+
|
|
338
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
339
|
+
- Client transport options: None
|
|
340
|
+
|
|
341
|
+
**Outputs**
|
|
342
|
+
|
|
343
|
+
- Client return type: `{ status: string; restart_count: number; last_error: string; started_at: string | null; last_activity_at: string | null; version_number?: number | null }`
|
|
344
|
+
- OpenAPI response codes: `200`
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
import posthog from "@utdk/posthog";
|
|
348
|
+
|
|
349
|
+
type StreamlitAppsStatusRetrieveInput = Parameters<typeof posthog.streamlitAppsStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
350
|
+
type StreamlitAppsStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.streamlitAppsStatusRetrieve>>;
|
|
351
|
+
|
|
352
|
+
const result: StreamlitAppsStatusRetrieveOutput = await posthog.streamlitAppsStatusRetrieve();
|
|
353
|
+
|
|
354
|
+
// Result shape (from schema): { status: string; restart_count: number; last_error: string; started_at: string | null; last_activity_at: string | null; version_number?: number | null }
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `posthog.streamlitAppsStopCreate`
|
|
358
|
+
|
|
359
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/{short_id}/stop/`
|
|
360
|
+
- **What it does**: Stop the app sandbox
|
|
361
|
+
- **OpenAPI operationId**: `streamlit_apps_stop_create`
|
|
362
|
+
- **Path params**: `short_id`
|
|
363
|
+
- **Query params**: None
|
|
364
|
+
- **Response codes**: `200`
|
|
365
|
+
- **Transport options**: None
|
|
366
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
367
|
+
|
|
368
|
+
**Inputs**
|
|
369
|
+
|
|
370
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
371
|
+
- Client transport options: None
|
|
372
|
+
|
|
373
|
+
**Outputs**
|
|
374
|
+
|
|
375
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
376
|
+
- OpenAPI response codes: `200`
|
|
377
|
+
|
|
378
|
+
```ts
|
|
379
|
+
import posthog from "@utdk/posthog";
|
|
380
|
+
|
|
381
|
+
type StreamlitAppsStopCreateInput = Parameters<typeof posthog.streamlitAppsStopCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
382
|
+
type StreamlitAppsStopCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsStopCreate>>;
|
|
383
|
+
|
|
384
|
+
const result: StreamlitAppsStopCreateOutput = await posthog.streamlitAppsStopCreate();
|
|
385
|
+
|
|
386
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### `posthog.streamlitAppsUploadVersionCreate`
|
|
390
|
+
|
|
391
|
+
- **HTTP**: `POST /api/projects/{project_id}/streamlit_apps/{short_id}/upload_version/`
|
|
392
|
+
- **What it does**: Upload a new app version
|
|
393
|
+
- **OpenAPI operationId**: `streamlit_apps_upload_version_create`
|
|
394
|
+
- **Path params**: `short_id`
|
|
395
|
+
- **Query params**: None
|
|
396
|
+
- **Response codes**: `201`
|
|
397
|
+
- **Transport options**: None
|
|
398
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
399
|
+
|
|
400
|
+
**Inputs**
|
|
401
|
+
|
|
402
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
403
|
+
- Client transport options: None
|
|
404
|
+
|
|
405
|
+
**Outputs**
|
|
406
|
+
|
|
407
|
+
- Client return type: `{ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...`
|
|
408
|
+
- OpenAPI response codes: `201`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type StreamlitAppsUploadVersionCreateInput = Parameters<typeof posthog.streamlitAppsUploadVersionCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type StreamlitAppsUploadVersionCreateOutput = Awaited<ReturnType<typeof posthog.streamlitAppsUploadVersionCreate>>;
|
|
415
|
+
|
|
416
|
+
const result: StreamlitAppsUploadVersionCreateOutput = await posthog.streamlitAppsUploadVersionCreate();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): { created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | null; role_at...
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.streamlitAppsVersionsRetrieve`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `GET /api/projects/{project_id}/streamlit_apps/{short_id}/versions/`
|
|
424
|
+
- **What it does**: List app versions
|
|
425
|
+
- **OpenAPI operationId**: `streamlit_apps_versions_retrieve`
|
|
426
|
+
- **Path params**: `short_id`
|
|
427
|
+
- **Query params**: None
|
|
428
|
+
- **Response codes**: `200`
|
|
429
|
+
- **Transport options**: None
|
|
430
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
431
|
+
|
|
432
|
+
**Inputs**
|
|
433
|
+
|
|
434
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
435
|
+
- Client transport options: None
|
|
436
|
+
|
|
437
|
+
**Outputs**
|
|
438
|
+
|
|
439
|
+
- Client return type: `{ results: ({ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | n...`
|
|
440
|
+
- OpenAPI response codes: `200`
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import posthog from "@utdk/posthog";
|
|
444
|
+
|
|
445
|
+
type StreamlitAppsVersionsRetrieveInput = Parameters<typeof posthog.streamlitAppsVersionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
446
|
+
type StreamlitAppsVersionsRetrieveOutput = Awaited<ReturnType<typeof posthog.streamlitAppsVersionsRetrieve>>;
|
|
447
|
+
|
|
448
|
+
const result: StreamlitAppsVersionsRetrieveOutput = await posthog.streamlitAppsVersionsRetrieve();
|
|
449
|
+
|
|
450
|
+
// Result shape (from schema): { results: ({ created_by?: { id: number; uuid: string; distinct_id: string | null; first_name: string; last_name: string; email: string; is_email_verified: boolean | null; hedgehog_config: { [key: string]: unknown } | n...
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
<!-- prompt-hash:
|
|
455
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
456
|
+
-->
|