@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,584 @@
|
|
|
1
|
+
# Warehouse Tables
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsWarehouseTablesList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/warehouse_tables/`
|
|
8
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
9
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_list`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
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; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; c...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type EnvironmentsWarehouseTablesListInput = Parameters<typeof posthog.environmentsWarehouseTablesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type EnvironmentsWarehouseTablesListOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesList>>;
|
|
31
|
+
|
|
32
|
+
const result: EnvironmentsWarehouseTablesListOutput = await posthog.environmentsWarehouseTablesList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; c...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.environmentsWarehouseTablesCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/environments/{environment_id}/warehouse_tables/`
|
|
40
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
41
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
56
|
+
- OpenAPI response codes: `201`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type EnvironmentsWarehouseTablesCreateInput = Parameters<typeof posthog.environmentsWarehouseTablesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type EnvironmentsWarehouseTablesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: EnvironmentsWarehouseTablesCreateOutput = await posthog.environmentsWarehouseTablesCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.environmentsWarehouseTablesDestroy`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/warehouse_tables/{id}/`
|
|
72
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
73
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_destroy`
|
|
74
|
+
- **Path params**: `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 EnvironmentsWarehouseTablesDestroyInput = Parameters<typeof posthog.environmentsWarehouseTablesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type EnvironmentsWarehouseTablesDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesDestroy>>;
|
|
95
|
+
|
|
96
|
+
const result: EnvironmentsWarehouseTablesDestroyOutput = await posthog.environmentsWarehouseTablesDestroy();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): unknown
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.environmentsWarehouseTablesRetrieve`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `GET /api/environments/{environment_id}/warehouse_tables/{id}/`
|
|
104
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
105
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_retrieve`
|
|
106
|
+
- **Path params**: `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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
120
|
+
- OpenAPI response codes: `200`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type EnvironmentsWarehouseTablesRetrieveInput = Parameters<typeof posthog.environmentsWarehouseTablesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type EnvironmentsWarehouseTablesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesRetrieve>>;
|
|
127
|
+
|
|
128
|
+
const result: EnvironmentsWarehouseTablesRetrieveOutput = await posthog.environmentsWarehouseTablesRetrieve();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.environmentsWarehouseTablesPartialUpdate`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/warehouse_tables/{id}/`
|
|
136
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
137
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_partial_update`
|
|
138
|
+
- **Path params**: `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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
152
|
+
- OpenAPI response codes: `200`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type EnvironmentsWarehouseTablesPartialUpdateInput = Parameters<typeof posthog.environmentsWarehouseTablesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type EnvironmentsWarehouseTablesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesPartialUpdate>>;
|
|
159
|
+
|
|
160
|
+
const result: EnvironmentsWarehouseTablesPartialUpdateOutput = await posthog.environmentsWarehouseTablesPartialUpdate();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.environmentsWarehouseTablesUpdate`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/warehouse_tables/{id}/`
|
|
168
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
169
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_update`
|
|
170
|
+
- **Path params**: `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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
184
|
+
- OpenAPI response codes: `200`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type EnvironmentsWarehouseTablesUpdateInput = Parameters<typeof posthog.environmentsWarehouseTablesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type EnvironmentsWarehouseTablesUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesUpdate>>;
|
|
191
|
+
|
|
192
|
+
const result: EnvironmentsWarehouseTablesUpdateOutput = await posthog.environmentsWarehouseTablesUpdate();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### `posthog.environmentsWarehouseTablesRefreshSchemaCreate`
|
|
198
|
+
|
|
199
|
+
- **HTTP**: `POST /api/environments/{environment_id}/warehouse_tables/{id}/refresh_schema/`
|
|
200
|
+
- **What it does**: Refresh table schema from source
|
|
201
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_refresh_schema_create`
|
|
202
|
+
- **Path params**: `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: `unknown`
|
|
216
|
+
- OpenAPI response codes: `200`
|
|
217
|
+
|
|
218
|
+
```ts
|
|
219
|
+
import posthog from "@utdk/posthog";
|
|
220
|
+
|
|
221
|
+
type EnvironmentsWarehouseTablesRefreshSchemaCreateInput = Parameters<typeof posthog.environmentsWarehouseTablesRefreshSchemaCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
222
|
+
type EnvironmentsWarehouseTablesRefreshSchemaCreateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesRefreshSchemaCreate>>;
|
|
223
|
+
|
|
224
|
+
const result: EnvironmentsWarehouseTablesRefreshSchemaCreateOutput = await posthog.environmentsWarehouseTablesRefreshSchemaCreate();
|
|
225
|
+
|
|
226
|
+
// Result shape (from schema): unknown
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### `posthog.environmentsWarehouseTablesUpdateSchemaCreate`
|
|
230
|
+
|
|
231
|
+
- **HTTP**: `POST /api/environments/{environment_id}/warehouse_tables/{id}/update_schema/`
|
|
232
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
233
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_update_schema_create`
|
|
234
|
+
- **Path params**: `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: `unknown`
|
|
248
|
+
- OpenAPI response codes: `200`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type EnvironmentsWarehouseTablesUpdateSchemaCreateInput = Parameters<typeof posthog.environmentsWarehouseTablesUpdateSchemaCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type EnvironmentsWarehouseTablesUpdateSchemaCreateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesUpdateSchemaCreate>>;
|
|
255
|
+
|
|
256
|
+
const result: EnvironmentsWarehouseTablesUpdateSchemaCreateOutput = await posthog.environmentsWarehouseTablesUpdateSchemaCreate();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): unknown
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.environmentsWarehouseTablesFileCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/environments/{environment_id}/warehouse_tables/file/`
|
|
264
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
265
|
+
- **OpenAPI operationId**: `environments_warehouse_tables_file_create`
|
|
266
|
+
- **Path params**: None
|
|
267
|
+
- **Query params**: None
|
|
268
|
+
- **Response codes**: `200`
|
|
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: `200`
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import posthog from "@utdk/posthog";
|
|
284
|
+
|
|
285
|
+
type EnvironmentsWarehouseTablesFileCreateInput = Parameters<typeof posthog.environmentsWarehouseTablesFileCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type EnvironmentsWarehouseTablesFileCreateOutput = Awaited<ReturnType<typeof posthog.environmentsWarehouseTablesFileCreate>>;
|
|
287
|
+
|
|
288
|
+
const result: EnvironmentsWarehouseTablesFileCreateOutput = await posthog.environmentsWarehouseTablesFileCreate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): unknown
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.warehouseTablesList`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_tables/`
|
|
296
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
297
|
+
- **OpenAPI operationId**: `warehouse_tables_list`
|
|
298
|
+
- **Path params**: None
|
|
299
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
300
|
+
- **Response codes**: `200`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; c...`
|
|
312
|
+
- OpenAPI response codes: `200`
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import posthog from "@utdk/posthog";
|
|
316
|
+
|
|
317
|
+
type WarehouseTablesListInput = Parameters<typeof posthog.warehouseTablesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
318
|
+
type WarehouseTablesListOutput = Awaited<ReturnType<typeof posthog.warehouseTablesList>>;
|
|
319
|
+
|
|
320
|
+
const result: WarehouseTablesListOutput = await posthog.warehouseTablesList();
|
|
321
|
+
|
|
322
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; c...
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### `posthog.warehouseTablesCreate`
|
|
326
|
+
|
|
327
|
+
- **HTTP**: `POST /api/projects/{project_id}/warehouse_tables/`
|
|
328
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
329
|
+
- **OpenAPI operationId**: `warehouse_tables_create`
|
|
330
|
+
- **Path params**: None
|
|
331
|
+
- **Query params**: None
|
|
332
|
+
- **Response codes**: `201`
|
|
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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
344
|
+
- OpenAPI response codes: `201`
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
import posthog from "@utdk/posthog";
|
|
348
|
+
|
|
349
|
+
type WarehouseTablesCreateInput = Parameters<typeof posthog.warehouseTablesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
350
|
+
type WarehouseTablesCreateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesCreate>>;
|
|
351
|
+
|
|
352
|
+
const result: WarehouseTablesCreateOutput = await posthog.warehouseTablesCreate();
|
|
353
|
+
|
|
354
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `posthog.warehouseTablesDestroy`
|
|
358
|
+
|
|
359
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/warehouse_tables/{id}/`
|
|
360
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
361
|
+
- **OpenAPI operationId**: `warehouse_tables_destroy`
|
|
362
|
+
- **Path params**: `id`
|
|
363
|
+
- **Query params**: None
|
|
364
|
+
- **Response codes**: `204`
|
|
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: `unknown`
|
|
376
|
+
- OpenAPI response codes: `204`
|
|
377
|
+
|
|
378
|
+
```ts
|
|
379
|
+
import posthog from "@utdk/posthog";
|
|
380
|
+
|
|
381
|
+
type WarehouseTablesDestroyInput = Parameters<typeof posthog.warehouseTablesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
382
|
+
type WarehouseTablesDestroyOutput = Awaited<ReturnType<typeof posthog.warehouseTablesDestroy>>;
|
|
383
|
+
|
|
384
|
+
const result: WarehouseTablesDestroyOutput = await posthog.warehouseTablesDestroy();
|
|
385
|
+
|
|
386
|
+
// Result shape (from schema): unknown
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### `posthog.warehouseTablesRetrieve`
|
|
390
|
+
|
|
391
|
+
- **HTTP**: `GET /api/projects/{project_id}/warehouse_tables/{id}/`
|
|
392
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
393
|
+
- **OpenAPI operationId**: `warehouse_tables_retrieve`
|
|
394
|
+
- **Path params**: `id`
|
|
395
|
+
- **Query params**: None
|
|
396
|
+
- **Response codes**: `200`
|
|
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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
408
|
+
- OpenAPI response codes: `200`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type WarehouseTablesRetrieveInput = Parameters<typeof posthog.warehouseTablesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type WarehouseTablesRetrieveOutput = Awaited<ReturnType<typeof posthog.warehouseTablesRetrieve>>;
|
|
415
|
+
|
|
416
|
+
const result: WarehouseTablesRetrieveOutput = await posthog.warehouseTablesRetrieve();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.warehouseTablesPartialUpdate`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/warehouse_tables/{id}/`
|
|
424
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
425
|
+
- **OpenAPI operationId**: `warehouse_tables_partial_update`
|
|
426
|
+
- **Path params**: `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: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
440
|
+
- OpenAPI response codes: `200`
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import posthog from "@utdk/posthog";
|
|
444
|
+
|
|
445
|
+
type WarehouseTablesPartialUpdateInput = Parameters<typeof posthog.warehouseTablesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
446
|
+
type WarehouseTablesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesPartialUpdate>>;
|
|
447
|
+
|
|
448
|
+
const result: WarehouseTablesPartialUpdateOutput = await posthog.warehouseTablesPartialUpdate();
|
|
449
|
+
|
|
450
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
### `posthog.warehouseTablesUpdate`
|
|
454
|
+
|
|
455
|
+
- **HTTP**: `PUT /api/projects/{project_id}/warehouse_tables/{id}/`
|
|
456
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
457
|
+
- **OpenAPI operationId**: `warehouse_tables_update`
|
|
458
|
+
- **Path params**: `id`
|
|
459
|
+
- **Query params**: None
|
|
460
|
+
- **Response codes**: `200`
|
|
461
|
+
- **Transport options**: None
|
|
462
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
463
|
+
|
|
464
|
+
**Inputs**
|
|
465
|
+
|
|
466
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
467
|
+
- Client transport options: None
|
|
468
|
+
|
|
469
|
+
**Outputs**
|
|
470
|
+
|
|
471
|
+
- Client return type: `{ id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...`
|
|
472
|
+
- OpenAPI response codes: `200`
|
|
473
|
+
|
|
474
|
+
```ts
|
|
475
|
+
import posthog from "@utdk/posthog";
|
|
476
|
+
|
|
477
|
+
type WarehouseTablesUpdateInput = Parameters<typeof posthog.warehouseTablesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
478
|
+
type WarehouseTablesUpdateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesUpdate>>;
|
|
479
|
+
|
|
480
|
+
const result: WarehouseTablesUpdateOutput = await posthog.warehouseTablesUpdate();
|
|
481
|
+
|
|
482
|
+
// Result shape (from schema): { id: string; deleted?: boolean | null; name: string; format: "CSV" | "CSVWithNames" | "Parquet" | "JSONEachRow" | "Delta" | "DeltaS3Wrapper"; created_by: { id: number; uuid: string; distinct_id?: string | null; first_n...
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### `posthog.warehouseTablesRefreshSchemaCreate`
|
|
486
|
+
|
|
487
|
+
- **HTTP**: `POST /api/projects/{project_id}/warehouse_tables/{id}/refresh_schema/`
|
|
488
|
+
- **What it does**: Refresh table schema from source
|
|
489
|
+
- **OpenAPI operationId**: `warehouse_tables_refresh_schema_create`
|
|
490
|
+
- **Path params**: `id`
|
|
491
|
+
- **Query params**: None
|
|
492
|
+
- **Response codes**: `200`
|
|
493
|
+
- **Transport options**: None
|
|
494
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
495
|
+
|
|
496
|
+
**Inputs**
|
|
497
|
+
|
|
498
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
499
|
+
- Client transport options: None
|
|
500
|
+
|
|
501
|
+
**Outputs**
|
|
502
|
+
|
|
503
|
+
- Client return type: `unknown`
|
|
504
|
+
- OpenAPI response codes: `200`
|
|
505
|
+
|
|
506
|
+
```ts
|
|
507
|
+
import posthog from "@utdk/posthog";
|
|
508
|
+
|
|
509
|
+
type WarehouseTablesRefreshSchemaCreateInput = Parameters<typeof posthog.warehouseTablesRefreshSchemaCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
510
|
+
type WarehouseTablesRefreshSchemaCreateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesRefreshSchemaCreate>>;
|
|
511
|
+
|
|
512
|
+
const result: WarehouseTablesRefreshSchemaCreateOutput = await posthog.warehouseTablesRefreshSchemaCreate();
|
|
513
|
+
|
|
514
|
+
// Result shape (from schema): unknown
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### `posthog.warehouseTablesUpdateSchemaCreate`
|
|
518
|
+
|
|
519
|
+
- **HTTP**: `POST /api/projects/{project_id}/warehouse_tables/{id}/update_schema/`
|
|
520
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
521
|
+
- **OpenAPI operationId**: `warehouse_tables_update_schema_create`
|
|
522
|
+
- **Path params**: `id`
|
|
523
|
+
- **Query params**: None
|
|
524
|
+
- **Response codes**: `200`
|
|
525
|
+
- **Transport options**: None
|
|
526
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
527
|
+
|
|
528
|
+
**Inputs**
|
|
529
|
+
|
|
530
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
531
|
+
- Client transport options: None
|
|
532
|
+
|
|
533
|
+
**Outputs**
|
|
534
|
+
|
|
535
|
+
- Client return type: `unknown`
|
|
536
|
+
- OpenAPI response codes: `200`
|
|
537
|
+
|
|
538
|
+
```ts
|
|
539
|
+
import posthog from "@utdk/posthog";
|
|
540
|
+
|
|
541
|
+
type WarehouseTablesUpdateSchemaCreateInput = Parameters<typeof posthog.warehouseTablesUpdateSchemaCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
542
|
+
type WarehouseTablesUpdateSchemaCreateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesUpdateSchemaCreate>>;
|
|
543
|
+
|
|
544
|
+
const result: WarehouseTablesUpdateSchemaCreateOutput = await posthog.warehouseTablesUpdateSchemaCreate();
|
|
545
|
+
|
|
546
|
+
// Result shape (from schema): unknown
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### `posthog.warehouseTablesFileCreate`
|
|
550
|
+
|
|
551
|
+
- **HTTP**: `POST /api/projects/{project_id}/warehouse_tables/file/`
|
|
552
|
+
- **What it does**: Create, Read, Update and Delete Warehouse Tables.
|
|
553
|
+
- **OpenAPI operationId**: `warehouse_tables_file_create`
|
|
554
|
+
- **Path params**: None
|
|
555
|
+
- **Query params**: None
|
|
556
|
+
- **Response codes**: `200`
|
|
557
|
+
- **Transport options**: None
|
|
558
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
559
|
+
|
|
560
|
+
**Inputs**
|
|
561
|
+
|
|
562
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
563
|
+
- Client transport options: None
|
|
564
|
+
|
|
565
|
+
**Outputs**
|
|
566
|
+
|
|
567
|
+
- Client return type: `unknown`
|
|
568
|
+
- OpenAPI response codes: `200`
|
|
569
|
+
|
|
570
|
+
```ts
|
|
571
|
+
import posthog from "@utdk/posthog";
|
|
572
|
+
|
|
573
|
+
type WarehouseTablesFileCreateInput = Parameters<typeof posthog.warehouseTablesFileCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
574
|
+
type WarehouseTablesFileCreateOutput = Awaited<ReturnType<typeof posthog.warehouseTablesFileCreate>>;
|
|
575
|
+
|
|
576
|
+
const result: WarehouseTablesFileCreateOutput = await posthog.warehouseTablesFileCreate();
|
|
577
|
+
|
|
578
|
+
// Result shape (from schema): unknown
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<!-- prompt-hash:
|
|
583
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
584
|
+
-->
|