@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,881 @@
|
|
|
1
|
+
# Environments
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/`
|
|
8
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
9
|
+
- **OpenAPI operationId**: `environments_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: ({ id: number; uuid: string; organization: string; project_id: number; api_token: string; name: string; completed_snippet_onboarding: boolean; ha...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type EnvironmentsListInput = Parameters<typeof posthog.environmentsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type EnvironmentsListOutput = Awaited<ReturnType<typeof posthog.environmentsList>>;
|
|
31
|
+
|
|
32
|
+
const result: EnvironmentsListOutput = await posthog.environmentsList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; uuid: string; organization: string; project_id: number; api_token: string; name: string; completed_snippet_onboarding: boolean; ha...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.environmentsCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/environments/`
|
|
40
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
41
|
+
- **OpenAPI operationId**: `environments_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: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...`
|
|
56
|
+
- OpenAPI response codes: `201`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type EnvironmentsCreateInput = Parameters<typeof posthog.environmentsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type EnvironmentsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: EnvironmentsCreateOutput = await posthog.environmentsCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { id: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.environmentsDestroy`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/environments/{id}/`
|
|
72
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
73
|
+
- **OpenAPI operationId**: `environments_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 EnvironmentsDestroyInput = Parameters<typeof posthog.environmentsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type EnvironmentsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDestroy>>;
|
|
95
|
+
|
|
96
|
+
const result: EnvironmentsDestroyOutput = await posthog.environmentsDestroy();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): unknown
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.environmentsRetrieve`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/`
|
|
104
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
105
|
+
- **OpenAPI operationId**: `environments_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: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...`
|
|
120
|
+
- OpenAPI response codes: `200`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type EnvironmentsRetrieveInput = Parameters<typeof posthog.environmentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type EnvironmentsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsRetrieve>>;
|
|
127
|
+
|
|
128
|
+
const result: EnvironmentsRetrieveOutput = await posthog.environmentsRetrieve();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { id: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.environmentsPartialUpdate`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/`
|
|
136
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
137
|
+
- **OpenAPI operationId**: `environments_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: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...`
|
|
152
|
+
- OpenAPI response codes: `200`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type EnvironmentsPartialUpdateInput = Parameters<typeof posthog.environmentsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type EnvironmentsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsPartialUpdate>>;
|
|
159
|
+
|
|
160
|
+
const result: EnvironmentsPartialUpdateOutput = await posthog.environmentsPartialUpdate();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { id: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.environmentsUpdate`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `PUT /api/projects/{project_id}/environments/{id}/`
|
|
168
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
169
|
+
- **OpenAPI operationId**: `environments_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: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...`
|
|
184
|
+
- OpenAPI response codes: `200`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type EnvironmentsUpdateInput = Parameters<typeof posthog.environmentsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type EnvironmentsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsUpdate>>;
|
|
191
|
+
|
|
192
|
+
const result: EnvironmentsUpdateOutput = await posthog.environmentsUpdate();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { id: number; uuid: string; name?: string; access_control?: boolean; organization: string; project_id: number; api_token: string; secret_api_token: string | null; secret_api_token_backup: string | null; created_at: stri...
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### `posthog.environmentsActivityRetrieve`
|
|
198
|
+
|
|
199
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/activity/`
|
|
200
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
201
|
+
- **OpenAPI operationId**: `environments_activity_retrieve`
|
|
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 EnvironmentsActivityRetrieveInput = Parameters<typeof posthog.environmentsActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
222
|
+
type EnvironmentsActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsActivityRetrieve>>;
|
|
223
|
+
|
|
224
|
+
const result: EnvironmentsActivityRetrieveOutput = await posthog.environmentsActivityRetrieve();
|
|
225
|
+
|
|
226
|
+
// Result shape (from schema): unknown
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### `posthog.environmentsAddProductIntentPartialUpdate`
|
|
230
|
+
|
|
231
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/add_product_intent/`
|
|
232
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
233
|
+
- **OpenAPI operationId**: `environments_add_product_intent_partial_update`
|
|
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 EnvironmentsAddProductIntentPartialUpdateInput = Parameters<typeof posthog.environmentsAddProductIntentPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type EnvironmentsAddProductIntentPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsAddProductIntentPartialUpdate>>;
|
|
255
|
+
|
|
256
|
+
const result: EnvironmentsAddProductIntentPartialUpdateOutput = await posthog.environmentsAddProductIntentPartialUpdate();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): unknown
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.environmentsCompleteProductOnboardingPartialUpdate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/complete_product_onboarding/`
|
|
264
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
265
|
+
- **OpenAPI operationId**: `environments_complete_product_onboarding_partial_update`
|
|
266
|
+
- **Path params**: `id`
|
|
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 EnvironmentsCompleteProductOnboardingPartialUpdateInput = Parameters<typeof posthog.environmentsCompleteProductOnboardingPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type EnvironmentsCompleteProductOnboardingPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsCompleteProductOnboardingPartialUpdate>>;
|
|
287
|
+
|
|
288
|
+
const result: EnvironmentsCompleteProductOnboardingPartialUpdateOutput = await posthog.environmentsCompleteProductOnboardingPartialUpdate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): unknown
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.environmentsDefaultEvaluationContextsDestroy`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/environments/{id}/default_evaluation_contexts/`
|
|
296
|
+
- **What it does**: Manage default evaluation contexts for a team.
|
|
297
|
+
- **OpenAPI operationId**: `environments_default_evaluation_contexts_destroy`
|
|
298
|
+
- **Path params**: `id`
|
|
299
|
+
- **Query params**: None
|
|
300
|
+
- **Response codes**: `204`
|
|
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: `unknown`
|
|
312
|
+
- OpenAPI response codes: `204`
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import posthog from "@utdk/posthog";
|
|
316
|
+
|
|
317
|
+
type EnvironmentsDefaultEvaluationContextsDestroyInput = Parameters<typeof posthog.environmentsDefaultEvaluationContextsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
318
|
+
type EnvironmentsDefaultEvaluationContextsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsDefaultEvaluationContextsDestroy>>;
|
|
319
|
+
|
|
320
|
+
const result: EnvironmentsDefaultEvaluationContextsDestroyOutput = await posthog.environmentsDefaultEvaluationContextsDestroy();
|
|
321
|
+
|
|
322
|
+
// Result shape (from schema): unknown
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### `posthog.environmentsDefaultEvaluationContextsRetrieve`
|
|
326
|
+
|
|
327
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/default_evaluation_contexts/`
|
|
328
|
+
- **What it does**: Manage default evaluation contexts for a team.
|
|
329
|
+
- **OpenAPI operationId**: `environments_default_evaluation_contexts_retrieve`
|
|
330
|
+
- **Path params**: `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: `unknown`
|
|
344
|
+
- OpenAPI response codes: `200`
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
import posthog from "@utdk/posthog";
|
|
348
|
+
|
|
349
|
+
type EnvironmentsDefaultEvaluationContextsRetrieveInput = Parameters<typeof posthog.environmentsDefaultEvaluationContextsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
350
|
+
type EnvironmentsDefaultEvaluationContextsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDefaultEvaluationContextsRetrieve>>;
|
|
351
|
+
|
|
352
|
+
const result: EnvironmentsDefaultEvaluationContextsRetrieveOutput = await posthog.environmentsDefaultEvaluationContextsRetrieve();
|
|
353
|
+
|
|
354
|
+
// Result shape (from schema): unknown
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `posthog.environmentsDefaultEvaluationContextsCreate`
|
|
358
|
+
|
|
359
|
+
- **HTTP**: `POST /api/projects/{project_id}/environments/{id}/default_evaluation_contexts/`
|
|
360
|
+
- **What it does**: Manage default evaluation contexts for a team.
|
|
361
|
+
- **OpenAPI operationId**: `environments_default_evaluation_contexts_create`
|
|
362
|
+
- **Path params**: `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: `unknown`
|
|
376
|
+
- OpenAPI response codes: `200`
|
|
377
|
+
|
|
378
|
+
```ts
|
|
379
|
+
import posthog from "@utdk/posthog";
|
|
380
|
+
|
|
381
|
+
type EnvironmentsDefaultEvaluationContextsCreateInput = Parameters<typeof posthog.environmentsDefaultEvaluationContextsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
382
|
+
type EnvironmentsDefaultEvaluationContextsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsDefaultEvaluationContextsCreate>>;
|
|
383
|
+
|
|
384
|
+
const result: EnvironmentsDefaultEvaluationContextsCreateOutput = await posthog.environmentsDefaultEvaluationContextsCreate();
|
|
385
|
+
|
|
386
|
+
// Result shape (from schema): unknown
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### `posthog.environmentsDefaultReleaseConditionsRetrieve`
|
|
390
|
+
|
|
391
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/default_release_conditions/`
|
|
392
|
+
- **What it does**: Manage default release conditions for new feature flags in this team.
|
|
393
|
+
- **OpenAPI operationId**: `environments_default_release_conditions_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: `unknown`
|
|
408
|
+
- OpenAPI response codes: `200`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type EnvironmentsDefaultReleaseConditionsRetrieveInput = Parameters<typeof posthog.environmentsDefaultReleaseConditionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type EnvironmentsDefaultReleaseConditionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsDefaultReleaseConditionsRetrieve>>;
|
|
415
|
+
|
|
416
|
+
const result: EnvironmentsDefaultReleaseConditionsRetrieveOutput = await posthog.environmentsDefaultReleaseConditionsRetrieve();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): unknown
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.environmentsDefaultReleaseConditionsUpdate`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `PUT /api/projects/{project_id}/environments/{id}/default_release_conditions/`
|
|
424
|
+
- **What it does**: Manage default release conditions for new feature flags in this team.
|
|
425
|
+
- **OpenAPI operationId**: `environments_default_release_conditions_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: `unknown`
|
|
440
|
+
- OpenAPI response codes: `200`
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import posthog from "@utdk/posthog";
|
|
444
|
+
|
|
445
|
+
type EnvironmentsDefaultReleaseConditionsUpdateInput = Parameters<typeof posthog.environmentsDefaultReleaseConditionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
446
|
+
type EnvironmentsDefaultReleaseConditionsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDefaultReleaseConditionsUpdate>>;
|
|
447
|
+
|
|
448
|
+
const result: EnvironmentsDefaultReleaseConditionsUpdateOutput = await posthog.environmentsDefaultReleaseConditionsUpdate();
|
|
449
|
+
|
|
450
|
+
// Result shape (from schema): unknown
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
### `posthog.environmentsDeleteSecretTokenBackupPartialUpdate`
|
|
454
|
+
|
|
455
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/delete_secret_token_backup/`
|
|
456
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
457
|
+
- **OpenAPI operationId**: `environments_delete_secret_token_backup_partial_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: `unknown`
|
|
472
|
+
- OpenAPI response codes: `200`
|
|
473
|
+
|
|
474
|
+
```ts
|
|
475
|
+
import posthog from "@utdk/posthog";
|
|
476
|
+
|
|
477
|
+
type EnvironmentsDeleteSecretTokenBackupPartialUpdateInput = Parameters<typeof posthog.environmentsDeleteSecretTokenBackupPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
478
|
+
type EnvironmentsDeleteSecretTokenBackupPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsDeleteSecretTokenBackupPartialUpdate>>;
|
|
479
|
+
|
|
480
|
+
const result: EnvironmentsDeleteSecretTokenBackupPartialUpdateOutput = await posthog.environmentsDeleteSecretTokenBackupPartialUpdate();
|
|
481
|
+
|
|
482
|
+
// Result shape (from schema): unknown
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### `posthog.environmentsEvaluationContextSuggestionsDestroy`
|
|
486
|
+
|
|
487
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/environments/{id}/evaluation_context_suggestions/`
|
|
488
|
+
- **What it does**: Hide an evaluation context name from the flag editor's suggestion list, or restore it.
|
|
489
|
+
|
|
490
|
+
POST hides the name; DELETE restores it. The underlying context row and any flags already
|
|
491
|
+
using it are never modified — this only controls what gets suggested.
|
|
492
|
+
- **OpenAPI operationId**: `environments_evaluation_context_suggestions_destroy`
|
|
493
|
+
- **Path params**: `id`
|
|
494
|
+
- **Query params**: `context_name`
|
|
495
|
+
- **Response codes**: `200`
|
|
496
|
+
- **Transport options**: None
|
|
497
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
498
|
+
|
|
499
|
+
**Inputs**
|
|
500
|
+
|
|
501
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
502
|
+
- Client transport options: None
|
|
503
|
+
|
|
504
|
+
**Outputs**
|
|
505
|
+
|
|
506
|
+
- Client return type: `{ success: boolean; name: string; hidden_from_suggestions: boolean }`
|
|
507
|
+
- OpenAPI response codes: `200`
|
|
508
|
+
|
|
509
|
+
```ts
|
|
510
|
+
import posthog from "@utdk/posthog";
|
|
511
|
+
|
|
512
|
+
type EnvironmentsEvaluationContextSuggestionsDestroyInput = Parameters<typeof posthog.environmentsEvaluationContextSuggestionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
513
|
+
type EnvironmentsEvaluationContextSuggestionsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsEvaluationContextSuggestionsDestroy>>;
|
|
514
|
+
|
|
515
|
+
const result: EnvironmentsEvaluationContextSuggestionsDestroyOutput = await posthog.environmentsEvaluationContextSuggestionsDestroy();
|
|
516
|
+
|
|
517
|
+
// Result shape (from schema): { success: boolean; name: string; hidden_from_suggestions: boolean }
|
|
518
|
+
```
|
|
519
|
+
|
|
520
|
+
### `posthog.environmentsEvaluationContextSuggestionsCreate`
|
|
521
|
+
|
|
522
|
+
- **HTTP**: `POST /api/projects/{project_id}/environments/{id}/evaluation_context_suggestions/`
|
|
523
|
+
- **What it does**: Hide an evaluation context name from the flag editor's suggestion list, or restore it.
|
|
524
|
+
|
|
525
|
+
POST hides the name; DELETE restores it. The underlying context row and any flags already
|
|
526
|
+
using it are never modified — this only controls what gets suggested.
|
|
527
|
+
- **OpenAPI operationId**: `environments_evaluation_context_suggestions_create`
|
|
528
|
+
- **Path params**: `id`
|
|
529
|
+
- **Query params**: None
|
|
530
|
+
- **Response codes**: `200`
|
|
531
|
+
- **Transport options**: None
|
|
532
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
533
|
+
|
|
534
|
+
**Inputs**
|
|
535
|
+
|
|
536
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
537
|
+
- Client transport options: None
|
|
538
|
+
|
|
539
|
+
**Outputs**
|
|
540
|
+
|
|
541
|
+
- Client return type: `{ success: boolean; name: string; hidden_from_suggestions: boolean }`
|
|
542
|
+
- OpenAPI response codes: `200`
|
|
543
|
+
|
|
544
|
+
```ts
|
|
545
|
+
import posthog from "@utdk/posthog";
|
|
546
|
+
|
|
547
|
+
type EnvironmentsEvaluationContextSuggestionsCreateInput = Parameters<typeof posthog.environmentsEvaluationContextSuggestionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
548
|
+
type EnvironmentsEvaluationContextSuggestionsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsEvaluationContextSuggestionsCreate>>;
|
|
549
|
+
|
|
550
|
+
const result: EnvironmentsEvaluationContextSuggestionsCreateOutput = await posthog.environmentsEvaluationContextSuggestionsCreate();
|
|
551
|
+
|
|
552
|
+
// Result shape (from schema): { success: boolean; name: string; hidden_from_suggestions: boolean }
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
### `posthog.environmentsEventIngestionRestrictionsRetrieve`
|
|
556
|
+
|
|
557
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/event_ingestion_restrictions/`
|
|
558
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
559
|
+
- **OpenAPI operationId**: `environments_event_ingestion_restrictions_retrieve`
|
|
560
|
+
- **Path params**: `id`
|
|
561
|
+
- **Query params**: None
|
|
562
|
+
- **Response codes**: `200`
|
|
563
|
+
- **Transport options**: None
|
|
564
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
565
|
+
|
|
566
|
+
**Inputs**
|
|
567
|
+
|
|
568
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
569
|
+
- Client transport options: None
|
|
570
|
+
|
|
571
|
+
**Outputs**
|
|
572
|
+
|
|
573
|
+
- Client return type: `unknown`
|
|
574
|
+
- OpenAPI response codes: `200`
|
|
575
|
+
|
|
576
|
+
```ts
|
|
577
|
+
import posthog from "@utdk/posthog";
|
|
578
|
+
|
|
579
|
+
type EnvironmentsEventIngestionRestrictionsRetrieveInput = Parameters<typeof posthog.environmentsEventIngestionRestrictionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
580
|
+
type EnvironmentsEventIngestionRestrictionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsEventIngestionRestrictionsRetrieve>>;
|
|
581
|
+
|
|
582
|
+
const result: EnvironmentsEventIngestionRestrictionsRetrieveOutput = await posthog.environmentsEventIngestionRestrictionsRetrieve();
|
|
583
|
+
|
|
584
|
+
// Result shape (from schema): unknown
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
### `posthog.environmentsExperimentsConfigRetrieve`
|
|
588
|
+
|
|
589
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/experiments_config/`
|
|
590
|
+
- **What it does**: Manage experiment configuration for this environment.
|
|
591
|
+
- **OpenAPI operationId**: `environments_experiments_config_retrieve`
|
|
592
|
+
- **Path params**: `id`
|
|
593
|
+
- **Query params**: None
|
|
594
|
+
- **Response codes**: `200`
|
|
595
|
+
- **Transport options**: None
|
|
596
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
597
|
+
|
|
598
|
+
**Inputs**
|
|
599
|
+
|
|
600
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
601
|
+
- Client transport options: None
|
|
602
|
+
|
|
603
|
+
**Outputs**
|
|
604
|
+
|
|
605
|
+
- Client return type: `unknown`
|
|
606
|
+
- OpenAPI response codes: `200`
|
|
607
|
+
|
|
608
|
+
```ts
|
|
609
|
+
import posthog from "@utdk/posthog";
|
|
610
|
+
|
|
611
|
+
type EnvironmentsExperimentsConfigRetrieveInput = Parameters<typeof posthog.environmentsExperimentsConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
612
|
+
type EnvironmentsExperimentsConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsExperimentsConfigRetrieve>>;
|
|
613
|
+
|
|
614
|
+
const result: EnvironmentsExperimentsConfigRetrieveOutput = await posthog.environmentsExperimentsConfigRetrieve();
|
|
615
|
+
|
|
616
|
+
// Result shape (from schema): unknown
|
|
617
|
+
```
|
|
618
|
+
|
|
619
|
+
### `posthog.environmentsExperimentsConfigPartialUpdate`
|
|
620
|
+
|
|
621
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/experiments_config/`
|
|
622
|
+
- **What it does**: Manage experiment configuration for this environment.
|
|
623
|
+
- **OpenAPI operationId**: `environments_experiments_config_partial_update`
|
|
624
|
+
- **Path params**: `id`
|
|
625
|
+
- **Query params**: None
|
|
626
|
+
- **Response codes**: `200`
|
|
627
|
+
- **Transport options**: None
|
|
628
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
629
|
+
|
|
630
|
+
**Inputs**
|
|
631
|
+
|
|
632
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
633
|
+
- Client transport options: None
|
|
634
|
+
|
|
635
|
+
**Outputs**
|
|
636
|
+
|
|
637
|
+
- Client return type: `unknown`
|
|
638
|
+
- OpenAPI response codes: `200`
|
|
639
|
+
|
|
640
|
+
```ts
|
|
641
|
+
import posthog from "@utdk/posthog";
|
|
642
|
+
|
|
643
|
+
type EnvironmentsExperimentsConfigPartialUpdateInput = Parameters<typeof posthog.environmentsExperimentsConfigPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
644
|
+
type EnvironmentsExperimentsConfigPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsExperimentsConfigPartialUpdate>>;
|
|
645
|
+
|
|
646
|
+
const result: EnvironmentsExperimentsConfigPartialUpdateOutput = await posthog.environmentsExperimentsConfigPartialUpdate();
|
|
647
|
+
|
|
648
|
+
// Result shape (from schema): unknown
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### `posthog.environmentsGenerateConversationsPublicTokenCreate`
|
|
652
|
+
|
|
653
|
+
- **HTTP**: `POST /api/projects/{project_id}/environments/{id}/generate_conversations_public_token/`
|
|
654
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
655
|
+
- **OpenAPI operationId**: `environments_generate_conversations_public_token_create`
|
|
656
|
+
- **Path params**: `id`
|
|
657
|
+
- **Query params**: None
|
|
658
|
+
- **Response codes**: `200`
|
|
659
|
+
- **Transport options**: None
|
|
660
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
661
|
+
|
|
662
|
+
**Inputs**
|
|
663
|
+
|
|
664
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
665
|
+
- Client transport options: None
|
|
666
|
+
|
|
667
|
+
**Outputs**
|
|
668
|
+
|
|
669
|
+
- Client return type: `unknown`
|
|
670
|
+
- OpenAPI response codes: `200`
|
|
671
|
+
|
|
672
|
+
```ts
|
|
673
|
+
import posthog from "@utdk/posthog";
|
|
674
|
+
|
|
675
|
+
type EnvironmentsGenerateConversationsPublicTokenCreateInput = Parameters<typeof posthog.environmentsGenerateConversationsPublicTokenCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
676
|
+
type EnvironmentsGenerateConversationsPublicTokenCreateOutput = Awaited<ReturnType<typeof posthog.environmentsGenerateConversationsPublicTokenCreate>>;
|
|
677
|
+
|
|
678
|
+
const result: EnvironmentsGenerateConversationsPublicTokenCreateOutput = await posthog.environmentsGenerateConversationsPublicTokenCreate();
|
|
679
|
+
|
|
680
|
+
// Result shape (from schema): unknown
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
### `posthog.environmentsIsGeneratingDemoDataRetrieve`
|
|
684
|
+
|
|
685
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/is_generating_demo_data/`
|
|
686
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
687
|
+
- **OpenAPI operationId**: `environments_is_generating_demo_data_retrieve`
|
|
688
|
+
- **Path params**: `id`
|
|
689
|
+
- **Query params**: None
|
|
690
|
+
- **Response codes**: `200`
|
|
691
|
+
- **Transport options**: None
|
|
692
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
693
|
+
|
|
694
|
+
**Inputs**
|
|
695
|
+
|
|
696
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
697
|
+
- Client transport options: None
|
|
698
|
+
|
|
699
|
+
**Outputs**
|
|
700
|
+
|
|
701
|
+
- Client return type: `unknown`
|
|
702
|
+
- OpenAPI response codes: `200`
|
|
703
|
+
|
|
704
|
+
```ts
|
|
705
|
+
import posthog from "@utdk/posthog";
|
|
706
|
+
|
|
707
|
+
type EnvironmentsIsGeneratingDemoDataRetrieveInput = Parameters<typeof posthog.environmentsIsGeneratingDemoDataRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
708
|
+
type EnvironmentsIsGeneratingDemoDataRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIsGeneratingDemoDataRetrieve>>;
|
|
709
|
+
|
|
710
|
+
const result: EnvironmentsIsGeneratingDemoDataRetrieveOutput = await posthog.environmentsIsGeneratingDemoDataRetrieve();
|
|
711
|
+
|
|
712
|
+
// Result shape (from schema): unknown
|
|
713
|
+
```
|
|
714
|
+
|
|
715
|
+
### `posthog.environmentsLogsConfigRetrieve`
|
|
716
|
+
|
|
717
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/logs_config/`
|
|
718
|
+
- **What it does**: Manage logs product configuration for this environment.
|
|
719
|
+
- **OpenAPI operationId**: `environments_logs_config_retrieve`
|
|
720
|
+
- **Path params**: `id`
|
|
721
|
+
- **Query params**: None
|
|
722
|
+
- **Response codes**: `200`
|
|
723
|
+
- **Transport options**: None
|
|
724
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
725
|
+
|
|
726
|
+
**Inputs**
|
|
727
|
+
|
|
728
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
729
|
+
- Client transport options: None
|
|
730
|
+
|
|
731
|
+
**Outputs**
|
|
732
|
+
|
|
733
|
+
- Client return type: `unknown`
|
|
734
|
+
- OpenAPI response codes: `200`
|
|
735
|
+
|
|
736
|
+
```ts
|
|
737
|
+
import posthog from "@utdk/posthog";
|
|
738
|
+
|
|
739
|
+
type EnvironmentsLogsConfigRetrieveInput = Parameters<typeof posthog.environmentsLogsConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
740
|
+
type EnvironmentsLogsConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsLogsConfigRetrieve>>;
|
|
741
|
+
|
|
742
|
+
const result: EnvironmentsLogsConfigRetrieveOutput = await posthog.environmentsLogsConfigRetrieve();
|
|
743
|
+
|
|
744
|
+
// Result shape (from schema): unknown
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
### `posthog.environmentsLogsConfigPartialUpdate`
|
|
748
|
+
|
|
749
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/logs_config/`
|
|
750
|
+
- **What it does**: Manage logs product configuration for this environment.
|
|
751
|
+
- **OpenAPI operationId**: `environments_logs_config_partial_update`
|
|
752
|
+
- **Path params**: `id`
|
|
753
|
+
- **Query params**: None
|
|
754
|
+
- **Response codes**: `200`
|
|
755
|
+
- **Transport options**: None
|
|
756
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
757
|
+
|
|
758
|
+
**Inputs**
|
|
759
|
+
|
|
760
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
761
|
+
- Client transport options: None
|
|
762
|
+
|
|
763
|
+
**Outputs**
|
|
764
|
+
|
|
765
|
+
- Client return type: `unknown`
|
|
766
|
+
- OpenAPI response codes: `200`
|
|
767
|
+
|
|
768
|
+
```ts
|
|
769
|
+
import posthog from "@utdk/posthog";
|
|
770
|
+
|
|
771
|
+
type EnvironmentsLogsConfigPartialUpdateInput = Parameters<typeof posthog.environmentsLogsConfigPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
772
|
+
type EnvironmentsLogsConfigPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsLogsConfigPartialUpdate>>;
|
|
773
|
+
|
|
774
|
+
const result: EnvironmentsLogsConfigPartialUpdateOutput = await posthog.environmentsLogsConfigPartialUpdate();
|
|
775
|
+
|
|
776
|
+
// Result shape (from schema): unknown
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### `posthog.environmentsResetTokenPartialUpdate`
|
|
780
|
+
|
|
781
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/reset_token/`
|
|
782
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
783
|
+
- **OpenAPI operationId**: `environments_reset_token_partial_update`
|
|
784
|
+
- **Path params**: `id`
|
|
785
|
+
- **Query params**: None
|
|
786
|
+
- **Response codes**: `200`
|
|
787
|
+
- **Transport options**: None
|
|
788
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
789
|
+
|
|
790
|
+
**Inputs**
|
|
791
|
+
|
|
792
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
793
|
+
- Client transport options: None
|
|
794
|
+
|
|
795
|
+
**Outputs**
|
|
796
|
+
|
|
797
|
+
- Client return type: `unknown`
|
|
798
|
+
- OpenAPI response codes: `200`
|
|
799
|
+
|
|
800
|
+
```ts
|
|
801
|
+
import posthog from "@utdk/posthog";
|
|
802
|
+
|
|
803
|
+
type EnvironmentsResetTokenPartialUpdateInput = Parameters<typeof posthog.environmentsResetTokenPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
804
|
+
type EnvironmentsResetTokenPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsResetTokenPartialUpdate>>;
|
|
805
|
+
|
|
806
|
+
const result: EnvironmentsResetTokenPartialUpdateOutput = await posthog.environmentsResetTokenPartialUpdate();
|
|
807
|
+
|
|
808
|
+
// Result shape (from schema): unknown
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
### `posthog.environmentsRotateSecretTokenPartialUpdate`
|
|
812
|
+
|
|
813
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/environments/{id}/rotate_secret_token/`
|
|
814
|
+
- **What it does**: Deprecated: use /api/environments/{id}/ instead.
|
|
815
|
+
- **OpenAPI operationId**: `environments_rotate_secret_token_partial_update`
|
|
816
|
+
- **Path params**: `id`
|
|
817
|
+
- **Query params**: None
|
|
818
|
+
- **Response codes**: `200`
|
|
819
|
+
- **Transport options**: None
|
|
820
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
821
|
+
|
|
822
|
+
**Inputs**
|
|
823
|
+
|
|
824
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
825
|
+
- Client transport options: None
|
|
826
|
+
|
|
827
|
+
**Outputs**
|
|
828
|
+
|
|
829
|
+
- Client return type: `unknown`
|
|
830
|
+
- OpenAPI response codes: `200`
|
|
831
|
+
|
|
832
|
+
```ts
|
|
833
|
+
import posthog from "@utdk/posthog";
|
|
834
|
+
|
|
835
|
+
type EnvironmentsRotateSecretTokenPartialUpdateInput = Parameters<typeof posthog.environmentsRotateSecretTokenPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
836
|
+
type EnvironmentsRotateSecretTokenPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsRotateSecretTokenPartialUpdate>>;
|
|
837
|
+
|
|
838
|
+
const result: EnvironmentsRotateSecretTokenPartialUpdateOutput = await posthog.environmentsRotateSecretTokenPartialUpdate();
|
|
839
|
+
|
|
840
|
+
// Result shape (from schema): unknown
|
|
841
|
+
```
|
|
842
|
+
|
|
843
|
+
### `posthog.environmentsSettingsAsOfRetrieve`
|
|
844
|
+
|
|
845
|
+
- **HTTP**: `GET /api/projects/{project_id}/environments/{id}/settings_as_of/`
|
|
846
|
+
- **What it does**: Return the team settings as of the provided timestamp.
|
|
847
|
+
Query params:
|
|
848
|
+
- at: ISO8601 datetime (required)
|
|
849
|
+
- scope: optional, one or multiple keys to filter the returned settings
|
|
850
|
+
- **OpenAPI operationId**: `environments_settings_as_of_retrieve`
|
|
851
|
+
- **Path params**: `id`
|
|
852
|
+
- **Query params**: None
|
|
853
|
+
- **Response codes**: `200`
|
|
854
|
+
- **Transport options**: None
|
|
855
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
856
|
+
|
|
857
|
+
**Inputs**
|
|
858
|
+
|
|
859
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
860
|
+
- Client transport options: None
|
|
861
|
+
|
|
862
|
+
**Outputs**
|
|
863
|
+
|
|
864
|
+
- Client return type: `unknown`
|
|
865
|
+
- OpenAPI response codes: `200`
|
|
866
|
+
|
|
867
|
+
```ts
|
|
868
|
+
import posthog from "@utdk/posthog";
|
|
869
|
+
|
|
870
|
+
type EnvironmentsSettingsAsOfRetrieveInput = Parameters<typeof posthog.environmentsSettingsAsOfRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
871
|
+
type EnvironmentsSettingsAsOfRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSettingsAsOfRetrieve>>;
|
|
872
|
+
|
|
873
|
+
const result: EnvironmentsSettingsAsOfRetrieveOutput = await posthog.environmentsSettingsAsOfRetrieve();
|
|
874
|
+
|
|
875
|
+
// Result shape (from schema): unknown
|
|
876
|
+
```
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
<!-- prompt-hash:
|
|
880
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
881
|
+
-->
|