@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,194 @@
|
|
|
1
|
+
# Account Relationship Definitions
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.accountRelationshipDefinitionsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/account_relationship_definitions/`
|
|
8
|
+
- **OpenAPI operationId**: `account_relationship_definitions_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `limit`, `offset`
|
|
11
|
+
- **Response codes**: `200`
|
|
12
|
+
- **Transport options**: None
|
|
13
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
14
|
+
|
|
15
|
+
**Inputs**
|
|
16
|
+
|
|
17
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
18
|
+
- Client transport options: None
|
|
19
|
+
|
|
20
|
+
**Outputs**
|
|
21
|
+
|
|
22
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string | null; is_single_holder?: boolean })[] }`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type AccountRelationshipDefinitionsListInput = Parameters<typeof posthog.accountRelationshipDefinitionsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type AccountRelationshipDefinitionsListOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsList>>;
|
|
30
|
+
|
|
31
|
+
const result: AccountRelationshipDefinitionsListOutput = await posthog.accountRelationshipDefinitionsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string | null; is_single_holder?: boolean })[] }
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.accountRelationshipDefinitionsCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/projects/{project_id}/account_relationship_definitions/`
|
|
39
|
+
- **OpenAPI operationId**: `account_relationship_definitions_create`
|
|
40
|
+
- **Path params**: None
|
|
41
|
+
- **Query params**: None
|
|
42
|
+
- **Response codes**: `201`
|
|
43
|
+
- **Transport options**: None
|
|
44
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
45
|
+
|
|
46
|
+
**Inputs**
|
|
47
|
+
|
|
48
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
49
|
+
- Client transport options: None
|
|
50
|
+
|
|
51
|
+
**Outputs**
|
|
52
|
+
|
|
53
|
+
- Client return type: `{ id: string; name: string; description?: string | null; is_single_holder?: boolean }`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type AccountRelationshipDefinitionsCreateInput = Parameters<typeof posthog.accountRelationshipDefinitionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type AccountRelationshipDefinitionsCreateOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: AccountRelationshipDefinitionsCreateOutput = await posthog.accountRelationshipDefinitionsCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; description?: string | null; is_single_holder?: boolean }
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.accountRelationshipDefinitionsDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/account_relationship_definitions/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `account_relationship_definitions_destroy`
|
|
71
|
+
- **Path params**: `id`
|
|
72
|
+
- **Query params**: None
|
|
73
|
+
- **Response codes**: `204`
|
|
74
|
+
- **Transport options**: None
|
|
75
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
76
|
+
|
|
77
|
+
**Inputs**
|
|
78
|
+
|
|
79
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
80
|
+
- Client transport options: None
|
|
81
|
+
|
|
82
|
+
**Outputs**
|
|
83
|
+
|
|
84
|
+
- Client return type: `unknown`
|
|
85
|
+
- OpenAPI response codes: `204`
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
import posthog from "@utdk/posthog";
|
|
89
|
+
|
|
90
|
+
type AccountRelationshipDefinitionsDestroyInput = Parameters<typeof posthog.accountRelationshipDefinitionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type AccountRelationshipDefinitionsDestroyOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: AccountRelationshipDefinitionsDestroyOutput = await posthog.accountRelationshipDefinitionsDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.accountRelationshipDefinitionsRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/projects/{project_id}/account_relationship_definitions/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `account_relationship_definitions_retrieve`
|
|
102
|
+
- **Path params**: `id`
|
|
103
|
+
- **Query params**: None
|
|
104
|
+
- **Response codes**: `200`
|
|
105
|
+
- **Transport options**: None
|
|
106
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
107
|
+
|
|
108
|
+
**Inputs**
|
|
109
|
+
|
|
110
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
111
|
+
- Client transport options: None
|
|
112
|
+
|
|
113
|
+
**Outputs**
|
|
114
|
+
|
|
115
|
+
- Client return type: `{ id: string; name: string; description?: string | null; is_single_holder?: boolean }`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type AccountRelationshipDefinitionsRetrieveInput = Parameters<typeof posthog.accountRelationshipDefinitionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type AccountRelationshipDefinitionsRetrieveOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: AccountRelationshipDefinitionsRetrieveOutput = await posthog.accountRelationshipDefinitionsRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: string; name: string; description?: string | null; is_single_holder?: boolean }
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.accountRelationshipDefinitionsPartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/account_relationship_definitions/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `account_relationship_definitions_partial_update`
|
|
133
|
+
- **Path params**: `id`
|
|
134
|
+
- **Query params**: None
|
|
135
|
+
- **Response codes**: `200`
|
|
136
|
+
- **Transport options**: None
|
|
137
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
138
|
+
|
|
139
|
+
**Inputs**
|
|
140
|
+
|
|
141
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
142
|
+
- Client transport options: None
|
|
143
|
+
|
|
144
|
+
**Outputs**
|
|
145
|
+
|
|
146
|
+
- Client return type: `{ id: string; name: string; description?: string | null; is_single_holder?: boolean }`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type AccountRelationshipDefinitionsPartialUpdateInput = Parameters<typeof posthog.accountRelationshipDefinitionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type AccountRelationshipDefinitionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsPartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: AccountRelationshipDefinitionsPartialUpdateOutput = await posthog.accountRelationshipDefinitionsPartialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: string; name: string; description?: string | null; is_single_holder?: boolean }
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.accountRelationshipDefinitionsUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/projects/{project_id}/account_relationship_definitions/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `account_relationship_definitions_update`
|
|
164
|
+
- **Path params**: `id`
|
|
165
|
+
- **Query params**: None
|
|
166
|
+
- **Response codes**: `200`
|
|
167
|
+
- **Transport options**: None
|
|
168
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
169
|
+
|
|
170
|
+
**Inputs**
|
|
171
|
+
|
|
172
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
173
|
+
- Client transport options: None
|
|
174
|
+
|
|
175
|
+
**Outputs**
|
|
176
|
+
|
|
177
|
+
- Client return type: `{ id: string; name: string; description?: string | null; is_single_holder?: boolean }`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type AccountRelationshipDefinitionsUpdateInput = Parameters<typeof posthog.accountRelationshipDefinitionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type AccountRelationshipDefinitionsUpdateOutput = Awaited<ReturnType<typeof posthog.accountRelationshipDefinitionsUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: AccountRelationshipDefinitionsUpdateOutput = await posthog.accountRelationshipDefinitionsUpdate();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: string; name: string; description?: string | null; is_single_holder?: boolean }
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<!-- prompt-hash:
|
|
193
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
194
|
+
-->
|
package/docs/accounts.md
ADDED
|
@@ -0,0 +1,380 @@
|
|
|
1
|
+
# Accounts
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsAccountsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/accounts/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_accounts_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `account_executive`, `account_owner`, `all_roles_unassigned`, `csm`, `limit`, `offset`, `ordering`, `search`, `tags`
|
|
11
|
+
- **Response codes**: `200`
|
|
12
|
+
- **Transport options**: None
|
|
13
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
14
|
+
|
|
15
|
+
**Inputs**
|
|
16
|
+
|
|
17
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
18
|
+
- Client transport options: None
|
|
19
|
+
|
|
20
|
+
**Outputs**
|
|
21
|
+
|
|
22
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsAccountsListInput = Parameters<typeof posthog.environmentsAccountsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsAccountsListOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsAccountsListOutput = await posthog.environmentsAccountsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.environmentsAccountsCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/environments/{environment_id}/accounts/`
|
|
39
|
+
- **OpenAPI operationId**: `environments_accounts_create`
|
|
40
|
+
- **Path params**: None
|
|
41
|
+
- **Query params**: None
|
|
42
|
+
- **Response codes**: `201`
|
|
43
|
+
- **Transport options**: None
|
|
44
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
45
|
+
|
|
46
|
+
**Inputs**
|
|
47
|
+
|
|
48
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
49
|
+
- Client transport options: None
|
|
50
|
+
|
|
51
|
+
**Outputs**
|
|
52
|
+
|
|
53
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EnvironmentsAccountsCreateInput = Parameters<typeof posthog.environmentsAccountsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EnvironmentsAccountsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EnvironmentsAccountsCreateOutput = await posthog.environmentsAccountsCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.environmentsAccountsDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/accounts/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `environments_accounts_destroy`
|
|
71
|
+
- **Path params**: `id`
|
|
72
|
+
- **Query params**: None
|
|
73
|
+
- **Response codes**: `204`
|
|
74
|
+
- **Transport options**: None
|
|
75
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
76
|
+
|
|
77
|
+
**Inputs**
|
|
78
|
+
|
|
79
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
80
|
+
- Client transport options: None
|
|
81
|
+
|
|
82
|
+
**Outputs**
|
|
83
|
+
|
|
84
|
+
- Client return type: `unknown`
|
|
85
|
+
- OpenAPI response codes: `204`
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
import posthog from "@utdk/posthog";
|
|
89
|
+
|
|
90
|
+
type EnvironmentsAccountsDestroyInput = Parameters<typeof posthog.environmentsAccountsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type EnvironmentsAccountsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: EnvironmentsAccountsDestroyOutput = await posthog.environmentsAccountsDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.environmentsAccountsRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/environments/{environment_id}/accounts/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `environments_accounts_retrieve`
|
|
102
|
+
- **Path params**: `id`
|
|
103
|
+
- **Query params**: None
|
|
104
|
+
- **Response codes**: `200`
|
|
105
|
+
- **Transport options**: None
|
|
106
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
107
|
+
|
|
108
|
+
**Inputs**
|
|
109
|
+
|
|
110
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
111
|
+
- Client transport options: None
|
|
112
|
+
|
|
113
|
+
**Outputs**
|
|
114
|
+
|
|
115
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type EnvironmentsAccountsRetrieveInput = Parameters<typeof posthog.environmentsAccountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type EnvironmentsAccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: EnvironmentsAccountsRetrieveOutput = await posthog.environmentsAccountsRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.environmentsAccountsPartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/accounts/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `environments_accounts_partial_update`
|
|
133
|
+
- **Path params**: `id`
|
|
134
|
+
- **Query params**: None
|
|
135
|
+
- **Response codes**: `200`
|
|
136
|
+
- **Transport options**: None
|
|
137
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
138
|
+
|
|
139
|
+
**Inputs**
|
|
140
|
+
|
|
141
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
142
|
+
- Client transport options: None
|
|
143
|
+
|
|
144
|
+
**Outputs**
|
|
145
|
+
|
|
146
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type EnvironmentsAccountsPartialUpdateInput = Parameters<typeof posthog.environmentsAccountsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type EnvironmentsAccountsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsPartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: EnvironmentsAccountsPartialUpdateOutput = await posthog.environmentsAccountsPartialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.environmentsAccountsUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/accounts/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `environments_accounts_update`
|
|
164
|
+
- **Path params**: `id`
|
|
165
|
+
- **Query params**: None
|
|
166
|
+
- **Response codes**: `200`
|
|
167
|
+
- **Transport options**: None
|
|
168
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
169
|
+
|
|
170
|
+
**Inputs**
|
|
171
|
+
|
|
172
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
173
|
+
- Client transport options: None
|
|
174
|
+
|
|
175
|
+
**Outputs**
|
|
176
|
+
|
|
177
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type EnvironmentsAccountsUpdateInput = Parameters<typeof posthog.environmentsAccountsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type EnvironmentsAccountsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsAccountsUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: EnvironmentsAccountsUpdateOutput = await posthog.environmentsAccountsUpdate();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### `posthog.accountsList`
|
|
192
|
+
|
|
193
|
+
- **HTTP**: `GET /api/projects/{project_id}/accounts/`
|
|
194
|
+
- **OpenAPI operationId**: `accounts_list`
|
|
195
|
+
- **Path params**: None
|
|
196
|
+
- **Query params**: `account_executive`, `account_owner`, `all_roles_unassigned`, `csm`, `limit`, `offset`, `ordering`, `search`, `tags`
|
|
197
|
+
- **Response codes**: `200`
|
|
198
|
+
- **Transport options**: None
|
|
199
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
200
|
+
|
|
201
|
+
**Inputs**
|
|
202
|
+
|
|
203
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
204
|
+
- Client transport options: None
|
|
205
|
+
|
|
206
|
+
**Outputs**
|
|
207
|
+
|
|
208
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[...`
|
|
209
|
+
- OpenAPI response codes: `200`
|
|
210
|
+
|
|
211
|
+
```ts
|
|
212
|
+
import posthog from "@utdk/posthog";
|
|
213
|
+
|
|
214
|
+
type AccountsListInput = Parameters<typeof posthog.accountsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
215
|
+
type AccountsListOutput = Awaited<ReturnType<typeof posthog.accountsList>>;
|
|
216
|
+
|
|
217
|
+
const result: AccountsListOutput = await posthog.accountsList();
|
|
218
|
+
|
|
219
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[...
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### `posthog.accountsCreate`
|
|
223
|
+
|
|
224
|
+
- **HTTP**: `POST /api/projects/{project_id}/accounts/`
|
|
225
|
+
- **OpenAPI operationId**: `accounts_create`
|
|
226
|
+
- **Path params**: None
|
|
227
|
+
- **Query params**: None
|
|
228
|
+
- **Response codes**: `201`
|
|
229
|
+
- **Transport options**: None
|
|
230
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
231
|
+
|
|
232
|
+
**Inputs**
|
|
233
|
+
|
|
234
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
235
|
+
- Client transport options: None
|
|
236
|
+
|
|
237
|
+
**Outputs**
|
|
238
|
+
|
|
239
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
240
|
+
- OpenAPI response codes: `201`
|
|
241
|
+
|
|
242
|
+
```ts
|
|
243
|
+
import posthog from "@utdk/posthog";
|
|
244
|
+
|
|
245
|
+
type AccountsCreateInput = Parameters<typeof posthog.accountsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
246
|
+
type AccountsCreateOutput = Awaited<ReturnType<typeof posthog.accountsCreate>>;
|
|
247
|
+
|
|
248
|
+
const result: AccountsCreateOutput = await posthog.accountsCreate();
|
|
249
|
+
|
|
250
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### `posthog.accountsDestroy`
|
|
254
|
+
|
|
255
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/accounts/{id}/`
|
|
256
|
+
- **OpenAPI operationId**: `accounts_destroy`
|
|
257
|
+
- **Path params**: `id`
|
|
258
|
+
- **Query params**: None
|
|
259
|
+
- **Response codes**: `204`
|
|
260
|
+
- **Transport options**: None
|
|
261
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
262
|
+
|
|
263
|
+
**Inputs**
|
|
264
|
+
|
|
265
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
266
|
+
- Client transport options: None
|
|
267
|
+
|
|
268
|
+
**Outputs**
|
|
269
|
+
|
|
270
|
+
- Client return type: `unknown`
|
|
271
|
+
- OpenAPI response codes: `204`
|
|
272
|
+
|
|
273
|
+
```ts
|
|
274
|
+
import posthog from "@utdk/posthog";
|
|
275
|
+
|
|
276
|
+
type AccountsDestroyInput = Parameters<typeof posthog.accountsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
277
|
+
type AccountsDestroyOutput = Awaited<ReturnType<typeof posthog.accountsDestroy>>;
|
|
278
|
+
|
|
279
|
+
const result: AccountsDestroyOutput = await posthog.accountsDestroy();
|
|
280
|
+
|
|
281
|
+
// Result shape (from schema): unknown
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### `posthog.accountsRetrieve`
|
|
285
|
+
|
|
286
|
+
- **HTTP**: `GET /api/projects/{project_id}/accounts/{id}/`
|
|
287
|
+
- **OpenAPI operationId**: `accounts_retrieve`
|
|
288
|
+
- **Path params**: `id`
|
|
289
|
+
- **Query params**: None
|
|
290
|
+
- **Response codes**: `200`
|
|
291
|
+
- **Transport options**: None
|
|
292
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
293
|
+
|
|
294
|
+
**Inputs**
|
|
295
|
+
|
|
296
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
297
|
+
- Client transport options: None
|
|
298
|
+
|
|
299
|
+
**Outputs**
|
|
300
|
+
|
|
301
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
302
|
+
- OpenAPI response codes: `200`
|
|
303
|
+
|
|
304
|
+
```ts
|
|
305
|
+
import posthog from "@utdk/posthog";
|
|
306
|
+
|
|
307
|
+
type AccountsRetrieveInput = Parameters<typeof posthog.accountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
308
|
+
type AccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.accountsRetrieve>>;
|
|
309
|
+
|
|
310
|
+
const result: AccountsRetrieveOutput = await posthog.accountsRetrieve();
|
|
311
|
+
|
|
312
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### `posthog.accountsPartialUpdate`
|
|
316
|
+
|
|
317
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/accounts/{id}/`
|
|
318
|
+
- **OpenAPI operationId**: `accounts_partial_update`
|
|
319
|
+
- **Path params**: `id`
|
|
320
|
+
- **Query params**: None
|
|
321
|
+
- **Response codes**: `200`
|
|
322
|
+
- **Transport options**: None
|
|
323
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
324
|
+
|
|
325
|
+
**Inputs**
|
|
326
|
+
|
|
327
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
328
|
+
- Client transport options: None
|
|
329
|
+
|
|
330
|
+
**Outputs**
|
|
331
|
+
|
|
332
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
333
|
+
- OpenAPI response codes: `200`
|
|
334
|
+
|
|
335
|
+
```ts
|
|
336
|
+
import posthog from "@utdk/posthog";
|
|
337
|
+
|
|
338
|
+
type AccountsPartialUpdateInput = Parameters<typeof posthog.accountsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
339
|
+
type AccountsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.accountsPartialUpdate>>;
|
|
340
|
+
|
|
341
|
+
const result: AccountsPartialUpdateOutput = await posthog.accountsPartialUpdate();
|
|
342
|
+
|
|
343
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### `posthog.accountsUpdate`
|
|
347
|
+
|
|
348
|
+
- **HTTP**: `PUT /api/projects/{project_id}/accounts/{id}/`
|
|
349
|
+
- **OpenAPI operationId**: `accounts_update`
|
|
350
|
+
- **Path params**: `id`
|
|
351
|
+
- **Query params**: None
|
|
352
|
+
- **Response codes**: `200`
|
|
353
|
+
- **Transport options**: None
|
|
354
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
355
|
+
|
|
356
|
+
**Inputs**
|
|
357
|
+
|
|
358
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
359
|
+
- Client transport options: None
|
|
360
|
+
|
|
361
|
+
**Outputs**
|
|
362
|
+
|
|
363
|
+
- Client return type: `{ id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...`
|
|
364
|
+
- OpenAPI response codes: `200`
|
|
365
|
+
|
|
366
|
+
```ts
|
|
367
|
+
import posthog from "@utdk/posthog";
|
|
368
|
+
|
|
369
|
+
type AccountsUpdateInput = Parameters<typeof posthog.accountsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
370
|
+
type AccountsUpdateOutput = Awaited<ReturnType<typeof posthog.accountsUpdate>>;
|
|
371
|
+
|
|
372
|
+
const result: AccountsUpdateOutput = await posthog.accountsUpdate();
|
|
373
|
+
|
|
374
|
+
// Result shape (from schema): { id: string; name: string; external_id?: string | null; properties?: { [key: string]: unknown } | null; tags?: (string)[]; notebooks: (string)[]; created_at: string; created_by: number | null; updated_at: string | null...
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
<!-- prompt-hash:
|
|
379
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
380
|
+
-->
|