@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,2958 @@
|
|
|
1
|
+
# Organizations
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.list`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/organizations/`
|
|
8
|
+
- **OpenAPI operationId**: `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; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; p...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type ListInput = Parameters<typeof posthog.list> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type ListOutput = Awaited<ReturnType<typeof posthog.list>>;
|
|
30
|
+
|
|
31
|
+
const result: ListOutput = await posthog.list();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; p...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.create`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/organizations/`
|
|
39
|
+
- **OpenAPI operationId**: `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; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type CreateInput = Parameters<typeof posthog.create> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type CreateOutput = Awaited<ReturnType<typeof posthog.create>>;
|
|
61
|
+
|
|
62
|
+
const result: CreateOutput = await posthog.create();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.destroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/organizations/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `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 DestroyInput = Parameters<typeof posthog.destroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type DestroyOutput = Awaited<ReturnType<typeof posthog.destroy>>;
|
|
92
|
+
|
|
93
|
+
const result: DestroyOutput = await posthog.destroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.retrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/organizations/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `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; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type RetrieveInput = Parameters<typeof posthog.retrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type RetrieveOutput = Awaited<ReturnType<typeof posthog.retrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: RetrieveOutput = await posthog.retrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: string; name: string; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.partialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/organizations/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `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; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type PartialUpdateInput = Parameters<typeof posthog.partialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type PartialUpdateOutput = Awaited<ReturnType<typeof posthog.partialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: PartialUpdateOutput = await posthog.partialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: string; name: string; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.update`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/organizations/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `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; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type UpdateInput = Parameters<typeof posthog.update> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type UpdateOutput = Awaited<ReturnType<typeof posthog.update>>;
|
|
185
|
+
|
|
186
|
+
const result: UpdateOutput = await posthog.update();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: string; name: string; slug: string; logo_media_id?: string | null; created_at: string; updated_at: string; membership_level: 1 | 8 | 15; plugins_access_level: 0 | 3 | 6 | 9; teams: ({ [key: string]: unknown })[]; ...
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### `posthog.requestAiAccessCreate`
|
|
192
|
+
|
|
193
|
+
- **HTTP**: `POST /api/organizations/{id}/request_ai_access/`
|
|
194
|
+
- **What it does**: Notify organization admins that a member is requesting PostHog AI be enabled.
|
|
195
|
+
- **OpenAPI operationId**: `request_ai_access_create`
|
|
196
|
+
- **Path params**: `id`
|
|
197
|
+
- **Query params**: None
|
|
198
|
+
- **Response codes**: `200`
|
|
199
|
+
- **Transport options**: None
|
|
200
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
201
|
+
|
|
202
|
+
**Inputs**
|
|
203
|
+
|
|
204
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
205
|
+
- Client transport options: None
|
|
206
|
+
|
|
207
|
+
**Outputs**
|
|
208
|
+
|
|
209
|
+
- Client return type: `{ success: boolean }`
|
|
210
|
+
- OpenAPI response codes: `200`
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import posthog from "@utdk/posthog";
|
|
214
|
+
|
|
215
|
+
type RequestAiAccessCreateInput = Parameters<typeof posthog.requestAiAccessCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
216
|
+
type RequestAiAccessCreateOutput = Awaited<ReturnType<typeof posthog.requestAiAccessCreate>>;
|
|
217
|
+
|
|
218
|
+
const result: RequestAiAccessCreateOutput = await posthog.requestAiAccessCreate();
|
|
219
|
+
|
|
220
|
+
// Result shape (from schema): { success: boolean }
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### `posthog.cimdVerificationTokensList`
|
|
224
|
+
|
|
225
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/cimd_verification_tokens/`
|
|
226
|
+
- **What it does**: Manage CIMD verification tokens for an organization.
|
|
227
|
+
|
|
228
|
+
A partner embeds the plaintext token in their CIMD metadata document as
|
|
229
|
+
`verification_token` inside the `com.posthog` object (the legacy top-level
|
|
230
|
+
`posthog_verification_token` field still works as a fallback). When PostHog fetches
|
|
231
|
+
the metadata, matching the token links the partner app to this organization and
|
|
232
|
+
grants a higher default rate limit for account provisioning.
|
|
233
|
+
|
|
234
|
+
The plaintext value is only available on creation; we store a hash.
|
|
235
|
+
- **OpenAPI operationId**: `cimd_verification_tokens_list`
|
|
236
|
+
- **Path params**: None
|
|
237
|
+
- **Query params**: `limit`, `offset`
|
|
238
|
+
- **Response codes**: `200`
|
|
239
|
+
- **Transport options**: None
|
|
240
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
241
|
+
|
|
242
|
+
**Inputs**
|
|
243
|
+
|
|
244
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
245
|
+
- Client transport options: None
|
|
246
|
+
|
|
247
|
+
**Outputs**
|
|
248
|
+
|
|
249
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string...`
|
|
250
|
+
- OpenAPI response codes: `200`
|
|
251
|
+
|
|
252
|
+
```ts
|
|
253
|
+
import posthog from "@utdk/posthog";
|
|
254
|
+
|
|
255
|
+
type CimdVerificationTokensListInput = Parameters<typeof posthog.cimdVerificationTokensList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
256
|
+
type CimdVerificationTokensListOutput = Awaited<ReturnType<typeof posthog.cimdVerificationTokensList>>;
|
|
257
|
+
|
|
258
|
+
const result: CimdVerificationTokensListOutput = await posthog.cimdVerificationTokensList();
|
|
259
|
+
|
|
260
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string...
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### `posthog.cimdVerificationTokensCreate`
|
|
264
|
+
|
|
265
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/cimd_verification_tokens/`
|
|
266
|
+
- **What it does**: Manage CIMD verification tokens for an organization.
|
|
267
|
+
|
|
268
|
+
A partner embeds the plaintext token in their CIMD metadata document as
|
|
269
|
+
`verification_token` inside the `com.posthog` object (the legacy top-level
|
|
270
|
+
`posthog_verification_token` field still works as a fallback). When PostHog fetches
|
|
271
|
+
the metadata, matching the token links the partner app to this organization and
|
|
272
|
+
grants a higher default rate limit for account provisioning.
|
|
273
|
+
|
|
274
|
+
The plaintext value is only available on creation; we store a hash.
|
|
275
|
+
- **OpenAPI operationId**: `cimd_verification_tokens_create`
|
|
276
|
+
- **Path params**: None
|
|
277
|
+
- **Query params**: None
|
|
278
|
+
- **Response codes**: `201`
|
|
279
|
+
- **Transport options**: None
|
|
280
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
281
|
+
|
|
282
|
+
**Inputs**
|
|
283
|
+
|
|
284
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
285
|
+
- Client transport options: None
|
|
286
|
+
|
|
287
|
+
**Outputs**
|
|
288
|
+
|
|
289
|
+
- Client return type: `{ id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; he...`
|
|
290
|
+
- OpenAPI response codes: `201`
|
|
291
|
+
|
|
292
|
+
```ts
|
|
293
|
+
import posthog from "@utdk/posthog";
|
|
294
|
+
|
|
295
|
+
type CimdVerificationTokensCreateInput = Parameters<typeof posthog.cimdVerificationTokensCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
296
|
+
type CimdVerificationTokensCreateOutput = Awaited<ReturnType<typeof posthog.cimdVerificationTokensCreate>>;
|
|
297
|
+
|
|
298
|
+
const result: CimdVerificationTokensCreateOutput = await posthog.cimdVerificationTokensCreate();
|
|
299
|
+
|
|
300
|
+
// Result shape (from schema): { id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; he...
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### `posthog.cimdVerificationTokensDestroy`
|
|
304
|
+
|
|
305
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/cimd_verification_tokens/{id}/`
|
|
306
|
+
- **What it does**: Manage CIMD verification tokens for an organization.
|
|
307
|
+
|
|
308
|
+
A partner embeds the plaintext token in their CIMD metadata document as
|
|
309
|
+
`verification_token` inside the `com.posthog` object (the legacy top-level
|
|
310
|
+
`posthog_verification_token` field still works as a fallback). When PostHog fetches
|
|
311
|
+
the metadata, matching the token links the partner app to this organization and
|
|
312
|
+
grants a higher default rate limit for account provisioning.
|
|
313
|
+
|
|
314
|
+
The plaintext value is only available on creation; we store a hash.
|
|
315
|
+
- **OpenAPI operationId**: `cimd_verification_tokens_destroy`
|
|
316
|
+
- **Path params**: `id`
|
|
317
|
+
- **Query params**: None
|
|
318
|
+
- **Response codes**: `204`
|
|
319
|
+
- **Transport options**: None
|
|
320
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
321
|
+
|
|
322
|
+
**Inputs**
|
|
323
|
+
|
|
324
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
325
|
+
- Client transport options: None
|
|
326
|
+
|
|
327
|
+
**Outputs**
|
|
328
|
+
|
|
329
|
+
- Client return type: `unknown`
|
|
330
|
+
- OpenAPI response codes: `204`
|
|
331
|
+
|
|
332
|
+
```ts
|
|
333
|
+
import posthog from "@utdk/posthog";
|
|
334
|
+
|
|
335
|
+
type CimdVerificationTokensDestroyInput = Parameters<typeof posthog.cimdVerificationTokensDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
336
|
+
type CimdVerificationTokensDestroyOutput = Awaited<ReturnType<typeof posthog.cimdVerificationTokensDestroy>>;
|
|
337
|
+
|
|
338
|
+
const result: CimdVerificationTokensDestroyOutput = await posthog.cimdVerificationTokensDestroy();
|
|
339
|
+
|
|
340
|
+
// Result shape (from schema): unknown
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### `posthog.cimdVerificationTokensRetrieve`
|
|
344
|
+
|
|
345
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/cimd_verification_tokens/{id}/`
|
|
346
|
+
- **What it does**: Manage CIMD verification tokens for an organization.
|
|
347
|
+
|
|
348
|
+
A partner embeds the plaintext token in their CIMD metadata document as
|
|
349
|
+
`verification_token` inside the `com.posthog` object (the legacy top-level
|
|
350
|
+
`posthog_verification_token` field still works as a fallback). When PostHog fetches
|
|
351
|
+
the metadata, matching the token links the partner app to this organization and
|
|
352
|
+
grants a higher default rate limit for account provisioning.
|
|
353
|
+
|
|
354
|
+
The plaintext value is only available on creation; we store a hash.
|
|
355
|
+
- **OpenAPI operationId**: `cimd_verification_tokens_retrieve`
|
|
356
|
+
- **Path params**: `id`
|
|
357
|
+
- **Query params**: None
|
|
358
|
+
- **Response codes**: `200`
|
|
359
|
+
- **Transport options**: None
|
|
360
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
361
|
+
|
|
362
|
+
**Inputs**
|
|
363
|
+
|
|
364
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
365
|
+
- Client transport options: None
|
|
366
|
+
|
|
367
|
+
**Outputs**
|
|
368
|
+
|
|
369
|
+
- Client return type: `{ id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; he...`
|
|
370
|
+
- OpenAPI response codes: `200`
|
|
371
|
+
|
|
372
|
+
```ts
|
|
373
|
+
import posthog from "@utdk/posthog";
|
|
374
|
+
|
|
375
|
+
type CimdVerificationTokensRetrieveInput = Parameters<typeof posthog.cimdVerificationTokensRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
376
|
+
type CimdVerificationTokensRetrieveOutput = Awaited<ReturnType<typeof posthog.cimdVerificationTokensRetrieve>>;
|
|
377
|
+
|
|
378
|
+
const result: CimdVerificationTokensRetrieveOutput = await posthog.cimdVerificationTokensRetrieve();
|
|
379
|
+
|
|
380
|
+
// Result shape (from schema): { id: string; label: string; mask_value: string | null; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; he...
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
### `posthog.domainsList`
|
|
384
|
+
|
|
385
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/domains/`
|
|
386
|
+
- **OpenAPI operationId**: `domains_list`
|
|
387
|
+
- **Path params**: None
|
|
388
|
+
- **Query params**: `limit`, `offset`
|
|
389
|
+
- **Response codes**: `200`
|
|
390
|
+
- **Transport options**: None
|
|
391
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
392
|
+
|
|
393
|
+
**Inputs**
|
|
394
|
+
|
|
395
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
396
|
+
- Client transport options: None
|
|
397
|
+
|
|
398
|
+
**Outputs**
|
|
399
|
+
|
|
400
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boole...`
|
|
401
|
+
- OpenAPI response codes: `200`
|
|
402
|
+
|
|
403
|
+
```ts
|
|
404
|
+
import posthog from "@utdk/posthog";
|
|
405
|
+
|
|
406
|
+
type DomainsListInput = Parameters<typeof posthog.domainsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
407
|
+
type DomainsListOutput = Awaited<ReturnType<typeof posthog.domainsList>>;
|
|
408
|
+
|
|
409
|
+
const result: DomainsListOutput = await posthog.domainsList();
|
|
410
|
+
|
|
411
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boole...
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### `posthog.domainsCreate`
|
|
415
|
+
|
|
416
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/domains/`
|
|
417
|
+
- **OpenAPI operationId**: `domains_create`
|
|
418
|
+
- **Path params**: None
|
|
419
|
+
- **Query params**: None
|
|
420
|
+
- **Response codes**: `201`
|
|
421
|
+
- **Transport options**: None
|
|
422
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
423
|
+
|
|
424
|
+
**Inputs**
|
|
425
|
+
|
|
426
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
427
|
+
- Client transport options: None
|
|
428
|
+
|
|
429
|
+
**Outputs**
|
|
430
|
+
|
|
431
|
+
- Client return type: `{ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...`
|
|
432
|
+
- OpenAPI response codes: `201`
|
|
433
|
+
|
|
434
|
+
```ts
|
|
435
|
+
import posthog from "@utdk/posthog";
|
|
436
|
+
|
|
437
|
+
type DomainsCreateInput = Parameters<typeof posthog.domainsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
438
|
+
type DomainsCreateOutput = Awaited<ReturnType<typeof posthog.domainsCreate>>;
|
|
439
|
+
|
|
440
|
+
const result: DomainsCreateOutput = await posthog.domainsCreate();
|
|
441
|
+
|
|
442
|
+
// Result shape (from schema): { id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
### `posthog.domainsDestroy`
|
|
446
|
+
|
|
447
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/domains/{id}/`
|
|
448
|
+
- **OpenAPI operationId**: `domains_destroy`
|
|
449
|
+
- **Path params**: `id`
|
|
450
|
+
- **Query params**: None
|
|
451
|
+
- **Response codes**: `204`
|
|
452
|
+
- **Transport options**: None
|
|
453
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
454
|
+
|
|
455
|
+
**Inputs**
|
|
456
|
+
|
|
457
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
458
|
+
- Client transport options: None
|
|
459
|
+
|
|
460
|
+
**Outputs**
|
|
461
|
+
|
|
462
|
+
- Client return type: `unknown`
|
|
463
|
+
- OpenAPI response codes: `204`
|
|
464
|
+
|
|
465
|
+
```ts
|
|
466
|
+
import posthog from "@utdk/posthog";
|
|
467
|
+
|
|
468
|
+
type DomainsDestroyInput = Parameters<typeof posthog.domainsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
469
|
+
type DomainsDestroyOutput = Awaited<ReturnType<typeof posthog.domainsDestroy>>;
|
|
470
|
+
|
|
471
|
+
const result: DomainsDestroyOutput = await posthog.domainsDestroy();
|
|
472
|
+
|
|
473
|
+
// Result shape (from schema): unknown
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
### `posthog.domainsRetrieve`
|
|
477
|
+
|
|
478
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/domains/{id}/`
|
|
479
|
+
- **OpenAPI operationId**: `domains_retrieve`
|
|
480
|
+
- **Path params**: `id`
|
|
481
|
+
- **Query params**: None
|
|
482
|
+
- **Response codes**: `200`
|
|
483
|
+
- **Transport options**: None
|
|
484
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
485
|
+
|
|
486
|
+
**Inputs**
|
|
487
|
+
|
|
488
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
489
|
+
- Client transport options: None
|
|
490
|
+
|
|
491
|
+
**Outputs**
|
|
492
|
+
|
|
493
|
+
- Client return type: `{ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...`
|
|
494
|
+
- OpenAPI response codes: `200`
|
|
495
|
+
|
|
496
|
+
```ts
|
|
497
|
+
import posthog from "@utdk/posthog";
|
|
498
|
+
|
|
499
|
+
type DomainsRetrieveInput = Parameters<typeof posthog.domainsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
500
|
+
type DomainsRetrieveOutput = Awaited<ReturnType<typeof posthog.domainsRetrieve>>;
|
|
501
|
+
|
|
502
|
+
const result: DomainsRetrieveOutput = await posthog.domainsRetrieve();
|
|
503
|
+
|
|
504
|
+
// Result shape (from schema): { id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### `posthog.domainsPartialUpdate`
|
|
508
|
+
|
|
509
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/domains/{id}/`
|
|
510
|
+
- **OpenAPI operationId**: `domains_partial_update`
|
|
511
|
+
- **Path params**: `id`
|
|
512
|
+
- **Query params**: None
|
|
513
|
+
- **Response codes**: `200`
|
|
514
|
+
- **Transport options**: None
|
|
515
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
516
|
+
|
|
517
|
+
**Inputs**
|
|
518
|
+
|
|
519
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
520
|
+
- Client transport options: None
|
|
521
|
+
|
|
522
|
+
**Outputs**
|
|
523
|
+
|
|
524
|
+
- Client return type: `{ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...`
|
|
525
|
+
- OpenAPI response codes: `200`
|
|
526
|
+
|
|
527
|
+
```ts
|
|
528
|
+
import posthog from "@utdk/posthog";
|
|
529
|
+
|
|
530
|
+
type DomainsPartialUpdateInput = Parameters<typeof posthog.domainsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
531
|
+
type DomainsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.domainsPartialUpdate>>;
|
|
532
|
+
|
|
533
|
+
const result: DomainsPartialUpdateOutput = await posthog.domainsPartialUpdate();
|
|
534
|
+
|
|
535
|
+
// Result shape (from schema): { id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### `posthog.domainsUpdate`
|
|
539
|
+
|
|
540
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/domains/{id}/`
|
|
541
|
+
- **OpenAPI operationId**: `domains_update`
|
|
542
|
+
- **Path params**: `id`
|
|
543
|
+
- **Query params**: None
|
|
544
|
+
- **Response codes**: `200`
|
|
545
|
+
- **Transport options**: None
|
|
546
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
547
|
+
|
|
548
|
+
**Inputs**
|
|
549
|
+
|
|
550
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
551
|
+
- Client transport options: None
|
|
552
|
+
|
|
553
|
+
**Outputs**
|
|
554
|
+
|
|
555
|
+
- Client return type: `{ id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...`
|
|
556
|
+
- OpenAPI response codes: `200`
|
|
557
|
+
|
|
558
|
+
```ts
|
|
559
|
+
import posthog from "@utdk/posthog";
|
|
560
|
+
|
|
561
|
+
type DomainsUpdateInput = Parameters<typeof posthog.domainsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
562
|
+
type DomainsUpdateOutput = Awaited<ReturnType<typeof posthog.domainsUpdate>>;
|
|
563
|
+
|
|
564
|
+
const result: DomainsUpdateOutput = await posthog.domainsUpdate();
|
|
565
|
+
|
|
566
|
+
// Result shape (from schema): { id: string; domain: string; is_verified: boolean; verified_at: string | null; verification_challenge: string; jit_provisioning_enabled?: boolean; sso_enforcement?: string; has_saml: boolean; saml_entity_id?: string | ...
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
### `posthog.domainsScimLogsRetrieve`
|
|
570
|
+
|
|
571
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/domains/{id}/scim/logs/`
|
|
572
|
+
- **OpenAPI operationId**: `domains_scim_logs_retrieve`
|
|
573
|
+
- **Path params**: `id`
|
|
574
|
+
- **Query params**: None
|
|
575
|
+
- **Response codes**: `200`
|
|
576
|
+
- **Transport options**: None
|
|
577
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
578
|
+
|
|
579
|
+
**Inputs**
|
|
580
|
+
|
|
581
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
582
|
+
- Client transport options: None
|
|
583
|
+
|
|
584
|
+
**Outputs**
|
|
585
|
+
|
|
586
|
+
- Client return type: `unknown`
|
|
587
|
+
- OpenAPI response codes: `200`
|
|
588
|
+
|
|
589
|
+
```ts
|
|
590
|
+
import posthog from "@utdk/posthog";
|
|
591
|
+
|
|
592
|
+
type DomainsScimLogsRetrieveInput = Parameters<typeof posthog.domainsScimLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
593
|
+
type DomainsScimLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.domainsScimLogsRetrieve>>;
|
|
594
|
+
|
|
595
|
+
const result: DomainsScimLogsRetrieveOutput = await posthog.domainsScimLogsRetrieve();
|
|
596
|
+
|
|
597
|
+
// Result shape (from schema): unknown
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
### `posthog.domainsScimTokenCreate`
|
|
601
|
+
|
|
602
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/domains/{id}/scim/token/`
|
|
603
|
+
- **What it does**: Regenerate SCIM bearer token.
|
|
604
|
+
- **OpenAPI operationId**: `domains_scim_token_create`
|
|
605
|
+
- **Path params**: `id`
|
|
606
|
+
- **Query params**: None
|
|
607
|
+
- **Response codes**: `200`
|
|
608
|
+
- **Transport options**: None
|
|
609
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
610
|
+
|
|
611
|
+
**Inputs**
|
|
612
|
+
|
|
613
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
614
|
+
- Client transport options: None
|
|
615
|
+
|
|
616
|
+
**Outputs**
|
|
617
|
+
|
|
618
|
+
- Client return type: `unknown`
|
|
619
|
+
- OpenAPI response codes: `200`
|
|
620
|
+
|
|
621
|
+
```ts
|
|
622
|
+
import posthog from "@utdk/posthog";
|
|
623
|
+
|
|
624
|
+
type DomainsScimTokenCreateInput = Parameters<typeof posthog.domainsScimTokenCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
625
|
+
type DomainsScimTokenCreateOutput = Awaited<ReturnType<typeof posthog.domainsScimTokenCreate>>;
|
|
626
|
+
|
|
627
|
+
const result: DomainsScimTokenCreateOutput = await posthog.domainsScimTokenCreate();
|
|
628
|
+
|
|
629
|
+
// Result shape (from schema): unknown
|
|
630
|
+
```
|
|
631
|
+
|
|
632
|
+
### `posthog.domainsVerifyCreate`
|
|
633
|
+
|
|
634
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/domains/{id}/verify/`
|
|
635
|
+
- **OpenAPI operationId**: `domains_verify_create`
|
|
636
|
+
- **Path params**: `id`
|
|
637
|
+
- **Query params**: None
|
|
638
|
+
- **Response codes**: `200`
|
|
639
|
+
- **Transport options**: None
|
|
640
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
641
|
+
|
|
642
|
+
**Inputs**
|
|
643
|
+
|
|
644
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
645
|
+
- Client transport options: None
|
|
646
|
+
|
|
647
|
+
**Outputs**
|
|
648
|
+
|
|
649
|
+
- Client return type: `unknown`
|
|
650
|
+
- OpenAPI response codes: `200`
|
|
651
|
+
|
|
652
|
+
```ts
|
|
653
|
+
import posthog from "@utdk/posthog";
|
|
654
|
+
|
|
655
|
+
type DomainsVerifyCreateInput = Parameters<typeof posthog.domainsVerifyCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
656
|
+
type DomainsVerifyCreateOutput = Awaited<ReturnType<typeof posthog.domainsVerifyCreate>>;
|
|
657
|
+
|
|
658
|
+
const result: DomainsVerifyCreateOutput = await posthog.domainsVerifyCreate();
|
|
659
|
+
|
|
660
|
+
// Result shape (from schema): unknown
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
### `posthog.identityProviderConfigsList`
|
|
664
|
+
|
|
665
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/identity_provider_configs/`
|
|
666
|
+
- **OpenAPI operationId**: `identity_provider_configs_list`
|
|
667
|
+
- **Path params**: None
|
|
668
|
+
- **Query params**: `limit`, `offset`
|
|
669
|
+
- **Response codes**: `200`
|
|
670
|
+
- **Transport options**: None
|
|
671
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
672
|
+
|
|
673
|
+
**Inputs**
|
|
674
|
+
|
|
675
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
676
|
+
- Client transport options: None
|
|
677
|
+
|
|
678
|
+
**Outputs**
|
|
679
|
+
|
|
680
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | ...`
|
|
681
|
+
- OpenAPI response codes: `200`
|
|
682
|
+
|
|
683
|
+
```ts
|
|
684
|
+
import posthog from "@utdk/posthog";
|
|
685
|
+
|
|
686
|
+
type IdentityProviderConfigsListInput = Parameters<typeof posthog.identityProviderConfigsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
687
|
+
type IdentityProviderConfigsListOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsList>>;
|
|
688
|
+
|
|
689
|
+
const result: IdentityProviderConfigsListOutput = await posthog.identityProviderConfigsList();
|
|
690
|
+
|
|
691
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | ...
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
### `posthog.identityProviderConfigsCreate`
|
|
695
|
+
|
|
696
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/identity_provider_configs/`
|
|
697
|
+
- **OpenAPI operationId**: `identity_provider_configs_create`
|
|
698
|
+
- **Path params**: None
|
|
699
|
+
- **Query params**: None
|
|
700
|
+
- **Response codes**: `201`
|
|
701
|
+
- **Transport options**: None
|
|
702
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
703
|
+
|
|
704
|
+
**Inputs**
|
|
705
|
+
|
|
706
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
707
|
+
- Client transport options: None
|
|
708
|
+
|
|
709
|
+
**Outputs**
|
|
710
|
+
|
|
711
|
+
- Client return type: `{ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...`
|
|
712
|
+
- OpenAPI response codes: `201`
|
|
713
|
+
|
|
714
|
+
```ts
|
|
715
|
+
import posthog from "@utdk/posthog";
|
|
716
|
+
|
|
717
|
+
type IdentityProviderConfigsCreateInput = Parameters<typeof posthog.identityProviderConfigsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
718
|
+
type IdentityProviderConfigsCreateOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsCreate>>;
|
|
719
|
+
|
|
720
|
+
const result: IdentityProviderConfigsCreateOutput = await posthog.identityProviderConfigsCreate();
|
|
721
|
+
|
|
722
|
+
// Result shape (from schema): { id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
### `posthog.identityProviderConfigsDestroy`
|
|
726
|
+
|
|
727
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/identity_provider_configs/{id}/`
|
|
728
|
+
- **OpenAPI operationId**: `identity_provider_configs_destroy`
|
|
729
|
+
- **Path params**: `id`
|
|
730
|
+
- **Query params**: None
|
|
731
|
+
- **Response codes**: `204`
|
|
732
|
+
- **Transport options**: None
|
|
733
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
734
|
+
|
|
735
|
+
**Inputs**
|
|
736
|
+
|
|
737
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
738
|
+
- Client transport options: None
|
|
739
|
+
|
|
740
|
+
**Outputs**
|
|
741
|
+
|
|
742
|
+
- Client return type: `unknown`
|
|
743
|
+
- OpenAPI response codes: `204`
|
|
744
|
+
|
|
745
|
+
```ts
|
|
746
|
+
import posthog from "@utdk/posthog";
|
|
747
|
+
|
|
748
|
+
type IdentityProviderConfigsDestroyInput = Parameters<typeof posthog.identityProviderConfigsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
749
|
+
type IdentityProviderConfigsDestroyOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsDestroy>>;
|
|
750
|
+
|
|
751
|
+
const result: IdentityProviderConfigsDestroyOutput = await posthog.identityProviderConfigsDestroy();
|
|
752
|
+
|
|
753
|
+
// Result shape (from schema): unknown
|
|
754
|
+
```
|
|
755
|
+
|
|
756
|
+
### `posthog.identityProviderConfigsRetrieve`
|
|
757
|
+
|
|
758
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/identity_provider_configs/{id}/`
|
|
759
|
+
- **OpenAPI operationId**: `identity_provider_configs_retrieve`
|
|
760
|
+
- **Path params**: `id`
|
|
761
|
+
- **Query params**: None
|
|
762
|
+
- **Response codes**: `200`
|
|
763
|
+
- **Transport options**: None
|
|
764
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
765
|
+
|
|
766
|
+
**Inputs**
|
|
767
|
+
|
|
768
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
769
|
+
- Client transport options: None
|
|
770
|
+
|
|
771
|
+
**Outputs**
|
|
772
|
+
|
|
773
|
+
- Client return type: `{ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...`
|
|
774
|
+
- OpenAPI response codes: `200`
|
|
775
|
+
|
|
776
|
+
```ts
|
|
777
|
+
import posthog from "@utdk/posthog";
|
|
778
|
+
|
|
779
|
+
type IdentityProviderConfigsRetrieveInput = Parameters<typeof posthog.identityProviderConfigsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
780
|
+
type IdentityProviderConfigsRetrieveOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsRetrieve>>;
|
|
781
|
+
|
|
782
|
+
const result: IdentityProviderConfigsRetrieveOutput = await posthog.identityProviderConfigsRetrieve();
|
|
783
|
+
|
|
784
|
+
// Result shape (from schema): { id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
### `posthog.identityProviderConfigsPartialUpdate`
|
|
788
|
+
|
|
789
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/identity_provider_configs/{id}/`
|
|
790
|
+
- **OpenAPI operationId**: `identity_provider_configs_partial_update`
|
|
791
|
+
- **Path params**: `id`
|
|
792
|
+
- **Query params**: None
|
|
793
|
+
- **Response codes**: `200`
|
|
794
|
+
- **Transport options**: None
|
|
795
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
796
|
+
|
|
797
|
+
**Inputs**
|
|
798
|
+
|
|
799
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
800
|
+
- Client transport options: None
|
|
801
|
+
|
|
802
|
+
**Outputs**
|
|
803
|
+
|
|
804
|
+
- Client return type: `{ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...`
|
|
805
|
+
- OpenAPI response codes: `200`
|
|
806
|
+
|
|
807
|
+
```ts
|
|
808
|
+
import posthog from "@utdk/posthog";
|
|
809
|
+
|
|
810
|
+
type IdentityProviderConfigsPartialUpdateInput = Parameters<typeof posthog.identityProviderConfigsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
811
|
+
type IdentityProviderConfigsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsPartialUpdate>>;
|
|
812
|
+
|
|
813
|
+
const result: IdentityProviderConfigsPartialUpdateOutput = await posthog.identityProviderConfigsPartialUpdate();
|
|
814
|
+
|
|
815
|
+
// Result shape (from schema): { id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
### `posthog.identityProviderConfigsUpdate`
|
|
819
|
+
|
|
820
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/identity_provider_configs/{id}/`
|
|
821
|
+
- **OpenAPI operationId**: `identity_provider_configs_update`
|
|
822
|
+
- **Path params**: `id`
|
|
823
|
+
- **Query params**: None
|
|
824
|
+
- **Response codes**: `200`
|
|
825
|
+
- **Transport options**: None
|
|
826
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
827
|
+
|
|
828
|
+
**Inputs**
|
|
829
|
+
|
|
830
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
831
|
+
- Client transport options: None
|
|
832
|
+
|
|
833
|
+
**Outputs**
|
|
834
|
+
|
|
835
|
+
- Client return type: `{ id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...`
|
|
836
|
+
- OpenAPI response codes: `200`
|
|
837
|
+
|
|
838
|
+
```ts
|
|
839
|
+
import posthog from "@utdk/posthog";
|
|
840
|
+
|
|
841
|
+
type IdentityProviderConfigsUpdateInput = Parameters<typeof posthog.identityProviderConfigsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
842
|
+
type IdentityProviderConfigsUpdateOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsUpdate>>;
|
|
843
|
+
|
|
844
|
+
const result: IdentityProviderConfigsUpdateOutput = await posthog.identityProviderConfigsUpdate();
|
|
845
|
+
|
|
846
|
+
// Result shape (from schema): { id: string; name?: string; created_at: string; updated_at: string; has_saml: boolean; saml_entity_id?: string | null; saml_acs_url?: string | null; saml_x509_cert?: string | null; has_scim: boolean; scim_enabled?: boo...
|
|
847
|
+
```
|
|
848
|
+
|
|
849
|
+
### `posthog.identityProviderConfigsScimTokenCreate`
|
|
850
|
+
|
|
851
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/identity_provider_configs/{id}/scim/token/`
|
|
852
|
+
- **What it does**: Regenerate the SCIM bearer token for this IdP config.
|
|
853
|
+
- **OpenAPI operationId**: `identity_provider_configs_scim_token_create`
|
|
854
|
+
- **Path params**: `id`
|
|
855
|
+
- **Query params**: None
|
|
856
|
+
- **Response codes**: `200`
|
|
857
|
+
- **Transport options**: None
|
|
858
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
859
|
+
|
|
860
|
+
**Inputs**
|
|
861
|
+
|
|
862
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
863
|
+
- Client transport options: None
|
|
864
|
+
|
|
865
|
+
**Outputs**
|
|
866
|
+
|
|
867
|
+
- Client return type: `{ scim_enabled: boolean; scim_bearer_token: string }`
|
|
868
|
+
- OpenAPI response codes: `200`
|
|
869
|
+
|
|
870
|
+
```ts
|
|
871
|
+
import posthog from "@utdk/posthog";
|
|
872
|
+
|
|
873
|
+
type IdentityProviderConfigsScimTokenCreateInput = Parameters<typeof posthog.identityProviderConfigsScimTokenCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
874
|
+
type IdentityProviderConfigsScimTokenCreateOutput = Awaited<ReturnType<typeof posthog.identityProviderConfigsScimTokenCreate>>;
|
|
875
|
+
|
|
876
|
+
const result: IdentityProviderConfigsScimTokenCreateOutput = await posthog.identityProviderConfigsScimTokenCreate();
|
|
877
|
+
|
|
878
|
+
// Result shape (from schema): { scim_enabled: boolean; scim_bearer_token: string }
|
|
879
|
+
```
|
|
880
|
+
|
|
881
|
+
### `posthog.orgOrganizationsIntegrationsList`
|
|
882
|
+
|
|
883
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/integrations/`
|
|
884
|
+
- **What it does**: ViewSet for organization-level integrations.
|
|
885
|
+
|
|
886
|
+
Provides access to integrations that are scoped to the entire organization
|
|
887
|
+
(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
|
|
888
|
+
|
|
889
|
+
Creation is handled by the integration installation flows
|
|
890
|
+
(e.g., Vercel marketplace installation). Users can disconnect integrations
|
|
891
|
+
via the DELETE endpoint.
|
|
892
|
+
- **OpenAPI operationId**: `org_organizations_integrations_list`
|
|
893
|
+
- **Path params**: None
|
|
894
|
+
- **Query params**: `limit`, `offset`
|
|
895
|
+
- **Response codes**: `200`
|
|
896
|
+
- **Transport options**: None
|
|
897
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
898
|
+
|
|
899
|
+
**Inputs**
|
|
900
|
+
|
|
901
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
902
|
+
- Client transport options: None
|
|
903
|
+
|
|
904
|
+
**Outputs**
|
|
905
|
+
|
|
906
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; ...`
|
|
907
|
+
- OpenAPI response codes: `200`
|
|
908
|
+
|
|
909
|
+
```ts
|
|
910
|
+
import posthog from "@utdk/posthog";
|
|
911
|
+
|
|
912
|
+
type OrgOrganizationsIntegrationsListInput = Parameters<typeof posthog.orgOrganizationsIntegrationsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
913
|
+
type OrgOrganizationsIntegrationsListOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsIntegrationsList>>;
|
|
914
|
+
|
|
915
|
+
const result: OrgOrganizationsIntegrationsListOutput = await posthog.orgOrganizationsIntegrationsList();
|
|
916
|
+
|
|
917
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; ...
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
### `posthog.orgOrganizationIntegrationsDestroy`
|
|
921
|
+
|
|
922
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/integrations/{id}/`
|
|
923
|
+
- **What it does**: ViewSet for organization-level integrations.
|
|
924
|
+
|
|
925
|
+
Provides access to integrations that are scoped to the entire organization
|
|
926
|
+
(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
|
|
927
|
+
|
|
928
|
+
Creation is handled by the integration installation flows
|
|
929
|
+
(e.g., Vercel marketplace installation). Users can disconnect integrations
|
|
930
|
+
via the DELETE endpoint.
|
|
931
|
+
- **OpenAPI operationId**: `org_organization_integrations_destroy`
|
|
932
|
+
- **Path params**: `id`
|
|
933
|
+
- **Query params**: None
|
|
934
|
+
- **Response codes**: `204`, `409`
|
|
935
|
+
- **Transport options**: None
|
|
936
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
937
|
+
|
|
938
|
+
**Inputs**
|
|
939
|
+
|
|
940
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
941
|
+
- Client transport options: None
|
|
942
|
+
|
|
943
|
+
**Outputs**
|
|
944
|
+
|
|
945
|
+
- Client return type: `unknown`
|
|
946
|
+
- OpenAPI response codes: `204`, `409`
|
|
947
|
+
|
|
948
|
+
```ts
|
|
949
|
+
import posthog from "@utdk/posthog";
|
|
950
|
+
|
|
951
|
+
type OrgOrganizationIntegrationsDestroyInput = Parameters<typeof posthog.orgOrganizationIntegrationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
952
|
+
type OrgOrganizationIntegrationsDestroyOutput = Awaited<ReturnType<typeof posthog.orgOrganizationIntegrationsDestroy>>;
|
|
953
|
+
|
|
954
|
+
const result: OrgOrganizationIntegrationsDestroyOutput = await posthog.orgOrganizationIntegrationsDestroy();
|
|
955
|
+
|
|
956
|
+
// Result shape (from schema): unknown
|
|
957
|
+
```
|
|
958
|
+
|
|
959
|
+
### `posthog.orgOrganizationsIntegrationsRetrieve`
|
|
960
|
+
|
|
961
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/integrations/{id}/`
|
|
962
|
+
- **What it does**: ViewSet for organization-level integrations.
|
|
963
|
+
|
|
964
|
+
Provides access to integrations that are scoped to the entire organization
|
|
965
|
+
(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
|
|
966
|
+
|
|
967
|
+
Creation is handled by the integration installation flows
|
|
968
|
+
(e.g., Vercel marketplace installation). Users can disconnect integrations
|
|
969
|
+
via the DELETE endpoint.
|
|
970
|
+
- **OpenAPI operationId**: `org_organizations_integrations_retrieve`
|
|
971
|
+
- **Path params**: `id`
|
|
972
|
+
- **Query params**: None
|
|
973
|
+
- **Response codes**: `200`
|
|
974
|
+
- **Transport options**: None
|
|
975
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
976
|
+
|
|
977
|
+
**Inputs**
|
|
978
|
+
|
|
979
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
980
|
+
- Client transport options: None
|
|
981
|
+
|
|
982
|
+
**Outputs**
|
|
983
|
+
|
|
984
|
+
- Client return type: `{ id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...`
|
|
985
|
+
- OpenAPI response codes: `200`
|
|
986
|
+
|
|
987
|
+
```ts
|
|
988
|
+
import posthog from "@utdk/posthog";
|
|
989
|
+
|
|
990
|
+
type OrgOrganizationsIntegrationsRetrieveInput = Parameters<typeof posthog.orgOrganizationsIntegrationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
991
|
+
type OrgOrganizationsIntegrationsRetrieveOutput = Awaited<ReturnType<typeof posthog.orgOrganizationsIntegrationsRetrieve>>;
|
|
992
|
+
|
|
993
|
+
const result: OrgOrganizationsIntegrationsRetrieveOutput = await posthog.orgOrganizationsIntegrationsRetrieve();
|
|
994
|
+
|
|
995
|
+
// Result shape (from schema): { id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### `posthog.integrationsEnvironmentMappingPartialUpdate`
|
|
999
|
+
|
|
1000
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/integrations/{id}/environment-mapping/`
|
|
1001
|
+
- **What it does**: ViewSet for organization-level integrations.
|
|
1002
|
+
|
|
1003
|
+
Provides access to integrations that are scoped to the entire organization
|
|
1004
|
+
(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.
|
|
1005
|
+
|
|
1006
|
+
Creation is handled by the integration installation flows
|
|
1007
|
+
(e.g., Vercel marketplace installation). Users can disconnect integrations
|
|
1008
|
+
via the DELETE endpoint.
|
|
1009
|
+
- **OpenAPI operationId**: `integrations_environment_mapping_partial_update`
|
|
1010
|
+
- **Path params**: `id`
|
|
1011
|
+
- **Query params**: None
|
|
1012
|
+
- **Response codes**: `200`
|
|
1013
|
+
- **Transport options**: None
|
|
1014
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1015
|
+
|
|
1016
|
+
**Inputs**
|
|
1017
|
+
|
|
1018
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1019
|
+
- Client transport options: None
|
|
1020
|
+
|
|
1021
|
+
**Outputs**
|
|
1022
|
+
|
|
1023
|
+
- Client return type: `{ id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...`
|
|
1024
|
+
- OpenAPI response codes: `200`
|
|
1025
|
+
|
|
1026
|
+
```ts
|
|
1027
|
+
import posthog from "@utdk/posthog";
|
|
1028
|
+
|
|
1029
|
+
type IntegrationsEnvironmentMappingPartialUpdateInput = Parameters<typeof posthog.integrationsEnvironmentMappingPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1030
|
+
type IntegrationsEnvironmentMappingPartialUpdateOutput = Awaited<ReturnType<typeof posthog.integrationsEnvironmentMappingPartialUpdate>>;
|
|
1031
|
+
|
|
1032
|
+
const result: IntegrationsEnvironmentMappingPartialUpdateOutput = await posthog.integrationsEnvironmentMappingPartialUpdate();
|
|
1033
|
+
|
|
1034
|
+
// Result shape (from schema): { id: string; kind: "vercel"; integration_id: string | null; config: unknown; created_at: string; updated_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?:...
|
|
1035
|
+
```
|
|
1036
|
+
|
|
1037
|
+
### `posthog.invitesList`
|
|
1038
|
+
|
|
1039
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/invites/`
|
|
1040
|
+
- **OpenAPI operationId**: `invites_list`
|
|
1041
|
+
- **Path params**: None
|
|
1042
|
+
- **Query params**: `limit`, `offset`
|
|
1043
|
+
- **Response codes**: `200`
|
|
1044
|
+
- **Transport options**: None
|
|
1045
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1046
|
+
|
|
1047
|
+
**Inputs**
|
|
1048
|
+
|
|
1049
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1050
|
+
- Client transport options: None
|
|
1051
|
+
|
|
1052
|
+
**Outputs**
|
|
1053
|
+
|
|
1054
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { ...`
|
|
1055
|
+
- OpenAPI response codes: `200`
|
|
1056
|
+
|
|
1057
|
+
```ts
|
|
1058
|
+
import posthog from "@utdk/posthog";
|
|
1059
|
+
|
|
1060
|
+
type InvitesListInput = Parameters<typeof posthog.invitesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1061
|
+
type InvitesListOutput = Awaited<ReturnType<typeof posthog.invitesList>>;
|
|
1062
|
+
|
|
1063
|
+
const result: InvitesListOutput = await posthog.invitesList();
|
|
1064
|
+
|
|
1065
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { ...
|
|
1066
|
+
```
|
|
1067
|
+
|
|
1068
|
+
### `posthog.invitesCreate`
|
|
1069
|
+
|
|
1070
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/invites/`
|
|
1071
|
+
- **OpenAPI operationId**: `invites_create`
|
|
1072
|
+
- **Path params**: None
|
|
1073
|
+
- **Query params**: None
|
|
1074
|
+
- **Response codes**: `201`
|
|
1075
|
+
- **Transport options**: None
|
|
1076
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1077
|
+
|
|
1078
|
+
**Inputs**
|
|
1079
|
+
|
|
1080
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1081
|
+
- Client transport options: None
|
|
1082
|
+
|
|
1083
|
+
**Outputs**
|
|
1084
|
+
|
|
1085
|
+
- Client return type: `{ id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string;...`
|
|
1086
|
+
- OpenAPI response codes: `201`
|
|
1087
|
+
|
|
1088
|
+
```ts
|
|
1089
|
+
import posthog from "@utdk/posthog";
|
|
1090
|
+
|
|
1091
|
+
type InvitesCreateInput = Parameters<typeof posthog.invitesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1092
|
+
type InvitesCreateOutput = Awaited<ReturnType<typeof posthog.invitesCreate>>;
|
|
1093
|
+
|
|
1094
|
+
const result: InvitesCreateOutput = await posthog.invitesCreate();
|
|
1095
|
+
|
|
1096
|
+
// Result shape (from schema): { id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string;...
|
|
1097
|
+
```
|
|
1098
|
+
|
|
1099
|
+
### `posthog.invitesDestroy`
|
|
1100
|
+
|
|
1101
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/invites/{id}/`
|
|
1102
|
+
- **OpenAPI operationId**: `invites_destroy`
|
|
1103
|
+
- **Path params**: `id`
|
|
1104
|
+
- **Query params**: None
|
|
1105
|
+
- **Response codes**: `204`
|
|
1106
|
+
- **Transport options**: None
|
|
1107
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1108
|
+
|
|
1109
|
+
**Inputs**
|
|
1110
|
+
|
|
1111
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1112
|
+
- Client transport options: None
|
|
1113
|
+
|
|
1114
|
+
**Outputs**
|
|
1115
|
+
|
|
1116
|
+
- Client return type: `unknown`
|
|
1117
|
+
- OpenAPI response codes: `204`
|
|
1118
|
+
|
|
1119
|
+
```ts
|
|
1120
|
+
import posthog from "@utdk/posthog";
|
|
1121
|
+
|
|
1122
|
+
type InvitesDestroyInput = Parameters<typeof posthog.invitesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1123
|
+
type InvitesDestroyOutput = Awaited<ReturnType<typeof posthog.invitesDestroy>>;
|
|
1124
|
+
|
|
1125
|
+
const result: InvitesDestroyOutput = await posthog.invitesDestroy();
|
|
1126
|
+
|
|
1127
|
+
// Result shape (from schema): unknown
|
|
1128
|
+
```
|
|
1129
|
+
|
|
1130
|
+
### `posthog.invitesBulkCreate`
|
|
1131
|
+
|
|
1132
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/invites/bulk/`
|
|
1133
|
+
- **OpenAPI operationId**: `invites_bulk_create`
|
|
1134
|
+
- **Path params**: None
|
|
1135
|
+
- **Query params**: None
|
|
1136
|
+
- **Response codes**: `200`
|
|
1137
|
+
- **Transport options**: None
|
|
1138
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1139
|
+
|
|
1140
|
+
**Inputs**
|
|
1141
|
+
|
|
1142
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1143
|
+
- Client transport options: None
|
|
1144
|
+
|
|
1145
|
+
**Outputs**
|
|
1146
|
+
|
|
1147
|
+
- Client return type: `unknown`
|
|
1148
|
+
- OpenAPI response codes: `200`
|
|
1149
|
+
|
|
1150
|
+
```ts
|
|
1151
|
+
import posthog from "@utdk/posthog";
|
|
1152
|
+
|
|
1153
|
+
type InvitesBulkCreateInput = Parameters<typeof posthog.invitesBulkCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1154
|
+
type InvitesBulkCreateOutput = Awaited<ReturnType<typeof posthog.invitesBulkCreate>>;
|
|
1155
|
+
|
|
1156
|
+
const result: InvitesBulkCreateOutput = await posthog.invitesBulkCreate();
|
|
1157
|
+
|
|
1158
|
+
// Result shape (from schema): unknown
|
|
1159
|
+
```
|
|
1160
|
+
|
|
1161
|
+
### `posthog.invitesDelegateCreate`
|
|
1162
|
+
|
|
1163
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/invites/delegate/`
|
|
1164
|
+
- **What it does**: Create an onboarding delegation invite: an admin-level invite flagged as a setup delegation.
|
|
1165
|
+
Sends a single dedicated delegation email and records the inviting user as having delegated.
|
|
1166
|
+
- **OpenAPI operationId**: `invites_delegate_create`
|
|
1167
|
+
- **Path params**: None
|
|
1168
|
+
- **Query params**: None
|
|
1169
|
+
- **Response codes**: `200`
|
|
1170
|
+
- **Transport options**: None
|
|
1171
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1172
|
+
|
|
1173
|
+
**Inputs**
|
|
1174
|
+
|
|
1175
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1176
|
+
- Client transport options: None
|
|
1177
|
+
|
|
1178
|
+
**Outputs**
|
|
1179
|
+
|
|
1180
|
+
- Client return type: `{ id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string;...`
|
|
1181
|
+
- OpenAPI response codes: `200`
|
|
1182
|
+
|
|
1183
|
+
```ts
|
|
1184
|
+
import posthog from "@utdk/posthog";
|
|
1185
|
+
|
|
1186
|
+
type InvitesDelegateCreateInput = Parameters<typeof posthog.invitesDelegateCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1187
|
+
type InvitesDelegateCreateOutput = Awaited<ReturnType<typeof posthog.invitesDelegateCreate>>;
|
|
1188
|
+
|
|
1189
|
+
const result: InvitesDelegateCreateOutput = await posthog.invitesDelegateCreate();
|
|
1190
|
+
|
|
1191
|
+
// Result shape (from schema): { id: string; target_email: string; first_name?: string; emailing_attempt_made: boolean; level?: 1 | 8 | 15; is_expired: boolean; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string;...
|
|
1192
|
+
```
|
|
1193
|
+
|
|
1194
|
+
### `posthog.legalDocumentsList`
|
|
1195
|
+
|
|
1196
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/legal_documents/`
|
|
1197
|
+
- **OpenAPI operationId**: `legal_documents_list`
|
|
1198
|
+
- **Path params**: None
|
|
1199
|
+
- **Query params**: `limit`, `offset`
|
|
1200
|
+
- **Response codes**: `200`
|
|
1201
|
+
- **Transport options**: None
|
|
1202
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1203
|
+
|
|
1204
|
+
**Inputs**
|
|
1205
|
+
|
|
1206
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1207
|
+
- Client transport options: None
|
|
1208
|
+
|
|
1209
|
+
**Outputs**
|
|
1210
|
+
|
|
1211
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email...`
|
|
1212
|
+
- OpenAPI response codes: `200`
|
|
1213
|
+
|
|
1214
|
+
```ts
|
|
1215
|
+
import posthog from "@utdk/posthog";
|
|
1216
|
+
|
|
1217
|
+
type LegalDocumentsListInput = Parameters<typeof posthog.legalDocumentsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1218
|
+
type LegalDocumentsListOutput = Awaited<ReturnType<typeof posthog.legalDocumentsList>>;
|
|
1219
|
+
|
|
1220
|
+
const result: LegalDocumentsListOutput = await posthog.legalDocumentsList();
|
|
1221
|
+
|
|
1222
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email...
|
|
1223
|
+
```
|
|
1224
|
+
|
|
1225
|
+
### `posthog.legalDocumentsCreate`
|
|
1226
|
+
|
|
1227
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/legal_documents/`
|
|
1228
|
+
- **OpenAPI operationId**: `legal_documents_create`
|
|
1229
|
+
- **Path params**: None
|
|
1230
|
+
- **Query params**: None
|
|
1231
|
+
- **Response codes**: `201`
|
|
1232
|
+
- **Transport options**: None
|
|
1233
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1234
|
+
|
|
1235
|
+
**Inputs**
|
|
1236
|
+
|
|
1237
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1238
|
+
- Client transport options: None
|
|
1239
|
+
|
|
1240
|
+
**Outputs**
|
|
1241
|
+
|
|
1242
|
+
- Client return type: `{ id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email: string } | null; created_at: string }`
|
|
1243
|
+
- OpenAPI response codes: `201`
|
|
1244
|
+
|
|
1245
|
+
```ts
|
|
1246
|
+
import posthog from "@utdk/posthog";
|
|
1247
|
+
|
|
1248
|
+
type LegalDocumentsCreateInput = Parameters<typeof posthog.legalDocumentsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1249
|
+
type LegalDocumentsCreateOutput = Awaited<ReturnType<typeof posthog.legalDocumentsCreate>>;
|
|
1250
|
+
|
|
1251
|
+
const result: LegalDocumentsCreateOutput = await posthog.legalDocumentsCreate();
|
|
1252
|
+
|
|
1253
|
+
// Result shape (from schema): { id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email: string } | null; created_at: string }
|
|
1254
|
+
```
|
|
1255
|
+
|
|
1256
|
+
### `posthog.legalDocumentsDestroy`
|
|
1257
|
+
|
|
1258
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/legal_documents/{id}/`
|
|
1259
|
+
- **What it does**: Delete an unsigned legal document. The PandaDoc envelope is voided
|
|
1260
|
+
first so the original signer can no longer complete it; only if that
|
|
1261
|
+
succeeds is the row removed, freeing the unique-per-org-per-type
|
|
1262
|
+
constraint so a fresh document can be generated.
|
|
1263
|
+
|
|
1264
|
+
Returns 503 if the PandaDoc void fails — the row stays in that case
|
|
1265
|
+
and the frontend should prompt the user to retry. Returns 403 for
|
|
1266
|
+
signed documents (legal artifacts; staff can still delete signed
|
|
1267
|
+
rows from Django admin).
|
|
1268
|
+
- **OpenAPI operationId**: `legal_documents_destroy`
|
|
1269
|
+
- **Path params**: `id`
|
|
1270
|
+
- **Query params**: None
|
|
1271
|
+
- **Response codes**: `204`, `403`, `404`, `503`
|
|
1272
|
+
- **Transport options**: None
|
|
1273
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1274
|
+
|
|
1275
|
+
**Inputs**
|
|
1276
|
+
|
|
1277
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1278
|
+
- Client transport options: None
|
|
1279
|
+
|
|
1280
|
+
**Outputs**
|
|
1281
|
+
|
|
1282
|
+
- Client return type: `unknown`
|
|
1283
|
+
- OpenAPI response codes: `204`, `403`, `404`, `503`
|
|
1284
|
+
|
|
1285
|
+
```ts
|
|
1286
|
+
import posthog from "@utdk/posthog";
|
|
1287
|
+
|
|
1288
|
+
type LegalDocumentsDestroyInput = Parameters<typeof posthog.legalDocumentsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1289
|
+
type LegalDocumentsDestroyOutput = Awaited<ReturnType<typeof posthog.legalDocumentsDestroy>>;
|
|
1290
|
+
|
|
1291
|
+
const result: LegalDocumentsDestroyOutput = await posthog.legalDocumentsDestroy();
|
|
1292
|
+
|
|
1293
|
+
// Result shape (from schema): unknown
|
|
1294
|
+
```
|
|
1295
|
+
|
|
1296
|
+
### `posthog.legalDocumentsRetrieve`
|
|
1297
|
+
|
|
1298
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/legal_documents/{id}/`
|
|
1299
|
+
- **OpenAPI operationId**: `legal_documents_retrieve`
|
|
1300
|
+
- **Path params**: `id`
|
|
1301
|
+
- **Query params**: None
|
|
1302
|
+
- **Response codes**: `200`
|
|
1303
|
+
- **Transport options**: None
|
|
1304
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1305
|
+
|
|
1306
|
+
**Inputs**
|
|
1307
|
+
|
|
1308
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1309
|
+
- Client transport options: None
|
|
1310
|
+
|
|
1311
|
+
**Outputs**
|
|
1312
|
+
|
|
1313
|
+
- Client return type: `{ id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email: string } | null; created_at: string }`
|
|
1314
|
+
- OpenAPI response codes: `200`
|
|
1315
|
+
|
|
1316
|
+
```ts
|
|
1317
|
+
import posthog from "@utdk/posthog";
|
|
1318
|
+
|
|
1319
|
+
type LegalDocumentsRetrieveInput = Parameters<typeof posthog.legalDocumentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1320
|
+
type LegalDocumentsRetrieveOutput = Awaited<ReturnType<typeof posthog.legalDocumentsRetrieve>>;
|
|
1321
|
+
|
|
1322
|
+
const result: LegalDocumentsRetrieveOutput = await posthog.legalDocumentsRetrieve();
|
|
1323
|
+
|
|
1324
|
+
// Result shape (from schema): { id: string; document_type: string; company_name: string; representative_email: string; status: string; created_by: { first_name: string; email: string } | null; created_at: string }
|
|
1325
|
+
```
|
|
1326
|
+
|
|
1327
|
+
### `posthog.legalDocumentsDownloadRetrieve`
|
|
1328
|
+
|
|
1329
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/legal_documents/{id}/download/`
|
|
1330
|
+
- **What it does**: Short-lived redirect to the signed PDF in object storage. 404 while the
|
|
1331
|
+
envelope is still out for signature (or if the upload hasn't completed
|
|
1332
|
+
yet). The underlying presigned URL expires in ~60s; clients should hit
|
|
1333
|
+
this endpoint each time they want to view the PDF rather than caching.
|
|
1334
|
+
- **OpenAPI operationId**: `legal_documents_download_retrieve`
|
|
1335
|
+
- **Path params**: `id`
|
|
1336
|
+
- **Query params**: None
|
|
1337
|
+
- **Response codes**: `302`, `404`
|
|
1338
|
+
- **Transport options**: None
|
|
1339
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1340
|
+
|
|
1341
|
+
**Inputs**
|
|
1342
|
+
|
|
1343
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1344
|
+
- Client transport options: None
|
|
1345
|
+
|
|
1346
|
+
**Outputs**
|
|
1347
|
+
|
|
1348
|
+
- Client return type: `unknown`
|
|
1349
|
+
- OpenAPI response codes: `302`, `404`
|
|
1350
|
+
|
|
1351
|
+
```ts
|
|
1352
|
+
import posthog from "@utdk/posthog";
|
|
1353
|
+
|
|
1354
|
+
type LegalDocumentsDownloadRetrieveInput = Parameters<typeof posthog.legalDocumentsDownloadRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1355
|
+
type LegalDocumentsDownloadRetrieveOutput = Awaited<ReturnType<typeof posthog.legalDocumentsDownloadRetrieve>>;
|
|
1356
|
+
|
|
1357
|
+
const result: LegalDocumentsDownloadRetrieveOutput = await posthog.legalDocumentsDownloadRetrieve();
|
|
1358
|
+
|
|
1359
|
+
// Result shape (from schema): unknown
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### `posthog.membersList`
|
|
1363
|
+
|
|
1364
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/members/`
|
|
1365
|
+
- **OpenAPI operationId**: `members_list`
|
|
1366
|
+
- **Path params**: None
|
|
1367
|
+
- **Query params**: `limit`, `offset`, `order`, `search`
|
|
1368
|
+
- **Response codes**: `200`
|
|
1369
|
+
- **Transport options**: None
|
|
1370
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1371
|
+
|
|
1372
|
+
**Inputs**
|
|
1373
|
+
|
|
1374
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1375
|
+
- Client transport options: None
|
|
1376
|
+
|
|
1377
|
+
**Outputs**
|
|
1378
|
+
|
|
1379
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...`
|
|
1380
|
+
- OpenAPI response codes: `200`
|
|
1381
|
+
|
|
1382
|
+
```ts
|
|
1383
|
+
import posthog from "@utdk/posthog";
|
|
1384
|
+
|
|
1385
|
+
type MembersListInput = Parameters<typeof posthog.membersList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1386
|
+
type MembersListOutput = Awaited<ReturnType<typeof posthog.membersList>>;
|
|
1387
|
+
|
|
1388
|
+
const result: MembersListOutput = await posthog.membersList();
|
|
1389
|
+
|
|
1390
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_ve...
|
|
1391
|
+
```
|
|
1392
|
+
|
|
1393
|
+
### `posthog.membersDestroy`
|
|
1394
|
+
|
|
1395
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/members/{user__uuid}/`
|
|
1396
|
+
- **OpenAPI operationId**: `members_destroy`
|
|
1397
|
+
- **Path params**: `user__uuid`
|
|
1398
|
+
- **Query params**: None
|
|
1399
|
+
- **Response codes**: `204`
|
|
1400
|
+
- **Transport options**: None
|
|
1401
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1402
|
+
|
|
1403
|
+
**Inputs**
|
|
1404
|
+
|
|
1405
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1406
|
+
- Client transport options: None
|
|
1407
|
+
|
|
1408
|
+
**Outputs**
|
|
1409
|
+
|
|
1410
|
+
- Client return type: `unknown`
|
|
1411
|
+
- OpenAPI response codes: `204`
|
|
1412
|
+
|
|
1413
|
+
```ts
|
|
1414
|
+
import posthog from "@utdk/posthog";
|
|
1415
|
+
|
|
1416
|
+
type MembersDestroyInput = Parameters<typeof posthog.membersDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1417
|
+
type MembersDestroyOutput = Awaited<ReturnType<typeof posthog.membersDestroy>>;
|
|
1418
|
+
|
|
1419
|
+
const result: MembersDestroyOutput = await posthog.membersDestroy();
|
|
1420
|
+
|
|
1421
|
+
// Result shape (from schema): unknown
|
|
1422
|
+
```
|
|
1423
|
+
|
|
1424
|
+
### `posthog.membersPartialUpdate`
|
|
1425
|
+
|
|
1426
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/members/{user__uuid}/`
|
|
1427
|
+
- **OpenAPI operationId**: `members_partial_update`
|
|
1428
|
+
- **Path params**: `user__uuid`
|
|
1429
|
+
- **Query params**: None
|
|
1430
|
+
- **Response codes**: `200`
|
|
1431
|
+
- **Transport options**: None
|
|
1432
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1433
|
+
|
|
1434
|
+
**Inputs**
|
|
1435
|
+
|
|
1436
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1437
|
+
- Client transport options: None
|
|
1438
|
+
|
|
1439
|
+
**Outputs**
|
|
1440
|
+
|
|
1441
|
+
- Client return type: `{ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...`
|
|
1442
|
+
- OpenAPI response codes: `200`
|
|
1443
|
+
|
|
1444
|
+
```ts
|
|
1445
|
+
import posthog from "@utdk/posthog";
|
|
1446
|
+
|
|
1447
|
+
type MembersPartialUpdateInput = Parameters<typeof posthog.membersPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1448
|
+
type MembersPartialUpdateOutput = Awaited<ReturnType<typeof posthog.membersPartialUpdate>>;
|
|
1449
|
+
|
|
1450
|
+
const result: MembersPartialUpdateOutput = await posthog.membersPartialUpdate();
|
|
1451
|
+
|
|
1452
|
+
// Result shape (from schema): { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...
|
|
1453
|
+
```
|
|
1454
|
+
|
|
1455
|
+
### `posthog.membersUpdate`
|
|
1456
|
+
|
|
1457
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/members/{user__uuid}/`
|
|
1458
|
+
- **OpenAPI operationId**: `members_update`
|
|
1459
|
+
- **Path params**: `user__uuid`
|
|
1460
|
+
- **Query params**: None
|
|
1461
|
+
- **Response codes**: `200`
|
|
1462
|
+
- **Transport options**: None
|
|
1463
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1464
|
+
|
|
1465
|
+
**Inputs**
|
|
1466
|
+
|
|
1467
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1468
|
+
- Client transport options: None
|
|
1469
|
+
|
|
1470
|
+
**Outputs**
|
|
1471
|
+
|
|
1472
|
+
- Client return type: `{ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...`
|
|
1473
|
+
- OpenAPI response codes: `200`
|
|
1474
|
+
|
|
1475
|
+
```ts
|
|
1476
|
+
import posthog from "@utdk/posthog";
|
|
1477
|
+
|
|
1478
|
+
type MembersUpdateInput = Parameters<typeof posthog.membersUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1479
|
+
type MembersUpdateOutput = Awaited<ReturnType<typeof posthog.membersUpdate>>;
|
|
1480
|
+
|
|
1481
|
+
const result: MembersUpdateOutput = await posthog.membersUpdate();
|
|
1482
|
+
|
|
1483
|
+
// Result shape (from schema): { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...
|
|
1484
|
+
```
|
|
1485
|
+
|
|
1486
|
+
### `posthog.membersGithubLoginRetrieve`
|
|
1487
|
+
|
|
1488
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/members/{user__uuid}/github_login/`
|
|
1489
|
+
- **OpenAPI operationId**: `members_github_login_retrieve`
|
|
1490
|
+
- **Path params**: `user__uuid`
|
|
1491
|
+
- **Query params**: None
|
|
1492
|
+
- **Response codes**: `200`
|
|
1493
|
+
- **Transport options**: None
|
|
1494
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1495
|
+
|
|
1496
|
+
**Inputs**
|
|
1497
|
+
|
|
1498
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1499
|
+
- Client transport options: None
|
|
1500
|
+
|
|
1501
|
+
**Outputs**
|
|
1502
|
+
|
|
1503
|
+
- Client return type: `{ github_login: string | null }`
|
|
1504
|
+
- OpenAPI response codes: `200`
|
|
1505
|
+
|
|
1506
|
+
```ts
|
|
1507
|
+
import posthog from "@utdk/posthog";
|
|
1508
|
+
|
|
1509
|
+
type MembersGithubLoginRetrieveInput = Parameters<typeof posthog.membersGithubLoginRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1510
|
+
type MembersGithubLoginRetrieveOutput = Awaited<ReturnType<typeof posthog.membersGithubLoginRetrieve>>;
|
|
1511
|
+
|
|
1512
|
+
const result: MembersGithubLoginRetrieveOutput = await posthog.membersGithubLoginRetrieve();
|
|
1513
|
+
|
|
1514
|
+
// Result shape (from schema): { github_login: string | null }
|
|
1515
|
+
```
|
|
1516
|
+
|
|
1517
|
+
### `posthog.membersScopedApiKeysRetrieve`
|
|
1518
|
+
|
|
1519
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/members/{user__uuid}/scoped_api_keys/`
|
|
1520
|
+
- **OpenAPI operationId**: `members_scoped_api_keys_retrieve`
|
|
1521
|
+
- **Path params**: `user__uuid`
|
|
1522
|
+
- **Query params**: None
|
|
1523
|
+
- **Response codes**: `200`
|
|
1524
|
+
- **Transport options**: None
|
|
1525
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1526
|
+
|
|
1527
|
+
**Inputs**
|
|
1528
|
+
|
|
1529
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1530
|
+
- Client transport options: None
|
|
1531
|
+
|
|
1532
|
+
**Outputs**
|
|
1533
|
+
|
|
1534
|
+
- Client return type: `{ id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...`
|
|
1535
|
+
- OpenAPI response codes: `200`
|
|
1536
|
+
|
|
1537
|
+
```ts
|
|
1538
|
+
import posthog from "@utdk/posthog";
|
|
1539
|
+
|
|
1540
|
+
type MembersScopedApiKeysRetrieveInput = Parameters<typeof posthog.membersScopedApiKeysRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1541
|
+
type MembersScopedApiKeysRetrieveOutput = Awaited<ReturnType<typeof posthog.membersScopedApiKeysRetrieve>>;
|
|
1542
|
+
|
|
1543
|
+
const result: MembersScopedApiKeysRetrieveOutput = await posthog.membersScopedApiKeysRetrieve();
|
|
1544
|
+
|
|
1545
|
+
// Result shape (from schema): { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_config: { [key: string]: unknown } | null...
|
|
1546
|
+
```
|
|
1547
|
+
|
|
1548
|
+
### `posthog.oauthApplicationsList`
|
|
1549
|
+
|
|
1550
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/oauth_applications/`
|
|
1551
|
+
- **What it does**: ViewSet for listing OAuth applications at the organization level (read-only).
|
|
1552
|
+
- **OpenAPI operationId**: `oauth_applications_list`
|
|
1553
|
+
- **Path params**: None
|
|
1554
|
+
- **Query params**: `limit`, `offset`
|
|
1555
|
+
- **Response codes**: `200`
|
|
1556
|
+
- **Transport options**: None
|
|
1557
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1558
|
+
|
|
1559
|
+
**Inputs**
|
|
1560
|
+
|
|
1561
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1562
|
+
- Client transport options: None
|
|
1563
|
+
|
|
1564
|
+
**Outputs**
|
|
1565
|
+
|
|
1566
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name?: string; client_id?: string; redirect_uris_list: (string)[]; is_verified?: boolean; created: string; updated: string })[] }`
|
|
1567
|
+
- OpenAPI response codes: `200`
|
|
1568
|
+
|
|
1569
|
+
```ts
|
|
1570
|
+
import posthog from "@utdk/posthog";
|
|
1571
|
+
|
|
1572
|
+
type OauthApplicationsListInput = Parameters<typeof posthog.oauthApplicationsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1573
|
+
type OauthApplicationsListOutput = Awaited<ReturnType<typeof posthog.oauthApplicationsList>>;
|
|
1574
|
+
|
|
1575
|
+
const result: OauthApplicationsListOutput = await posthog.oauthApplicationsList();
|
|
1576
|
+
|
|
1577
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name?: string; client_id?: string; redirect_uris_list: (string)[]; is_verified?: boolean; created: string; updated: string })[] }
|
|
1578
|
+
```
|
|
1579
|
+
|
|
1580
|
+
### `posthog.organizationsProjectsList`
|
|
1581
|
+
|
|
1582
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/`
|
|
1583
|
+
- **What it does**: Projects for the current organization.
|
|
1584
|
+
- **OpenAPI operationId**: `organizations_projects_list`
|
|
1585
|
+
- **Path params**: None
|
|
1586
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
1587
|
+
- **Response codes**: `200`
|
|
1588
|
+
- **Transport options**: None
|
|
1589
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1590
|
+
|
|
1591
|
+
**Inputs**
|
|
1592
|
+
|
|
1593
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1594
|
+
- Client transport options: None
|
|
1595
|
+
|
|
1596
|
+
**Outputs**
|
|
1597
|
+
|
|
1598
|
+
- 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...`
|
|
1599
|
+
- OpenAPI response codes: `200`
|
|
1600
|
+
|
|
1601
|
+
```ts
|
|
1602
|
+
import posthog from "@utdk/posthog";
|
|
1603
|
+
|
|
1604
|
+
type OrganizationsProjectsListInput = Parameters<typeof posthog.organizationsProjectsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1605
|
+
type OrganizationsProjectsListOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsList>>;
|
|
1606
|
+
|
|
1607
|
+
const result: OrganizationsProjectsListOutput = await posthog.organizationsProjectsList();
|
|
1608
|
+
|
|
1609
|
+
// 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...
|
|
1610
|
+
```
|
|
1611
|
+
|
|
1612
|
+
### `posthog.organizationsProjectsCreate`
|
|
1613
|
+
|
|
1614
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/projects/`
|
|
1615
|
+
- **What it does**: Projects for the current organization.
|
|
1616
|
+
- **OpenAPI operationId**: `organizations_projects_create`
|
|
1617
|
+
- **Path params**: None
|
|
1618
|
+
- **Query params**: None
|
|
1619
|
+
- **Response codes**: `201`
|
|
1620
|
+
- **Transport options**: None
|
|
1621
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1622
|
+
|
|
1623
|
+
**Inputs**
|
|
1624
|
+
|
|
1625
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1626
|
+
- Client transport options: None
|
|
1627
|
+
|
|
1628
|
+
**Outputs**
|
|
1629
|
+
|
|
1630
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1631
|
+
- OpenAPI response codes: `201`
|
|
1632
|
+
|
|
1633
|
+
```ts
|
|
1634
|
+
import posthog from "@utdk/posthog";
|
|
1635
|
+
|
|
1636
|
+
type OrganizationsProjectsCreateInput = Parameters<typeof posthog.organizationsProjectsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1637
|
+
type OrganizationsProjectsCreateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsCreate>>;
|
|
1638
|
+
|
|
1639
|
+
const result: OrganizationsProjectsCreateOutput = await posthog.organizationsProjectsCreate();
|
|
1640
|
+
|
|
1641
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1642
|
+
```
|
|
1643
|
+
|
|
1644
|
+
### `posthog.organizationsProjectsDestroy`
|
|
1645
|
+
|
|
1646
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/projects/{id}/`
|
|
1647
|
+
- **What it does**: Projects for the current organization.
|
|
1648
|
+
- **OpenAPI operationId**: `organizations_projects_destroy`
|
|
1649
|
+
- **Path params**: `id`
|
|
1650
|
+
- **Query params**: None
|
|
1651
|
+
- **Response codes**: `204`
|
|
1652
|
+
- **Transport options**: None
|
|
1653
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1654
|
+
|
|
1655
|
+
**Inputs**
|
|
1656
|
+
|
|
1657
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1658
|
+
- Client transport options: None
|
|
1659
|
+
|
|
1660
|
+
**Outputs**
|
|
1661
|
+
|
|
1662
|
+
- Client return type: `unknown`
|
|
1663
|
+
- OpenAPI response codes: `204`
|
|
1664
|
+
|
|
1665
|
+
```ts
|
|
1666
|
+
import posthog from "@utdk/posthog";
|
|
1667
|
+
|
|
1668
|
+
type OrganizationsProjectsDestroyInput = Parameters<typeof posthog.organizationsProjectsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1669
|
+
type OrganizationsProjectsDestroyOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDestroy>>;
|
|
1670
|
+
|
|
1671
|
+
const result: OrganizationsProjectsDestroyOutput = await posthog.organizationsProjectsDestroy();
|
|
1672
|
+
|
|
1673
|
+
// Result shape (from schema): unknown
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
### `posthog.organizationsProjectsRetrieve`
|
|
1677
|
+
|
|
1678
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/`
|
|
1679
|
+
- **What it does**: Retrieve a project and its settings.
|
|
1680
|
+
- **OpenAPI operationId**: `organizations_projects_retrieve`
|
|
1681
|
+
- **Path params**: `id`
|
|
1682
|
+
- **Query params**: None
|
|
1683
|
+
- **Response codes**: `200`
|
|
1684
|
+
- **Transport options**: None
|
|
1685
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1686
|
+
|
|
1687
|
+
**Inputs**
|
|
1688
|
+
|
|
1689
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1690
|
+
- Client transport options: None
|
|
1691
|
+
|
|
1692
|
+
**Outputs**
|
|
1693
|
+
|
|
1694
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1695
|
+
- OpenAPI response codes: `200`
|
|
1696
|
+
|
|
1697
|
+
```ts
|
|
1698
|
+
import posthog from "@utdk/posthog";
|
|
1699
|
+
|
|
1700
|
+
type OrganizationsProjectsRetrieveInput = Parameters<typeof posthog.organizationsProjectsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1701
|
+
type OrganizationsProjectsRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsRetrieve>>;
|
|
1702
|
+
|
|
1703
|
+
const result: OrganizationsProjectsRetrieveOutput = await posthog.organizationsProjectsRetrieve();
|
|
1704
|
+
|
|
1705
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1706
|
+
```
|
|
1707
|
+
|
|
1708
|
+
### `posthog.organizationsProjectsPartialUpdate`
|
|
1709
|
+
|
|
1710
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/`
|
|
1711
|
+
- **What it does**: Update one or more of a project's settings. Only the fields included in the request body are changed.
|
|
1712
|
+
- **OpenAPI operationId**: `organizations_projects_partial_update`
|
|
1713
|
+
- **Path params**: `id`
|
|
1714
|
+
- **Query params**: None
|
|
1715
|
+
- **Response codes**: `200`
|
|
1716
|
+
- **Transport options**: None
|
|
1717
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1718
|
+
|
|
1719
|
+
**Inputs**
|
|
1720
|
+
|
|
1721
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1722
|
+
- Client transport options: None
|
|
1723
|
+
|
|
1724
|
+
**Outputs**
|
|
1725
|
+
|
|
1726
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1727
|
+
- OpenAPI response codes: `200`
|
|
1728
|
+
|
|
1729
|
+
```ts
|
|
1730
|
+
import posthog from "@utdk/posthog";
|
|
1731
|
+
|
|
1732
|
+
type OrganizationsProjectsPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1733
|
+
type OrganizationsProjectsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsPartialUpdate>>;
|
|
1734
|
+
|
|
1735
|
+
const result: OrganizationsProjectsPartialUpdateOutput = await posthog.organizationsProjectsPartialUpdate();
|
|
1736
|
+
|
|
1737
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1738
|
+
```
|
|
1739
|
+
|
|
1740
|
+
### `posthog.organizationsProjectsUpdate`
|
|
1741
|
+
|
|
1742
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/projects/{id}/`
|
|
1743
|
+
- **What it does**: Replace a project and its settings. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided.
|
|
1744
|
+
- **OpenAPI operationId**: `organizations_projects_update`
|
|
1745
|
+
- **Path params**: `id`
|
|
1746
|
+
- **Query params**: None
|
|
1747
|
+
- **Response codes**: `200`
|
|
1748
|
+
- **Transport options**: None
|
|
1749
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1750
|
+
|
|
1751
|
+
**Inputs**
|
|
1752
|
+
|
|
1753
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1754
|
+
- Client transport options: None
|
|
1755
|
+
|
|
1756
|
+
**Outputs**
|
|
1757
|
+
|
|
1758
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1759
|
+
- OpenAPI response codes: `200`
|
|
1760
|
+
|
|
1761
|
+
```ts
|
|
1762
|
+
import posthog from "@utdk/posthog";
|
|
1763
|
+
|
|
1764
|
+
type OrganizationsProjectsUpdateInput = Parameters<typeof posthog.organizationsProjectsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1765
|
+
type OrganizationsProjectsUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsUpdate>>;
|
|
1766
|
+
|
|
1767
|
+
const result: OrganizationsProjectsUpdateOutput = await posthog.organizationsProjectsUpdate();
|
|
1768
|
+
|
|
1769
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1770
|
+
```
|
|
1771
|
+
|
|
1772
|
+
### `posthog.organizationsProjectsActivityRetrieve`
|
|
1773
|
+
|
|
1774
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/activity/`
|
|
1775
|
+
- **What it does**: Projects for the current organization.
|
|
1776
|
+
- **OpenAPI operationId**: `organizations_projects_activity_retrieve`
|
|
1777
|
+
- **Path params**: `id`
|
|
1778
|
+
- **Query params**: None
|
|
1779
|
+
- **Response codes**: `200`
|
|
1780
|
+
- **Transport options**: None
|
|
1781
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1782
|
+
|
|
1783
|
+
**Inputs**
|
|
1784
|
+
|
|
1785
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1786
|
+
- Client transport options: None
|
|
1787
|
+
|
|
1788
|
+
**Outputs**
|
|
1789
|
+
|
|
1790
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1791
|
+
- OpenAPI response codes: `200`
|
|
1792
|
+
|
|
1793
|
+
```ts
|
|
1794
|
+
import posthog from "@utdk/posthog";
|
|
1795
|
+
|
|
1796
|
+
type OrganizationsProjectsActivityRetrieveInput = Parameters<typeof posthog.organizationsProjectsActivityRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1797
|
+
type OrganizationsProjectsActivityRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsActivityRetrieve>>;
|
|
1798
|
+
|
|
1799
|
+
const result: OrganizationsProjectsActivityRetrieveOutput = await posthog.organizationsProjectsActivityRetrieve();
|
|
1800
|
+
|
|
1801
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1802
|
+
```
|
|
1803
|
+
|
|
1804
|
+
### `posthog.organizationsProjectsAddProductIntentPartialUpdate`
|
|
1805
|
+
|
|
1806
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/add_product_intent/`
|
|
1807
|
+
- **What it does**: Projects for the current organization.
|
|
1808
|
+
- **OpenAPI operationId**: `organizations_projects_add_product_intent_partial_update`
|
|
1809
|
+
- **Path params**: `id`
|
|
1810
|
+
- **Query params**: None
|
|
1811
|
+
- **Response codes**: `200`
|
|
1812
|
+
- **Transport options**: None
|
|
1813
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1814
|
+
|
|
1815
|
+
**Inputs**
|
|
1816
|
+
|
|
1817
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1818
|
+
- Client transport options: None
|
|
1819
|
+
|
|
1820
|
+
**Outputs**
|
|
1821
|
+
|
|
1822
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1823
|
+
- OpenAPI response codes: `200`
|
|
1824
|
+
|
|
1825
|
+
```ts
|
|
1826
|
+
import posthog from "@utdk/posthog";
|
|
1827
|
+
|
|
1828
|
+
type OrganizationsProjectsAddProductIntentPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsAddProductIntentPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1829
|
+
type OrganizationsProjectsAddProductIntentPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsAddProductIntentPartialUpdate>>;
|
|
1830
|
+
|
|
1831
|
+
const result: OrganizationsProjectsAddProductIntentPartialUpdateOutput = await posthog.organizationsProjectsAddProductIntentPartialUpdate();
|
|
1832
|
+
|
|
1833
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1834
|
+
```
|
|
1835
|
+
|
|
1836
|
+
### `posthog.organizationsProjectsChangeOrganizationCreate`
|
|
1837
|
+
|
|
1838
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/projects/{id}/change_organization/`
|
|
1839
|
+
- **What it does**: Projects for the current organization.
|
|
1840
|
+
- **OpenAPI operationId**: `organizations_projects_change_organization_create`
|
|
1841
|
+
- **Path params**: `id`
|
|
1842
|
+
- **Query params**: None
|
|
1843
|
+
- **Response codes**: `200`
|
|
1844
|
+
- **Transport options**: None
|
|
1845
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1846
|
+
|
|
1847
|
+
**Inputs**
|
|
1848
|
+
|
|
1849
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1850
|
+
- Client transport options: None
|
|
1851
|
+
|
|
1852
|
+
**Outputs**
|
|
1853
|
+
|
|
1854
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1855
|
+
- OpenAPI response codes: `200`
|
|
1856
|
+
|
|
1857
|
+
```ts
|
|
1858
|
+
import posthog from "@utdk/posthog";
|
|
1859
|
+
|
|
1860
|
+
type OrganizationsProjectsChangeOrganizationCreateInput = Parameters<typeof posthog.organizationsProjectsChangeOrganizationCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1861
|
+
type OrganizationsProjectsChangeOrganizationCreateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsChangeOrganizationCreate>>;
|
|
1862
|
+
|
|
1863
|
+
const result: OrganizationsProjectsChangeOrganizationCreateOutput = await posthog.organizationsProjectsChangeOrganizationCreate();
|
|
1864
|
+
|
|
1865
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1866
|
+
```
|
|
1867
|
+
|
|
1868
|
+
### `posthog.organizationsProjectsCompleteProductOnboardingPartialUpdate`
|
|
1869
|
+
|
|
1870
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/complete_product_onboarding/`
|
|
1871
|
+
- **What it does**: Projects for the current organization.
|
|
1872
|
+
- **OpenAPI operationId**: `organizations_projects_complete_product_onboarding_partial_update`
|
|
1873
|
+
- **Path params**: `id`
|
|
1874
|
+
- **Query params**: None
|
|
1875
|
+
- **Response codes**: `200`
|
|
1876
|
+
- **Transport options**: None
|
|
1877
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1878
|
+
|
|
1879
|
+
**Inputs**
|
|
1880
|
+
|
|
1881
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1882
|
+
- Client transport options: None
|
|
1883
|
+
|
|
1884
|
+
**Outputs**
|
|
1885
|
+
|
|
1886
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1887
|
+
- OpenAPI response codes: `200`
|
|
1888
|
+
|
|
1889
|
+
```ts
|
|
1890
|
+
import posthog from "@utdk/posthog";
|
|
1891
|
+
|
|
1892
|
+
type OrganizationsProjectsCompleteProductOnboardingPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsCompleteProductOnboardingPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1893
|
+
type OrganizationsProjectsCompleteProductOnboardingPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsCompleteProductOnboardingPartialUpdate>>;
|
|
1894
|
+
|
|
1895
|
+
const result: OrganizationsProjectsCompleteProductOnboardingPartialUpdateOutput = await posthog.organizationsProjectsCompleteProductOnboardingPartialUpdate();
|
|
1896
|
+
|
|
1897
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1898
|
+
```
|
|
1899
|
+
|
|
1900
|
+
### `posthog.organizationsProjectsDefaultEvaluationContextsDestroy`
|
|
1901
|
+
|
|
1902
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/projects/{id}/default_evaluation_contexts/`
|
|
1903
|
+
- **What it does**: Manage default evaluation contexts for a project.
|
|
1904
|
+
- **OpenAPI operationId**: `organizations_projects_default_evaluation_contexts_destroy`
|
|
1905
|
+
- **Path params**: `id`
|
|
1906
|
+
- **Query params**: None
|
|
1907
|
+
- **Response codes**: `204`
|
|
1908
|
+
- **Transport options**: None
|
|
1909
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1910
|
+
|
|
1911
|
+
**Inputs**
|
|
1912
|
+
|
|
1913
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1914
|
+
- Client transport options: None
|
|
1915
|
+
|
|
1916
|
+
**Outputs**
|
|
1917
|
+
|
|
1918
|
+
- Client return type: `unknown`
|
|
1919
|
+
- OpenAPI response codes: `204`
|
|
1920
|
+
|
|
1921
|
+
```ts
|
|
1922
|
+
import posthog from "@utdk/posthog";
|
|
1923
|
+
|
|
1924
|
+
type OrganizationsProjectsDefaultEvaluationContextsDestroyInput = Parameters<typeof posthog.organizationsProjectsDefaultEvaluationContextsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1925
|
+
type OrganizationsProjectsDefaultEvaluationContextsDestroyOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDefaultEvaluationContextsDestroy>>;
|
|
1926
|
+
|
|
1927
|
+
const result: OrganizationsProjectsDefaultEvaluationContextsDestroyOutput = await posthog.organizationsProjectsDefaultEvaluationContextsDestroy();
|
|
1928
|
+
|
|
1929
|
+
// Result shape (from schema): unknown
|
|
1930
|
+
```
|
|
1931
|
+
|
|
1932
|
+
### `posthog.organizationsProjectsDefaultEvaluationContextsRetrieve`
|
|
1933
|
+
|
|
1934
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/default_evaluation_contexts/`
|
|
1935
|
+
- **What it does**: Manage default evaluation contexts for a project.
|
|
1936
|
+
- **OpenAPI operationId**: `organizations_projects_default_evaluation_contexts_retrieve`
|
|
1937
|
+
- **Path params**: `id`
|
|
1938
|
+
- **Query params**: None
|
|
1939
|
+
- **Response codes**: `200`
|
|
1940
|
+
- **Transport options**: None
|
|
1941
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1942
|
+
|
|
1943
|
+
**Inputs**
|
|
1944
|
+
|
|
1945
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1946
|
+
- Client transport options: None
|
|
1947
|
+
|
|
1948
|
+
**Outputs**
|
|
1949
|
+
|
|
1950
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1951
|
+
- OpenAPI response codes: `200`
|
|
1952
|
+
|
|
1953
|
+
```ts
|
|
1954
|
+
import posthog from "@utdk/posthog";
|
|
1955
|
+
|
|
1956
|
+
type OrganizationsProjectsDefaultEvaluationContextsRetrieveInput = Parameters<typeof posthog.organizationsProjectsDefaultEvaluationContextsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1957
|
+
type OrganizationsProjectsDefaultEvaluationContextsRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDefaultEvaluationContextsRetrieve>>;
|
|
1958
|
+
|
|
1959
|
+
const result: OrganizationsProjectsDefaultEvaluationContextsRetrieveOutput = await posthog.organizationsProjectsDefaultEvaluationContextsRetrieve();
|
|
1960
|
+
|
|
1961
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1962
|
+
```
|
|
1963
|
+
|
|
1964
|
+
### `posthog.organizationsProjectsDefaultEvaluationContextsCreate`
|
|
1965
|
+
|
|
1966
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/projects/{id}/default_evaluation_contexts/`
|
|
1967
|
+
- **What it does**: Manage default evaluation contexts for a project.
|
|
1968
|
+
- **OpenAPI operationId**: `organizations_projects_default_evaluation_contexts_create`
|
|
1969
|
+
- **Path params**: `id`
|
|
1970
|
+
- **Query params**: None
|
|
1971
|
+
- **Response codes**: `200`
|
|
1972
|
+
- **Transport options**: None
|
|
1973
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1974
|
+
|
|
1975
|
+
**Inputs**
|
|
1976
|
+
|
|
1977
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1978
|
+
- Client transport options: None
|
|
1979
|
+
|
|
1980
|
+
**Outputs**
|
|
1981
|
+
|
|
1982
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
1983
|
+
- OpenAPI response codes: `200`
|
|
1984
|
+
|
|
1985
|
+
```ts
|
|
1986
|
+
import posthog from "@utdk/posthog";
|
|
1987
|
+
|
|
1988
|
+
type OrganizationsProjectsDefaultEvaluationContextsCreateInput = Parameters<typeof posthog.organizationsProjectsDefaultEvaluationContextsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1989
|
+
type OrganizationsProjectsDefaultEvaluationContextsCreateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDefaultEvaluationContextsCreate>>;
|
|
1990
|
+
|
|
1991
|
+
const result: OrganizationsProjectsDefaultEvaluationContextsCreateOutput = await posthog.organizationsProjectsDefaultEvaluationContextsCreate();
|
|
1992
|
+
|
|
1993
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
1994
|
+
```
|
|
1995
|
+
|
|
1996
|
+
### `posthog.organizationsProjectsDefaultReleaseConditionsRetrieve`
|
|
1997
|
+
|
|
1998
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/default_release_conditions/`
|
|
1999
|
+
- **What it does**: Manage default release conditions for new feature flags in this project.
|
|
2000
|
+
- **OpenAPI operationId**: `organizations_projects_default_release_conditions_retrieve`
|
|
2001
|
+
- **Path params**: `id`
|
|
2002
|
+
- **Query params**: None
|
|
2003
|
+
- **Response codes**: `200`
|
|
2004
|
+
- **Transport options**: None
|
|
2005
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2006
|
+
|
|
2007
|
+
**Inputs**
|
|
2008
|
+
|
|
2009
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2010
|
+
- Client transport options: None
|
|
2011
|
+
|
|
2012
|
+
**Outputs**
|
|
2013
|
+
|
|
2014
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2015
|
+
- OpenAPI response codes: `200`
|
|
2016
|
+
|
|
2017
|
+
```ts
|
|
2018
|
+
import posthog from "@utdk/posthog";
|
|
2019
|
+
|
|
2020
|
+
type OrganizationsProjectsDefaultReleaseConditionsRetrieveInput = Parameters<typeof posthog.organizationsProjectsDefaultReleaseConditionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2021
|
+
type OrganizationsProjectsDefaultReleaseConditionsRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDefaultReleaseConditionsRetrieve>>;
|
|
2022
|
+
|
|
2023
|
+
const result: OrganizationsProjectsDefaultReleaseConditionsRetrieveOutput = await posthog.organizationsProjectsDefaultReleaseConditionsRetrieve();
|
|
2024
|
+
|
|
2025
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2026
|
+
```
|
|
2027
|
+
|
|
2028
|
+
### `posthog.organizationsProjectsDefaultReleaseConditionsUpdate`
|
|
2029
|
+
|
|
2030
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/projects/{id}/default_release_conditions/`
|
|
2031
|
+
- **What it does**: Manage default release conditions for new feature flags in this project.
|
|
2032
|
+
- **OpenAPI operationId**: `organizations_projects_default_release_conditions_update`
|
|
2033
|
+
- **Path params**: `id`
|
|
2034
|
+
- **Query params**: None
|
|
2035
|
+
- **Response codes**: `200`
|
|
2036
|
+
- **Transport options**: None
|
|
2037
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2038
|
+
|
|
2039
|
+
**Inputs**
|
|
2040
|
+
|
|
2041
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2042
|
+
- Client transport options: None
|
|
2043
|
+
|
|
2044
|
+
**Outputs**
|
|
2045
|
+
|
|
2046
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2047
|
+
- OpenAPI response codes: `200`
|
|
2048
|
+
|
|
2049
|
+
```ts
|
|
2050
|
+
import posthog from "@utdk/posthog";
|
|
2051
|
+
|
|
2052
|
+
type OrganizationsProjectsDefaultReleaseConditionsUpdateInput = Parameters<typeof posthog.organizationsProjectsDefaultReleaseConditionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2053
|
+
type OrganizationsProjectsDefaultReleaseConditionsUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDefaultReleaseConditionsUpdate>>;
|
|
2054
|
+
|
|
2055
|
+
const result: OrganizationsProjectsDefaultReleaseConditionsUpdateOutput = await posthog.organizationsProjectsDefaultReleaseConditionsUpdate();
|
|
2056
|
+
|
|
2057
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2058
|
+
```
|
|
2059
|
+
|
|
2060
|
+
### `posthog.organizationsProjectsDeleteSecretTokenBackupPartialUpdate`
|
|
2061
|
+
|
|
2062
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/delete_secret_token_backup/`
|
|
2063
|
+
- **What it does**: Projects for the current organization.
|
|
2064
|
+
- **OpenAPI operationId**: `organizations_projects_delete_secret_token_backup_partial_update`
|
|
2065
|
+
- **Path params**: `id`
|
|
2066
|
+
- **Query params**: None
|
|
2067
|
+
- **Response codes**: `200`
|
|
2068
|
+
- **Transport options**: None
|
|
2069
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2070
|
+
|
|
2071
|
+
**Inputs**
|
|
2072
|
+
|
|
2073
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2074
|
+
- Client transport options: None
|
|
2075
|
+
|
|
2076
|
+
**Outputs**
|
|
2077
|
+
|
|
2078
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2079
|
+
- OpenAPI response codes: `200`
|
|
2080
|
+
|
|
2081
|
+
```ts
|
|
2082
|
+
import posthog from "@utdk/posthog";
|
|
2083
|
+
|
|
2084
|
+
type OrganizationsProjectsDeleteSecretTokenBackupPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsDeleteSecretTokenBackupPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2085
|
+
type OrganizationsProjectsDeleteSecretTokenBackupPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsDeleteSecretTokenBackupPartialUpdate>>;
|
|
2086
|
+
|
|
2087
|
+
const result: OrganizationsProjectsDeleteSecretTokenBackupPartialUpdateOutput = await posthog.organizationsProjectsDeleteSecretTokenBackupPartialUpdate();
|
|
2088
|
+
|
|
2089
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2090
|
+
```
|
|
2091
|
+
|
|
2092
|
+
### `posthog.organizationsProjectsEvaluationContextSuggestionsDestroy`
|
|
2093
|
+
|
|
2094
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/projects/{id}/evaluation_context_suggestions/`
|
|
2095
|
+
- **What it does**: Hide an evaluation context name from the flag editor's suggestion list, or restore it.
|
|
2096
|
+
|
|
2097
|
+
POST hides the name; DELETE restores it. The underlying context row and any flags already
|
|
2098
|
+
using it are never modified — this only controls what gets suggested.
|
|
2099
|
+
- **OpenAPI operationId**: `organizations_projects_evaluation_context_suggestions_destroy`
|
|
2100
|
+
- **Path params**: `id`
|
|
2101
|
+
- **Query params**: `context_name`
|
|
2102
|
+
- **Response codes**: `200`
|
|
2103
|
+
- **Transport options**: None
|
|
2104
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2105
|
+
|
|
2106
|
+
**Inputs**
|
|
2107
|
+
|
|
2108
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2109
|
+
- Client transport options: None
|
|
2110
|
+
|
|
2111
|
+
**Outputs**
|
|
2112
|
+
|
|
2113
|
+
- Client return type: `{ success: boolean; name: string; hidden_from_suggestions: boolean }`
|
|
2114
|
+
- OpenAPI response codes: `200`
|
|
2115
|
+
|
|
2116
|
+
```ts
|
|
2117
|
+
import posthog from "@utdk/posthog";
|
|
2118
|
+
|
|
2119
|
+
type OrganizationsProjectsEvaluationContextSuggestionsDestroyInput = Parameters<typeof posthog.organizationsProjectsEvaluationContextSuggestionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2120
|
+
type OrganizationsProjectsEvaluationContextSuggestionsDestroyOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsEvaluationContextSuggestionsDestroy>>;
|
|
2121
|
+
|
|
2122
|
+
const result: OrganizationsProjectsEvaluationContextSuggestionsDestroyOutput = await posthog.organizationsProjectsEvaluationContextSuggestionsDestroy();
|
|
2123
|
+
|
|
2124
|
+
// Result shape (from schema): { success: boolean; name: string; hidden_from_suggestions: boolean }
|
|
2125
|
+
```
|
|
2126
|
+
|
|
2127
|
+
### `posthog.organizationsProjectsEvaluationContextSuggestionsCreate`
|
|
2128
|
+
|
|
2129
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/projects/{id}/evaluation_context_suggestions/`
|
|
2130
|
+
- **What it does**: Hide an evaluation context name from the flag editor's suggestion list, or restore it.
|
|
2131
|
+
|
|
2132
|
+
POST hides the name; DELETE restores it. The underlying context row and any flags already
|
|
2133
|
+
using it are never modified — this only controls what gets suggested.
|
|
2134
|
+
- **OpenAPI operationId**: `organizations_projects_evaluation_context_suggestions_create`
|
|
2135
|
+
- **Path params**: `id`
|
|
2136
|
+
- **Query params**: None
|
|
2137
|
+
- **Response codes**: `200`
|
|
2138
|
+
- **Transport options**: None
|
|
2139
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2140
|
+
|
|
2141
|
+
**Inputs**
|
|
2142
|
+
|
|
2143
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2144
|
+
- Client transport options: None
|
|
2145
|
+
|
|
2146
|
+
**Outputs**
|
|
2147
|
+
|
|
2148
|
+
- Client return type: `{ success: boolean; name: string; hidden_from_suggestions: boolean }`
|
|
2149
|
+
- OpenAPI response codes: `200`
|
|
2150
|
+
|
|
2151
|
+
```ts
|
|
2152
|
+
import posthog from "@utdk/posthog";
|
|
2153
|
+
|
|
2154
|
+
type OrganizationsProjectsEvaluationContextSuggestionsCreateInput = Parameters<typeof posthog.organizationsProjectsEvaluationContextSuggestionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2155
|
+
type OrganizationsProjectsEvaluationContextSuggestionsCreateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsEvaluationContextSuggestionsCreate>>;
|
|
2156
|
+
|
|
2157
|
+
const result: OrganizationsProjectsEvaluationContextSuggestionsCreateOutput = await posthog.organizationsProjectsEvaluationContextSuggestionsCreate();
|
|
2158
|
+
|
|
2159
|
+
// Result shape (from schema): { success: boolean; name: string; hidden_from_suggestions: boolean }
|
|
2160
|
+
```
|
|
2161
|
+
|
|
2162
|
+
### `posthog.organizationsProjectsEventIngestionRestrictionsRetrieve`
|
|
2163
|
+
|
|
2164
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/event_ingestion_restrictions/`
|
|
2165
|
+
- **What it does**: Projects for the current organization.
|
|
2166
|
+
- **OpenAPI operationId**: `organizations_projects_event_ingestion_restrictions_retrieve`
|
|
2167
|
+
- **Path params**: `id`
|
|
2168
|
+
- **Query params**: None
|
|
2169
|
+
- **Response codes**: `200`
|
|
2170
|
+
- **Transport options**: None
|
|
2171
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2172
|
+
|
|
2173
|
+
**Inputs**
|
|
2174
|
+
|
|
2175
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2176
|
+
- Client transport options: None
|
|
2177
|
+
|
|
2178
|
+
**Outputs**
|
|
2179
|
+
|
|
2180
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2181
|
+
- OpenAPI response codes: `200`
|
|
2182
|
+
|
|
2183
|
+
```ts
|
|
2184
|
+
import posthog from "@utdk/posthog";
|
|
2185
|
+
|
|
2186
|
+
type OrganizationsProjectsEventIngestionRestrictionsRetrieveInput = Parameters<typeof posthog.organizationsProjectsEventIngestionRestrictionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2187
|
+
type OrganizationsProjectsEventIngestionRestrictionsRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsEventIngestionRestrictionsRetrieve>>;
|
|
2188
|
+
|
|
2189
|
+
const result: OrganizationsProjectsEventIngestionRestrictionsRetrieveOutput = await posthog.organizationsProjectsEventIngestionRestrictionsRetrieve();
|
|
2190
|
+
|
|
2191
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2192
|
+
```
|
|
2193
|
+
|
|
2194
|
+
### `posthog.organizationsProjectsExperimentsConfigRetrieve`
|
|
2195
|
+
|
|
2196
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/experiments_config/`
|
|
2197
|
+
- **What it does**: Manage experiment configuration for this project.
|
|
2198
|
+
- **OpenAPI operationId**: `organizations_projects_experiments_config_retrieve`
|
|
2199
|
+
- **Path params**: `id`
|
|
2200
|
+
- **Query params**: None
|
|
2201
|
+
- **Response codes**: `200`
|
|
2202
|
+
- **Transport options**: None
|
|
2203
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2204
|
+
|
|
2205
|
+
**Inputs**
|
|
2206
|
+
|
|
2207
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2208
|
+
- Client transport options: None
|
|
2209
|
+
|
|
2210
|
+
**Outputs**
|
|
2211
|
+
|
|
2212
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2213
|
+
- OpenAPI response codes: `200`
|
|
2214
|
+
|
|
2215
|
+
```ts
|
|
2216
|
+
import posthog from "@utdk/posthog";
|
|
2217
|
+
|
|
2218
|
+
type OrganizationsProjectsExperimentsConfigRetrieveInput = Parameters<typeof posthog.organizationsProjectsExperimentsConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2219
|
+
type OrganizationsProjectsExperimentsConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsExperimentsConfigRetrieve>>;
|
|
2220
|
+
|
|
2221
|
+
const result: OrganizationsProjectsExperimentsConfigRetrieveOutput = await posthog.organizationsProjectsExperimentsConfigRetrieve();
|
|
2222
|
+
|
|
2223
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2224
|
+
```
|
|
2225
|
+
|
|
2226
|
+
### `posthog.organizationsProjectsExperimentsConfigPartialUpdate`
|
|
2227
|
+
|
|
2228
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/experiments_config/`
|
|
2229
|
+
- **What it does**: Manage experiment configuration for this project.
|
|
2230
|
+
- **OpenAPI operationId**: `organizations_projects_experiments_config_partial_update`
|
|
2231
|
+
- **Path params**: `id`
|
|
2232
|
+
- **Query params**: None
|
|
2233
|
+
- **Response codes**: `200`
|
|
2234
|
+
- **Transport options**: None
|
|
2235
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2236
|
+
|
|
2237
|
+
**Inputs**
|
|
2238
|
+
|
|
2239
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2240
|
+
- Client transport options: None
|
|
2241
|
+
|
|
2242
|
+
**Outputs**
|
|
2243
|
+
|
|
2244
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2245
|
+
- OpenAPI response codes: `200`
|
|
2246
|
+
|
|
2247
|
+
```ts
|
|
2248
|
+
import posthog from "@utdk/posthog";
|
|
2249
|
+
|
|
2250
|
+
type OrganizationsProjectsExperimentsConfigPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsExperimentsConfigPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2251
|
+
type OrganizationsProjectsExperimentsConfigPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsExperimentsConfigPartialUpdate>>;
|
|
2252
|
+
|
|
2253
|
+
const result: OrganizationsProjectsExperimentsConfigPartialUpdateOutput = await posthog.organizationsProjectsExperimentsConfigPartialUpdate();
|
|
2254
|
+
|
|
2255
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2256
|
+
```
|
|
2257
|
+
|
|
2258
|
+
### `posthog.organizationsProjectsGenerateConversationsPublicTokenCreate`
|
|
2259
|
+
|
|
2260
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/projects/{id}/generate_conversations_public_token/`
|
|
2261
|
+
- **What it does**: Projects for the current organization.
|
|
2262
|
+
- **OpenAPI operationId**: `organizations_projects_generate_conversations_public_token_create`
|
|
2263
|
+
- **Path params**: `id`
|
|
2264
|
+
- **Query params**: None
|
|
2265
|
+
- **Response codes**: `200`
|
|
2266
|
+
- **Transport options**: None
|
|
2267
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2268
|
+
|
|
2269
|
+
**Inputs**
|
|
2270
|
+
|
|
2271
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2272
|
+
- Client transport options: None
|
|
2273
|
+
|
|
2274
|
+
**Outputs**
|
|
2275
|
+
|
|
2276
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2277
|
+
- OpenAPI response codes: `200`
|
|
2278
|
+
|
|
2279
|
+
```ts
|
|
2280
|
+
import posthog from "@utdk/posthog";
|
|
2281
|
+
|
|
2282
|
+
type OrganizationsProjectsGenerateConversationsPublicTokenCreateInput = Parameters<typeof posthog.organizationsProjectsGenerateConversationsPublicTokenCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2283
|
+
type OrganizationsProjectsGenerateConversationsPublicTokenCreateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsGenerateConversationsPublicTokenCreate>>;
|
|
2284
|
+
|
|
2285
|
+
const result: OrganizationsProjectsGenerateConversationsPublicTokenCreateOutput = await posthog.organizationsProjectsGenerateConversationsPublicTokenCreate();
|
|
2286
|
+
|
|
2287
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2288
|
+
```
|
|
2289
|
+
|
|
2290
|
+
### `posthog.organizationsProjectsIsGeneratingDemoDataRetrieve`
|
|
2291
|
+
|
|
2292
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/is_generating_demo_data/`
|
|
2293
|
+
- **What it does**: Projects for the current organization.
|
|
2294
|
+
- **OpenAPI operationId**: `organizations_projects_is_generating_demo_data_retrieve`
|
|
2295
|
+
- **Path params**: `id`
|
|
2296
|
+
- **Query params**: None
|
|
2297
|
+
- **Response codes**: `200`
|
|
2298
|
+
- **Transport options**: None
|
|
2299
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2300
|
+
|
|
2301
|
+
**Inputs**
|
|
2302
|
+
|
|
2303
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2304
|
+
- Client transport options: None
|
|
2305
|
+
|
|
2306
|
+
**Outputs**
|
|
2307
|
+
|
|
2308
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2309
|
+
- OpenAPI response codes: `200`
|
|
2310
|
+
|
|
2311
|
+
```ts
|
|
2312
|
+
import posthog from "@utdk/posthog";
|
|
2313
|
+
|
|
2314
|
+
type OrganizationsProjectsIsGeneratingDemoDataRetrieveInput = Parameters<typeof posthog.organizationsProjectsIsGeneratingDemoDataRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2315
|
+
type OrganizationsProjectsIsGeneratingDemoDataRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsIsGeneratingDemoDataRetrieve>>;
|
|
2316
|
+
|
|
2317
|
+
const result: OrganizationsProjectsIsGeneratingDemoDataRetrieveOutput = await posthog.organizationsProjectsIsGeneratingDemoDataRetrieve();
|
|
2318
|
+
|
|
2319
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2320
|
+
```
|
|
2321
|
+
|
|
2322
|
+
### `posthog.organizationsProjectsLogsConfigRetrieve`
|
|
2323
|
+
|
|
2324
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/logs_config/`
|
|
2325
|
+
- **What it does**: Manage logs product configuration for this project's canonical environment.
|
|
2326
|
+
Mirrors the env-router action so /api/projects/:id/logs_config/ resolves
|
|
2327
|
+
alongside the legacy /api/environments/:id/logs_config/ alias.
|
|
2328
|
+
- **OpenAPI operationId**: `organizations_projects_logs_config_retrieve`
|
|
2329
|
+
- **Path params**: `id`
|
|
2330
|
+
- **Query params**: None
|
|
2331
|
+
- **Response codes**: `200`
|
|
2332
|
+
- **Transport options**: None
|
|
2333
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2334
|
+
|
|
2335
|
+
**Inputs**
|
|
2336
|
+
|
|
2337
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2338
|
+
- Client transport options: None
|
|
2339
|
+
|
|
2340
|
+
**Outputs**
|
|
2341
|
+
|
|
2342
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2343
|
+
- OpenAPI response codes: `200`
|
|
2344
|
+
|
|
2345
|
+
```ts
|
|
2346
|
+
import posthog from "@utdk/posthog";
|
|
2347
|
+
|
|
2348
|
+
type OrganizationsProjectsLogsConfigRetrieveInput = Parameters<typeof posthog.organizationsProjectsLogsConfigRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2349
|
+
type OrganizationsProjectsLogsConfigRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsLogsConfigRetrieve>>;
|
|
2350
|
+
|
|
2351
|
+
const result: OrganizationsProjectsLogsConfigRetrieveOutput = await posthog.organizationsProjectsLogsConfigRetrieve();
|
|
2352
|
+
|
|
2353
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2354
|
+
```
|
|
2355
|
+
|
|
2356
|
+
### `posthog.organizationsProjectsLogsConfigPartialUpdate`
|
|
2357
|
+
|
|
2358
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/logs_config/`
|
|
2359
|
+
- **What it does**: Manage logs product configuration for this project's canonical environment.
|
|
2360
|
+
Mirrors the env-router action so /api/projects/:id/logs_config/ resolves
|
|
2361
|
+
alongside the legacy /api/environments/:id/logs_config/ alias.
|
|
2362
|
+
- **OpenAPI operationId**: `organizations_projects_logs_config_partial_update`
|
|
2363
|
+
- **Path params**: `id`
|
|
2364
|
+
- **Query params**: None
|
|
2365
|
+
- **Response codes**: `200`
|
|
2366
|
+
- **Transport options**: None
|
|
2367
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2368
|
+
|
|
2369
|
+
**Inputs**
|
|
2370
|
+
|
|
2371
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2372
|
+
- Client transport options: None
|
|
2373
|
+
|
|
2374
|
+
**Outputs**
|
|
2375
|
+
|
|
2376
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2377
|
+
- OpenAPI response codes: `200`
|
|
2378
|
+
|
|
2379
|
+
```ts
|
|
2380
|
+
import posthog from "@utdk/posthog";
|
|
2381
|
+
|
|
2382
|
+
type OrganizationsProjectsLogsConfigPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsLogsConfigPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2383
|
+
type OrganizationsProjectsLogsConfigPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsLogsConfigPartialUpdate>>;
|
|
2384
|
+
|
|
2385
|
+
const result: OrganizationsProjectsLogsConfigPartialUpdateOutput = await posthog.organizationsProjectsLogsConfigPartialUpdate();
|
|
2386
|
+
|
|
2387
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2388
|
+
```
|
|
2389
|
+
|
|
2390
|
+
### `posthog.organizationsProjectsResetTokenPartialUpdate`
|
|
2391
|
+
|
|
2392
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/reset_token/`
|
|
2393
|
+
- **What it does**: Projects for the current organization.
|
|
2394
|
+
- **OpenAPI operationId**: `organizations_projects_reset_token_partial_update`
|
|
2395
|
+
- **Path params**: `id`
|
|
2396
|
+
- **Query params**: None
|
|
2397
|
+
- **Response codes**: `200`
|
|
2398
|
+
- **Transport options**: None
|
|
2399
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2400
|
+
|
|
2401
|
+
**Inputs**
|
|
2402
|
+
|
|
2403
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2404
|
+
- Client transport options: None
|
|
2405
|
+
|
|
2406
|
+
**Outputs**
|
|
2407
|
+
|
|
2408
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2409
|
+
- OpenAPI response codes: `200`
|
|
2410
|
+
|
|
2411
|
+
```ts
|
|
2412
|
+
import posthog from "@utdk/posthog";
|
|
2413
|
+
|
|
2414
|
+
type OrganizationsProjectsResetTokenPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsResetTokenPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2415
|
+
type OrganizationsProjectsResetTokenPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsResetTokenPartialUpdate>>;
|
|
2416
|
+
|
|
2417
|
+
const result: OrganizationsProjectsResetTokenPartialUpdateOutput = await posthog.organizationsProjectsResetTokenPartialUpdate();
|
|
2418
|
+
|
|
2419
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2420
|
+
```
|
|
2421
|
+
|
|
2422
|
+
### `posthog.organizationsProjectsRotateSecretTokenPartialUpdate`
|
|
2423
|
+
|
|
2424
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/projects/{id}/rotate_secret_token/`
|
|
2425
|
+
- **What it does**: Projects for the current organization.
|
|
2426
|
+
- **OpenAPI operationId**: `organizations_projects_rotate_secret_token_partial_update`
|
|
2427
|
+
- **Path params**: `id`
|
|
2428
|
+
- **Query params**: None
|
|
2429
|
+
- **Response codes**: `200`
|
|
2430
|
+
- **Transport options**: None
|
|
2431
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2432
|
+
|
|
2433
|
+
**Inputs**
|
|
2434
|
+
|
|
2435
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2436
|
+
- Client transport options: None
|
|
2437
|
+
|
|
2438
|
+
**Outputs**
|
|
2439
|
+
|
|
2440
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2441
|
+
- OpenAPI response codes: `200`
|
|
2442
|
+
|
|
2443
|
+
```ts
|
|
2444
|
+
import posthog from "@utdk/posthog";
|
|
2445
|
+
|
|
2446
|
+
type OrganizationsProjectsRotateSecretTokenPartialUpdateInput = Parameters<typeof posthog.organizationsProjectsRotateSecretTokenPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2447
|
+
type OrganizationsProjectsRotateSecretTokenPartialUpdateOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsRotateSecretTokenPartialUpdate>>;
|
|
2448
|
+
|
|
2449
|
+
const result: OrganizationsProjectsRotateSecretTokenPartialUpdateOutput = await posthog.organizationsProjectsRotateSecretTokenPartialUpdate();
|
|
2450
|
+
|
|
2451
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2452
|
+
```
|
|
2453
|
+
|
|
2454
|
+
### `posthog.organizationsProjectsSettingsAsOfRetrieve`
|
|
2455
|
+
|
|
2456
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/projects/{id}/settings_as_of/`
|
|
2457
|
+
- **What it does**: Return the project settings as of the provided timestamp.
|
|
2458
|
+
Query params:
|
|
2459
|
+
- at: ISO8601 datetime (required)
|
|
2460
|
+
- scope: optional, one or multiple keys to filter the returned settings
|
|
2461
|
+
- **OpenAPI operationId**: `organizations_projects_settings_as_of_retrieve`
|
|
2462
|
+
- **Path params**: `id`
|
|
2463
|
+
- **Query params**: None
|
|
2464
|
+
- **Response codes**: `200`
|
|
2465
|
+
- **Transport options**: None
|
|
2466
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2467
|
+
|
|
2468
|
+
**Inputs**
|
|
2469
|
+
|
|
2470
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2471
|
+
- Client transport options: None
|
|
2472
|
+
|
|
2473
|
+
**Outputs**
|
|
2474
|
+
|
|
2475
|
+
- Client return type: `{ id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...`
|
|
2476
|
+
- OpenAPI response codes: `200`
|
|
2477
|
+
|
|
2478
|
+
```ts
|
|
2479
|
+
import posthog from "@utdk/posthog";
|
|
2480
|
+
|
|
2481
|
+
type OrganizationsProjectsSettingsAsOfRetrieveInput = Parameters<typeof posthog.organizationsProjectsSettingsAsOfRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2482
|
+
type OrganizationsProjectsSettingsAsOfRetrieveOutput = Awaited<ReturnType<typeof posthog.organizationsProjectsSettingsAsOfRetrieve>>;
|
|
2483
|
+
|
|
2484
|
+
const result: OrganizationsProjectsSettingsAsOfRetrieveOutput = await posthog.organizationsProjectsSettingsAsOfRetrieve();
|
|
2485
|
+
|
|
2486
|
+
// Result shape (from schema): { id: number; organization: string; name?: string; product_description?: string | null; created_at: string; effective_membership_level: 1 | 8 | 15; has_group_types: boolean; group_types: ({ [key: string]: unknown })[]; ...
|
|
2487
|
+
```
|
|
2488
|
+
|
|
2489
|
+
### `posthog.roleExternalReferencesList`
|
|
2490
|
+
|
|
2491
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/role_external_references/`
|
|
2492
|
+
- **OpenAPI operationId**: `role_external_references_list`
|
|
2493
|
+
- **Path params**: None
|
|
2494
|
+
- **Query params**: `limit`, `offset`
|
|
2495
|
+
- **Response codes**: `200`
|
|
2496
|
+
- **Transport options**: None
|
|
2497
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2498
|
+
|
|
2499
|
+
**Inputs**
|
|
2500
|
+
|
|
2501
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2502
|
+
- Client transport options: None
|
|
2503
|
+
|
|
2504
|
+
**Outputs**
|
|
2505
|
+
|
|
2506
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_na...`
|
|
2507
|
+
- OpenAPI response codes: `200`
|
|
2508
|
+
|
|
2509
|
+
```ts
|
|
2510
|
+
import posthog from "@utdk/posthog";
|
|
2511
|
+
|
|
2512
|
+
type RoleExternalReferencesListInput = Parameters<typeof posthog.roleExternalReferencesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2513
|
+
type RoleExternalReferencesListOutput = Awaited<ReturnType<typeof posthog.roleExternalReferencesList>>;
|
|
2514
|
+
|
|
2515
|
+
const result: RoleExternalReferencesListOutput = await posthog.roleExternalReferencesList();
|
|
2516
|
+
|
|
2517
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_na...
|
|
2518
|
+
```
|
|
2519
|
+
|
|
2520
|
+
### `posthog.roleExternalReferencesCreate`
|
|
2521
|
+
|
|
2522
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/role_external_references/`
|
|
2523
|
+
- **OpenAPI operationId**: `role_external_references_create`
|
|
2524
|
+
- **Path params**: None
|
|
2525
|
+
- **Query params**: None
|
|
2526
|
+
- **Response codes**: `201`
|
|
2527
|
+
- **Transport options**: None
|
|
2528
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2529
|
+
|
|
2530
|
+
**Inputs**
|
|
2531
|
+
|
|
2532
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2533
|
+
- Client transport options: None
|
|
2534
|
+
|
|
2535
|
+
**Outputs**
|
|
2536
|
+
|
|
2537
|
+
- Client return type: `{ id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_name: string; role: string; created_at: string; created_by: { id: number; uui...`
|
|
2538
|
+
- OpenAPI response codes: `201`
|
|
2539
|
+
|
|
2540
|
+
```ts
|
|
2541
|
+
import posthog from "@utdk/posthog";
|
|
2542
|
+
|
|
2543
|
+
type RoleExternalReferencesCreateInput = Parameters<typeof posthog.roleExternalReferencesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2544
|
+
type RoleExternalReferencesCreateOutput = Awaited<ReturnType<typeof posthog.roleExternalReferencesCreate>>;
|
|
2545
|
+
|
|
2546
|
+
const result: RoleExternalReferencesCreateOutput = await posthog.roleExternalReferencesCreate();
|
|
2547
|
+
|
|
2548
|
+
// Result shape (from schema): { id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_name: string; role: string; created_at: string; created_by: { id: number; uui...
|
|
2549
|
+
```
|
|
2550
|
+
|
|
2551
|
+
### `posthog.roleExternalReferencesDestroy`
|
|
2552
|
+
|
|
2553
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/role_external_references/{id}/`
|
|
2554
|
+
- **OpenAPI operationId**: `role_external_references_destroy`
|
|
2555
|
+
- **Path params**: `id`
|
|
2556
|
+
- **Query params**: None
|
|
2557
|
+
- **Response codes**: `204`
|
|
2558
|
+
- **Transport options**: None
|
|
2559
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2560
|
+
|
|
2561
|
+
**Inputs**
|
|
2562
|
+
|
|
2563
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2564
|
+
- Client transport options: None
|
|
2565
|
+
|
|
2566
|
+
**Outputs**
|
|
2567
|
+
|
|
2568
|
+
- Client return type: `unknown`
|
|
2569
|
+
- OpenAPI response codes: `204`
|
|
2570
|
+
|
|
2571
|
+
```ts
|
|
2572
|
+
import posthog from "@utdk/posthog";
|
|
2573
|
+
|
|
2574
|
+
type RoleExternalReferencesDestroyInput = Parameters<typeof posthog.roleExternalReferencesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2575
|
+
type RoleExternalReferencesDestroyOutput = Awaited<ReturnType<typeof posthog.roleExternalReferencesDestroy>>;
|
|
2576
|
+
|
|
2577
|
+
const result: RoleExternalReferencesDestroyOutput = await posthog.roleExternalReferencesDestroy();
|
|
2578
|
+
|
|
2579
|
+
// Result shape (from schema): unknown
|
|
2580
|
+
```
|
|
2581
|
+
|
|
2582
|
+
### `posthog.roleExternalReferencesLookupRetrieve`
|
|
2583
|
+
|
|
2584
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/role_external_references/lookup/`
|
|
2585
|
+
- **OpenAPI operationId**: `role_external_references_lookup_retrieve`
|
|
2586
|
+
- **Path params**: None
|
|
2587
|
+
- **Query params**: `provider`, `provider_organization_id`, `provider_role_id`, `provider_role_slug`
|
|
2588
|
+
- **Response codes**: `200`
|
|
2589
|
+
- **Transport options**: None
|
|
2590
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2591
|
+
|
|
2592
|
+
**Inputs**
|
|
2593
|
+
|
|
2594
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2595
|
+
- Client transport options: None
|
|
2596
|
+
|
|
2597
|
+
**Outputs**
|
|
2598
|
+
|
|
2599
|
+
- Client return type: `{ reference: { id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_name: string; role: string; created_at: string; created_by: { id...`
|
|
2600
|
+
- OpenAPI response codes: `200`
|
|
2601
|
+
|
|
2602
|
+
```ts
|
|
2603
|
+
import posthog from "@utdk/posthog";
|
|
2604
|
+
|
|
2605
|
+
type RoleExternalReferencesLookupRetrieveInput = Parameters<typeof posthog.roleExternalReferencesLookupRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2606
|
+
type RoleExternalReferencesLookupRetrieveOutput = Awaited<ReturnType<typeof posthog.roleExternalReferencesLookupRetrieve>>;
|
|
2607
|
+
|
|
2608
|
+
const result: RoleExternalReferencesLookupRetrieveOutput = await posthog.roleExternalReferencesLookupRetrieve();
|
|
2609
|
+
|
|
2610
|
+
// Result shape (from schema): { reference: { id: string; provider: string; provider_organization_id: string; provider_role_id: string; provider_role_slug?: string | null; provider_role_name: string; role: string; created_at: string; created_by: { id...
|
|
2611
|
+
```
|
|
2612
|
+
|
|
2613
|
+
### `posthog.rolesList`
|
|
2614
|
+
|
|
2615
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/roles/`
|
|
2616
|
+
- **OpenAPI operationId**: `roles_list`
|
|
2617
|
+
- **Path params**: None
|
|
2618
|
+
- **Query params**: `limit`, `offset`
|
|
2619
|
+
- **Response codes**: `200`
|
|
2620
|
+
- **Transport options**: None
|
|
2621
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2622
|
+
|
|
2623
|
+
**Inputs**
|
|
2624
|
+
|
|
2625
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2626
|
+
- Client transport options: None
|
|
2627
|
+
|
|
2628
|
+
**Outputs**
|
|
2629
|
+
|
|
2630
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_n...`
|
|
2631
|
+
- OpenAPI response codes: `200`
|
|
2632
|
+
|
|
2633
|
+
```ts
|
|
2634
|
+
import posthog from "@utdk/posthog";
|
|
2635
|
+
|
|
2636
|
+
type RolesListInput = Parameters<typeof posthog.rolesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2637
|
+
type RolesListOutput = Awaited<ReturnType<typeof posthog.rolesList>>;
|
|
2638
|
+
|
|
2639
|
+
const result: RolesListOutput = await posthog.rolesList();
|
|
2640
|
+
|
|
2641
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_n...
|
|
2642
|
+
```
|
|
2643
|
+
|
|
2644
|
+
### `posthog.rolesCreate`
|
|
2645
|
+
|
|
2646
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/roles/`
|
|
2647
|
+
- **OpenAPI operationId**: `roles_create`
|
|
2648
|
+
- **Path params**: None
|
|
2649
|
+
- **Query params**: None
|
|
2650
|
+
- **Response codes**: `201`
|
|
2651
|
+
- **Transport options**: None
|
|
2652
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2653
|
+
|
|
2654
|
+
**Inputs**
|
|
2655
|
+
|
|
2656
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2657
|
+
- Client transport options: None
|
|
2658
|
+
|
|
2659
|
+
**Outputs**
|
|
2660
|
+
|
|
2661
|
+
- Client return type: `{ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...`
|
|
2662
|
+
- OpenAPI response codes: `201`
|
|
2663
|
+
|
|
2664
|
+
```ts
|
|
2665
|
+
import posthog from "@utdk/posthog";
|
|
2666
|
+
|
|
2667
|
+
type RolesCreateInput = Parameters<typeof posthog.rolesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2668
|
+
type RolesCreateOutput = Awaited<ReturnType<typeof posthog.rolesCreate>>;
|
|
2669
|
+
|
|
2670
|
+
const result: RolesCreateOutput = await posthog.rolesCreate();
|
|
2671
|
+
|
|
2672
|
+
// Result shape (from schema): { id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...
|
|
2673
|
+
```
|
|
2674
|
+
|
|
2675
|
+
### `posthog.rolesDestroy`
|
|
2676
|
+
|
|
2677
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/roles/{id}/`
|
|
2678
|
+
- **OpenAPI operationId**: `roles_destroy`
|
|
2679
|
+
- **Path params**: `id`
|
|
2680
|
+
- **Query params**: None
|
|
2681
|
+
- **Response codes**: `204`
|
|
2682
|
+
- **Transport options**: None
|
|
2683
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2684
|
+
|
|
2685
|
+
**Inputs**
|
|
2686
|
+
|
|
2687
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2688
|
+
- Client transport options: None
|
|
2689
|
+
|
|
2690
|
+
**Outputs**
|
|
2691
|
+
|
|
2692
|
+
- Client return type: `unknown`
|
|
2693
|
+
- OpenAPI response codes: `204`
|
|
2694
|
+
|
|
2695
|
+
```ts
|
|
2696
|
+
import posthog from "@utdk/posthog";
|
|
2697
|
+
|
|
2698
|
+
type RolesDestroyInput = Parameters<typeof posthog.rolesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2699
|
+
type RolesDestroyOutput = Awaited<ReturnType<typeof posthog.rolesDestroy>>;
|
|
2700
|
+
|
|
2701
|
+
const result: RolesDestroyOutput = await posthog.rolesDestroy();
|
|
2702
|
+
|
|
2703
|
+
// Result shape (from schema): unknown
|
|
2704
|
+
```
|
|
2705
|
+
|
|
2706
|
+
### `posthog.rolesRetrieve`
|
|
2707
|
+
|
|
2708
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/roles/{id}/`
|
|
2709
|
+
- **OpenAPI operationId**: `roles_retrieve`
|
|
2710
|
+
- **Path params**: `id`
|
|
2711
|
+
- **Query params**: None
|
|
2712
|
+
- **Response codes**: `200`
|
|
2713
|
+
- **Transport options**: None
|
|
2714
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2715
|
+
|
|
2716
|
+
**Inputs**
|
|
2717
|
+
|
|
2718
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2719
|
+
- Client transport options: None
|
|
2720
|
+
|
|
2721
|
+
**Outputs**
|
|
2722
|
+
|
|
2723
|
+
- Client return type: `{ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...`
|
|
2724
|
+
- OpenAPI response codes: `200`
|
|
2725
|
+
|
|
2726
|
+
```ts
|
|
2727
|
+
import posthog from "@utdk/posthog";
|
|
2728
|
+
|
|
2729
|
+
type RolesRetrieveInput = Parameters<typeof posthog.rolesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2730
|
+
type RolesRetrieveOutput = Awaited<ReturnType<typeof posthog.rolesRetrieve>>;
|
|
2731
|
+
|
|
2732
|
+
const result: RolesRetrieveOutput = await posthog.rolesRetrieve();
|
|
2733
|
+
|
|
2734
|
+
// Result shape (from schema): { id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...
|
|
2735
|
+
```
|
|
2736
|
+
|
|
2737
|
+
### `posthog.rolesPartialUpdate`
|
|
2738
|
+
|
|
2739
|
+
- **HTTP**: `PATCH /api/organizations/{organization_id}/roles/{id}/`
|
|
2740
|
+
- **OpenAPI operationId**: `roles_partial_update`
|
|
2741
|
+
- **Path params**: `id`
|
|
2742
|
+
- **Query params**: None
|
|
2743
|
+
- **Response codes**: `200`
|
|
2744
|
+
- **Transport options**: None
|
|
2745
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2746
|
+
|
|
2747
|
+
**Inputs**
|
|
2748
|
+
|
|
2749
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2750
|
+
- Client transport options: None
|
|
2751
|
+
|
|
2752
|
+
**Outputs**
|
|
2753
|
+
|
|
2754
|
+
- Client return type: `{ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...`
|
|
2755
|
+
- OpenAPI response codes: `200`
|
|
2756
|
+
|
|
2757
|
+
```ts
|
|
2758
|
+
import posthog from "@utdk/posthog";
|
|
2759
|
+
|
|
2760
|
+
type RolesPartialUpdateInput = Parameters<typeof posthog.rolesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2761
|
+
type RolesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.rolesPartialUpdate>>;
|
|
2762
|
+
|
|
2763
|
+
const result: RolesPartialUpdateOutput = await posthog.rolesPartialUpdate();
|
|
2764
|
+
|
|
2765
|
+
// Result shape (from schema): { id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...
|
|
2766
|
+
```
|
|
2767
|
+
|
|
2768
|
+
### `posthog.rolesUpdate`
|
|
2769
|
+
|
|
2770
|
+
- **HTTP**: `PUT /api/organizations/{organization_id}/roles/{id}/`
|
|
2771
|
+
- **OpenAPI operationId**: `roles_update`
|
|
2772
|
+
- **Path params**: `id`
|
|
2773
|
+
- **Query params**: None
|
|
2774
|
+
- **Response codes**: `200`
|
|
2775
|
+
- **Transport options**: None
|
|
2776
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2777
|
+
|
|
2778
|
+
**Inputs**
|
|
2779
|
+
|
|
2780
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2781
|
+
- Client transport options: None
|
|
2782
|
+
|
|
2783
|
+
**Outputs**
|
|
2784
|
+
|
|
2785
|
+
- Client return type: `{ id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...`
|
|
2786
|
+
- OpenAPI response codes: `200`
|
|
2787
|
+
|
|
2788
|
+
```ts
|
|
2789
|
+
import posthog from "@utdk/posthog";
|
|
2790
|
+
|
|
2791
|
+
type RolesUpdateInput = Parameters<typeof posthog.rolesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2792
|
+
type RolesUpdateOutput = Awaited<ReturnType<typeof posthog.rolesUpdate>>;
|
|
2793
|
+
|
|
2794
|
+
const result: RolesUpdateOutput = await posthog.rolesUpdate();
|
|
2795
|
+
|
|
2796
|
+
// Result shape (from schema): { id: string; name: string; created_at: string; created_by: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null; hedgehog_c...
|
|
2797
|
+
```
|
|
2798
|
+
|
|
2799
|
+
### `posthog.rolesRoleMembershipsList`
|
|
2800
|
+
|
|
2801
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/roles/{role_id}/role_memberships/`
|
|
2802
|
+
- **OpenAPI operationId**: `roles_role_memberships_list`
|
|
2803
|
+
- **Path params**: `role_id`
|
|
2804
|
+
- **Query params**: `limit`, `offset`
|
|
2805
|
+
- **Response codes**: `200`
|
|
2806
|
+
- **Transport options**: None
|
|
2807
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2808
|
+
|
|
2809
|
+
**Inputs**
|
|
2810
|
+
|
|
2811
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2812
|
+
- Client transport options: None
|
|
2813
|
+
|
|
2814
|
+
**Outputs**
|
|
2815
|
+
|
|
2816
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: st...`
|
|
2817
|
+
- OpenAPI response codes: `200`
|
|
2818
|
+
|
|
2819
|
+
```ts
|
|
2820
|
+
import posthog from "@utdk/posthog";
|
|
2821
|
+
|
|
2822
|
+
type RolesRoleMembershipsListInput = Parameters<typeof posthog.rolesRoleMembershipsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2823
|
+
type RolesRoleMembershipsListOutput = Awaited<ReturnType<typeof posthog.rolesRoleMembershipsList>>;
|
|
2824
|
+
|
|
2825
|
+
const result: RolesRoleMembershipsListOutput = await posthog.rolesRoleMembershipsList();
|
|
2826
|
+
|
|
2827
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: st...
|
|
2828
|
+
```
|
|
2829
|
+
|
|
2830
|
+
### `posthog.rolesRoleMembershipsCreate`
|
|
2831
|
+
|
|
2832
|
+
- **HTTP**: `POST /api/organizations/{organization_id}/roles/{role_id}/role_memberships/`
|
|
2833
|
+
- **OpenAPI operationId**: `roles_role_memberships_create`
|
|
2834
|
+
- **Path params**: `role_id`
|
|
2835
|
+
- **Query params**: None
|
|
2836
|
+
- **Response codes**: `201`
|
|
2837
|
+
- **Transport options**: None
|
|
2838
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2839
|
+
|
|
2840
|
+
**Inputs**
|
|
2841
|
+
|
|
2842
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2843
|
+
- Client transport options: None
|
|
2844
|
+
|
|
2845
|
+
**Outputs**
|
|
2846
|
+
|
|
2847
|
+
- Client return type: `{ id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null...`
|
|
2848
|
+
- OpenAPI response codes: `201`
|
|
2849
|
+
|
|
2850
|
+
```ts
|
|
2851
|
+
import posthog from "@utdk/posthog";
|
|
2852
|
+
|
|
2853
|
+
type RolesRoleMembershipsCreateInput = Parameters<typeof posthog.rolesRoleMembershipsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2854
|
+
type RolesRoleMembershipsCreateOutput = Awaited<ReturnType<typeof posthog.rolesRoleMembershipsCreate>>;
|
|
2855
|
+
|
|
2856
|
+
const result: RolesRoleMembershipsCreateOutput = await posthog.rolesRoleMembershipsCreate();
|
|
2857
|
+
|
|
2858
|
+
// Result shape (from schema): { id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null...
|
|
2859
|
+
```
|
|
2860
|
+
|
|
2861
|
+
### `posthog.rolesRoleMembershipsDestroy`
|
|
2862
|
+
|
|
2863
|
+
- **HTTP**: `DELETE /api/organizations/{organization_id}/roles/{role_id}/role_memberships/{id}/`
|
|
2864
|
+
- **OpenAPI operationId**: `roles_role_memberships_destroy`
|
|
2865
|
+
- **Path params**: `id`, `role_id`
|
|
2866
|
+
- **Query params**: None
|
|
2867
|
+
- **Response codes**: `204`
|
|
2868
|
+
- **Transport options**: None
|
|
2869
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2870
|
+
|
|
2871
|
+
**Inputs**
|
|
2872
|
+
|
|
2873
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2874
|
+
- Client transport options: None
|
|
2875
|
+
|
|
2876
|
+
**Outputs**
|
|
2877
|
+
|
|
2878
|
+
- Client return type: `unknown`
|
|
2879
|
+
- OpenAPI response codes: `204`
|
|
2880
|
+
|
|
2881
|
+
```ts
|
|
2882
|
+
import posthog from "@utdk/posthog";
|
|
2883
|
+
|
|
2884
|
+
type RolesRoleMembershipsDestroyInput = Parameters<typeof posthog.rolesRoleMembershipsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2885
|
+
type RolesRoleMembershipsDestroyOutput = Awaited<ReturnType<typeof posthog.rolesRoleMembershipsDestroy>>;
|
|
2886
|
+
|
|
2887
|
+
const result: RolesRoleMembershipsDestroyOutput = await posthog.rolesRoleMembershipsDestroy();
|
|
2888
|
+
|
|
2889
|
+
// Result shape (from schema): unknown
|
|
2890
|
+
```
|
|
2891
|
+
|
|
2892
|
+
### `posthog.rolesRoleMembershipsRetrieve`
|
|
2893
|
+
|
|
2894
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/roles/{role_id}/role_memberships/{id}/`
|
|
2895
|
+
- **OpenAPI operationId**: `roles_role_memberships_retrieve`
|
|
2896
|
+
- **Path params**: `id`, `role_id`
|
|
2897
|
+
- **Query params**: None
|
|
2898
|
+
- **Response codes**: `200`
|
|
2899
|
+
- **Transport options**: None
|
|
2900
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2901
|
+
|
|
2902
|
+
**Inputs**
|
|
2903
|
+
|
|
2904
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2905
|
+
- Client transport options: None
|
|
2906
|
+
|
|
2907
|
+
**Outputs**
|
|
2908
|
+
|
|
2909
|
+
- Client return type: `{ id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null...`
|
|
2910
|
+
- OpenAPI response codes: `200`
|
|
2911
|
+
|
|
2912
|
+
```ts
|
|
2913
|
+
import posthog from "@utdk/posthog";
|
|
2914
|
+
|
|
2915
|
+
type RolesRoleMembershipsRetrieveInput = Parameters<typeof posthog.rolesRoleMembershipsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2916
|
+
type RolesRoleMembershipsRetrieveOutput = Awaited<ReturnType<typeof posthog.rolesRoleMembershipsRetrieve>>;
|
|
2917
|
+
|
|
2918
|
+
const result: RolesRoleMembershipsRetrieveOutput = await posthog.rolesRoleMembershipsRetrieve();
|
|
2919
|
+
|
|
2920
|
+
// Result shape (from schema): { id: string; role_id: string; organization_member: { id: string; user: { id: number; uuid: string; distinct_id?: string | null; first_name?: string; last_name?: string; email: string; is_email_verified?: boolean | null...
|
|
2921
|
+
```
|
|
2922
|
+
|
|
2923
|
+
### `posthog.welcomeCurrentRetrieve`
|
|
2924
|
+
|
|
2925
|
+
- **HTTP**: `GET /api/organizations/{organization_id}/welcome/current/`
|
|
2926
|
+
- **What it does**: Aggregated payload for the invited-user welcome screen.
|
|
2927
|
+
- **OpenAPI operationId**: `welcome_current_retrieve`
|
|
2928
|
+
- **Path params**: None
|
|
2929
|
+
- **Query params**: None
|
|
2930
|
+
- **Response codes**: `200`, `404`
|
|
2931
|
+
- **Transport options**: None
|
|
2932
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
2933
|
+
|
|
2934
|
+
**Inputs**
|
|
2935
|
+
|
|
2936
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
2937
|
+
- Client transport options: None
|
|
2938
|
+
|
|
2939
|
+
**Outputs**
|
|
2940
|
+
|
|
2941
|
+
- Client return type: `{ organization_name: string; inviter: { name: string; email: string } | null; team_members: ({ name: string; email: string; avatar: string | null; role: string; last_active: "today" | "this_week" | "inactive" | "never" ...`
|
|
2942
|
+
- OpenAPI response codes: `200`, `404`
|
|
2943
|
+
|
|
2944
|
+
```ts
|
|
2945
|
+
import posthog from "@utdk/posthog";
|
|
2946
|
+
|
|
2947
|
+
type WelcomeCurrentRetrieveInput = Parameters<typeof posthog.welcomeCurrentRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
2948
|
+
type WelcomeCurrentRetrieveOutput = Awaited<ReturnType<typeof posthog.welcomeCurrentRetrieve>>;
|
|
2949
|
+
|
|
2950
|
+
const result: WelcomeCurrentRetrieveOutput = await posthog.welcomeCurrentRetrieve();
|
|
2951
|
+
|
|
2952
|
+
// Result shape (from schema): { organization_name: string; inviter: { name: string; email: string } | null; team_members: ({ name: string; email: string; avatar: string | null; role: string; last_active: "today" | "this_week" | "inactive" | "never" ...
|
|
2953
|
+
```
|
|
2954
|
+
|
|
2955
|
+
|
|
2956
|
+
<!-- prompt-hash:
|
|
2957
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
2958
|
+
-->
|