@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,1954 @@
|
|
|
1
|
+
# Integrations
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsIntegrationsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_integrations_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `kind`, `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: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customeri...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsIntegrationsListInput = Parameters<typeof posthog.environmentsIntegrationsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsIntegrationsListOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsIntegrationsListOutput = await posthog.environmentsIntegrationsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customeri...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.environmentsIntegrationsCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/`
|
|
39
|
+
- **OpenAPI operationId**: `environments_integrations_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: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EnvironmentsIntegrationsCreateInput = Parameters<typeof posthog.environmentsIntegrationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EnvironmentsIntegrationsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EnvironmentsIntegrationsCreateOutput = await posthog.environmentsIntegrationsCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.environmentsIntegrationsDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/integrations/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `environments_integrations_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 EnvironmentsIntegrationsDestroyInput = Parameters<typeof posthog.environmentsIntegrationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type EnvironmentsIntegrationsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: EnvironmentsIntegrationsDestroyOutput = await posthog.environmentsIntegrationsDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.environmentsIntegrationsRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `environments_integrations_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: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type EnvironmentsIntegrationsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type EnvironmentsIntegrationsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: EnvironmentsIntegrationsRetrieveOutput = await posthog.environmentsIntegrationsRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.environmentsIntegrationsAnthropicManagedAgentEnvsRetrieve`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/anthropic_managed_agent_environments/`
|
|
132
|
+
- **OpenAPI operationId**: `environments_integrations_anthropic_managed_agent_envs_retrieve`
|
|
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: `unknown`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentEnvsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsAnthropicManagedAgentEnvsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentEnvsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsAnthropicManagedAgentEnvsRetrieve>>;
|
|
154
|
+
|
|
155
|
+
const result: EnvironmentsIntegrationsAnthropicManagedAgentEnvsRetrieveOutput = await posthog.environmentsIntegrationsAnthropicManagedAgentEnvsRetrieve();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): unknown
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.environmentsIntegrationsAnthropicManagedAgentVaultsRetrieve`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/anthropic_managed_agent_vaults/`
|
|
163
|
+
- **OpenAPI operationId**: `environments_integrations_anthropic_managed_agent_vaults_retrieve`
|
|
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: `unknown`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentVaultsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsAnthropicManagedAgentVaultsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentVaultsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsAnthropicManagedAgentVaultsRetrieve>>;
|
|
185
|
+
|
|
186
|
+
const result: EnvironmentsIntegrationsAnthropicManagedAgentVaultsRetrieveOutput = await posthog.environmentsIntegrationsAnthropicManagedAgentVaultsRetrieve();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): unknown
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### `posthog.environmentsIntegrationsAnthropicManagedAgentsRetrieve`
|
|
192
|
+
|
|
193
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/anthropic_managed_agents/`
|
|
194
|
+
- **OpenAPI operationId**: `environments_integrations_anthropic_managed_agents_retrieve`
|
|
195
|
+
- **Path params**: `id`
|
|
196
|
+
- **Query params**: None
|
|
197
|
+
- **Response codes**: `200`
|
|
198
|
+
- **Transport options**: None
|
|
199
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
200
|
+
|
|
201
|
+
**Inputs**
|
|
202
|
+
|
|
203
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
204
|
+
- Client transport options: None
|
|
205
|
+
|
|
206
|
+
**Outputs**
|
|
207
|
+
|
|
208
|
+
- Client return type: `unknown`
|
|
209
|
+
- OpenAPI response codes: `200`
|
|
210
|
+
|
|
211
|
+
```ts
|
|
212
|
+
import posthog from "@utdk/posthog";
|
|
213
|
+
|
|
214
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsAnthropicManagedAgentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
215
|
+
type EnvironmentsIntegrationsAnthropicManagedAgentsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsAnthropicManagedAgentsRetrieve>>;
|
|
216
|
+
|
|
217
|
+
const result: EnvironmentsIntegrationsAnthropicManagedAgentsRetrieveOutput = await posthog.environmentsIntegrationsAnthropicManagedAgentsRetrieve();
|
|
218
|
+
|
|
219
|
+
// Result shape (from schema): unknown
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### `posthog.environmentsIntegrationsChannelsRetrieve`
|
|
223
|
+
|
|
224
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/channels/`
|
|
225
|
+
- **OpenAPI operationId**: `environments_integrations_channels_retrieve`
|
|
226
|
+
- **Path params**: `id`
|
|
227
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
228
|
+
- **Response codes**: `200`
|
|
229
|
+
- **Transport options**: None
|
|
230
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
231
|
+
|
|
232
|
+
**Inputs**
|
|
233
|
+
|
|
234
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
235
|
+
- Client transport options: None
|
|
236
|
+
|
|
237
|
+
**Outputs**
|
|
238
|
+
|
|
239
|
+
- Client return type: `{ channels: ({ id: string; name: string; is_private: boolean; is_member: boolean; is_ext_shared: boolean; is_private_without_access: boolean })[]; lastRefreshedAt?: string | null; has_more?: boolean }`
|
|
240
|
+
- OpenAPI response codes: `200`
|
|
241
|
+
|
|
242
|
+
```ts
|
|
243
|
+
import posthog from "@utdk/posthog";
|
|
244
|
+
|
|
245
|
+
type EnvironmentsIntegrationsChannelsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsChannelsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
246
|
+
type EnvironmentsIntegrationsChannelsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsChannelsRetrieve>>;
|
|
247
|
+
|
|
248
|
+
const result: EnvironmentsIntegrationsChannelsRetrieveOutput = await posthog.environmentsIntegrationsChannelsRetrieve();
|
|
249
|
+
|
|
250
|
+
// Result shape (from schema): { channels: ({ id: string; name: string; is_private: boolean; is_member: boolean; is_ext_shared: boolean; is_private_without_access: boolean })[]; lastRefreshedAt?: string | null; has_more?: boolean }
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### `posthog.environmentsIntegrationsClickupListsRetrieve`
|
|
254
|
+
|
|
255
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/clickup_lists/`
|
|
256
|
+
- **OpenAPI operationId**: `environments_integrations_clickup_lists_retrieve`
|
|
257
|
+
- **Path params**: `id`
|
|
258
|
+
- **Query params**: None
|
|
259
|
+
- **Response codes**: `200`
|
|
260
|
+
- **Transport options**: None
|
|
261
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
262
|
+
|
|
263
|
+
**Inputs**
|
|
264
|
+
|
|
265
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
266
|
+
- Client transport options: None
|
|
267
|
+
|
|
268
|
+
**Outputs**
|
|
269
|
+
|
|
270
|
+
- Client return type: `unknown`
|
|
271
|
+
- OpenAPI response codes: `200`
|
|
272
|
+
|
|
273
|
+
```ts
|
|
274
|
+
import posthog from "@utdk/posthog";
|
|
275
|
+
|
|
276
|
+
type EnvironmentsIntegrationsClickupListsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsClickupListsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
277
|
+
type EnvironmentsIntegrationsClickupListsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsClickupListsRetrieve>>;
|
|
278
|
+
|
|
279
|
+
const result: EnvironmentsIntegrationsClickupListsRetrieveOutput = await posthog.environmentsIntegrationsClickupListsRetrieve();
|
|
280
|
+
|
|
281
|
+
// Result shape (from schema): unknown
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### `posthog.environmentsIntegrationsClickupSpacesRetrieve`
|
|
285
|
+
|
|
286
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/clickup_spaces/`
|
|
287
|
+
- **OpenAPI operationId**: `environments_integrations_clickup_spaces_retrieve`
|
|
288
|
+
- **Path params**: `id`
|
|
289
|
+
- **Query params**: None
|
|
290
|
+
- **Response codes**: `200`
|
|
291
|
+
- **Transport options**: None
|
|
292
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
293
|
+
|
|
294
|
+
**Inputs**
|
|
295
|
+
|
|
296
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
297
|
+
- Client transport options: None
|
|
298
|
+
|
|
299
|
+
**Outputs**
|
|
300
|
+
|
|
301
|
+
- Client return type: `unknown`
|
|
302
|
+
- OpenAPI response codes: `200`
|
|
303
|
+
|
|
304
|
+
```ts
|
|
305
|
+
import posthog from "@utdk/posthog";
|
|
306
|
+
|
|
307
|
+
type EnvironmentsIntegrationsClickupSpacesRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsClickupSpacesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
308
|
+
type EnvironmentsIntegrationsClickupSpacesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsClickupSpacesRetrieve>>;
|
|
309
|
+
|
|
310
|
+
const result: EnvironmentsIntegrationsClickupSpacesRetrieveOutput = await posthog.environmentsIntegrationsClickupSpacesRetrieve();
|
|
311
|
+
|
|
312
|
+
// Result shape (from schema): unknown
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### `posthog.environmentsIntegrationsClickupWorkspacesRetrieve`
|
|
316
|
+
|
|
317
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/clickup_workspaces/`
|
|
318
|
+
- **OpenAPI operationId**: `environments_integrations_clickup_workspaces_retrieve`
|
|
319
|
+
- **Path params**: `id`
|
|
320
|
+
- **Query params**: None
|
|
321
|
+
- **Response codes**: `200`
|
|
322
|
+
- **Transport options**: None
|
|
323
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
324
|
+
|
|
325
|
+
**Inputs**
|
|
326
|
+
|
|
327
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
328
|
+
- Client transport options: None
|
|
329
|
+
|
|
330
|
+
**Outputs**
|
|
331
|
+
|
|
332
|
+
- Client return type: `unknown`
|
|
333
|
+
- OpenAPI response codes: `200`
|
|
334
|
+
|
|
335
|
+
```ts
|
|
336
|
+
import posthog from "@utdk/posthog";
|
|
337
|
+
|
|
338
|
+
type EnvironmentsIntegrationsClickupWorkspacesRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsClickupWorkspacesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
339
|
+
type EnvironmentsIntegrationsClickupWorkspacesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsClickupWorkspacesRetrieve>>;
|
|
340
|
+
|
|
341
|
+
const result: EnvironmentsIntegrationsClickupWorkspacesRetrieveOutput = await posthog.environmentsIntegrationsClickupWorkspacesRetrieve();
|
|
342
|
+
|
|
343
|
+
// Result shape (from schema): unknown
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### `posthog.environmentsIntegrationsEmailPartialUpdate`
|
|
347
|
+
|
|
348
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/integrations/{id}/email/`
|
|
349
|
+
- **OpenAPI operationId**: `environments_integrations_email_partial_update`
|
|
350
|
+
- **Path params**: `id`
|
|
351
|
+
- **Query params**: None
|
|
352
|
+
- **Response codes**: `200`
|
|
353
|
+
- **Transport options**: None
|
|
354
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
355
|
+
|
|
356
|
+
**Inputs**
|
|
357
|
+
|
|
358
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
359
|
+
- Client transport options: None
|
|
360
|
+
|
|
361
|
+
**Outputs**
|
|
362
|
+
|
|
363
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
364
|
+
- OpenAPI response codes: `200`
|
|
365
|
+
|
|
366
|
+
```ts
|
|
367
|
+
import posthog from "@utdk/posthog";
|
|
368
|
+
|
|
369
|
+
type EnvironmentsIntegrationsEmailPartialUpdateInput = Parameters<typeof posthog.environmentsIntegrationsEmailPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
370
|
+
type EnvironmentsIntegrationsEmailPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsEmailPartialUpdate>>;
|
|
371
|
+
|
|
372
|
+
const result: EnvironmentsIntegrationsEmailPartialUpdateOutput = await posthog.environmentsIntegrationsEmailPartialUpdate();
|
|
373
|
+
|
|
374
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### `posthog.environmentsIntegrationsEmailVerifyCreate`
|
|
378
|
+
|
|
379
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/{id}/email/verify/`
|
|
380
|
+
- **OpenAPI operationId**: `environments_integrations_email_verify_create`
|
|
381
|
+
- **Path params**: `id`
|
|
382
|
+
- **Query params**: None
|
|
383
|
+
- **Response codes**: `200`
|
|
384
|
+
- **Transport options**: None
|
|
385
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
386
|
+
|
|
387
|
+
**Inputs**
|
|
388
|
+
|
|
389
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
390
|
+
- Client transport options: None
|
|
391
|
+
|
|
392
|
+
**Outputs**
|
|
393
|
+
|
|
394
|
+
- Client return type: `unknown`
|
|
395
|
+
- OpenAPI response codes: `200`
|
|
396
|
+
|
|
397
|
+
```ts
|
|
398
|
+
import posthog from "@utdk/posthog";
|
|
399
|
+
|
|
400
|
+
type EnvironmentsIntegrationsEmailVerifyCreateInput = Parameters<typeof posthog.environmentsIntegrationsEmailVerifyCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
401
|
+
type EnvironmentsIntegrationsEmailVerifyCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsEmailVerifyCreate>>;
|
|
402
|
+
|
|
403
|
+
const result: EnvironmentsIntegrationsEmailVerifyCreateOutput = await posthog.environmentsIntegrationsEmailVerifyCreate();
|
|
404
|
+
|
|
405
|
+
// Result shape (from schema): unknown
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### `posthog.environmentsIntegrationsGithubBranchesRetrieve`
|
|
409
|
+
|
|
410
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/github_branches/`
|
|
411
|
+
- **OpenAPI operationId**: `environments_integrations_github_branches_retrieve`
|
|
412
|
+
- **Path params**: `id`
|
|
413
|
+
- **Query params**: `limit`, `offset`, `repo`, `search`
|
|
414
|
+
- **Response codes**: `200`
|
|
415
|
+
- **Transport options**: None
|
|
416
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
417
|
+
|
|
418
|
+
**Inputs**
|
|
419
|
+
|
|
420
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
421
|
+
- Client transport options: None
|
|
422
|
+
|
|
423
|
+
**Outputs**
|
|
424
|
+
|
|
425
|
+
- Client return type: `{ branches: (string)[]; default_branch?: string | null; has_more: boolean }`
|
|
426
|
+
- OpenAPI response codes: `200`
|
|
427
|
+
|
|
428
|
+
```ts
|
|
429
|
+
import posthog from "@utdk/posthog";
|
|
430
|
+
|
|
431
|
+
type EnvironmentsIntegrationsGithubBranchesRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsGithubBranchesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
432
|
+
type EnvironmentsIntegrationsGithubBranchesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubBranchesRetrieve>>;
|
|
433
|
+
|
|
434
|
+
const result: EnvironmentsIntegrationsGithubBranchesRetrieveOutput = await posthog.environmentsIntegrationsGithubBranchesRetrieve();
|
|
435
|
+
|
|
436
|
+
// Result shape (from schema): { branches: (string)[]; default_branch?: string | null; has_more: boolean }
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### `posthog.environmentsIntegrationsGithubReposRetrieve`
|
|
440
|
+
|
|
441
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/github_repos/`
|
|
442
|
+
- **OpenAPI operationId**: `environments_integrations_github_repos_retrieve`
|
|
443
|
+
- **Path params**: `id`
|
|
444
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
445
|
+
- **Response codes**: `200`
|
|
446
|
+
- **Transport options**: None
|
|
447
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
448
|
+
|
|
449
|
+
**Inputs**
|
|
450
|
+
|
|
451
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
452
|
+
- Client transport options: None
|
|
453
|
+
|
|
454
|
+
**Outputs**
|
|
455
|
+
|
|
456
|
+
- Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }`
|
|
457
|
+
- OpenAPI response codes: `200`
|
|
458
|
+
|
|
459
|
+
```ts
|
|
460
|
+
import posthog from "@utdk/posthog";
|
|
461
|
+
|
|
462
|
+
type EnvironmentsIntegrationsGithubReposRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsGithubReposRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
463
|
+
type EnvironmentsIntegrationsGithubReposRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubReposRetrieve>>;
|
|
464
|
+
|
|
465
|
+
const result: EnvironmentsIntegrationsGithubReposRetrieveOutput = await posthog.environmentsIntegrationsGithubReposRetrieve();
|
|
466
|
+
|
|
467
|
+
// Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
### `posthog.environmentsIntegrationsGithubReposRefreshCreate`
|
|
471
|
+
|
|
472
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/{id}/github_repos/refresh/`
|
|
473
|
+
- **OpenAPI operationId**: `environments_integrations_github_repos_refresh_create`
|
|
474
|
+
- **Path params**: `id`
|
|
475
|
+
- **Query params**: None
|
|
476
|
+
- **Response codes**: `200`
|
|
477
|
+
- **Transport options**: None
|
|
478
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
479
|
+
|
|
480
|
+
**Inputs**
|
|
481
|
+
|
|
482
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
483
|
+
- Client transport options: None
|
|
484
|
+
|
|
485
|
+
**Outputs**
|
|
486
|
+
|
|
487
|
+
- Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }`
|
|
488
|
+
- OpenAPI response codes: `200`
|
|
489
|
+
|
|
490
|
+
```ts
|
|
491
|
+
import posthog from "@utdk/posthog";
|
|
492
|
+
|
|
493
|
+
type EnvironmentsIntegrationsGithubReposRefreshCreateInput = Parameters<typeof posthog.environmentsIntegrationsGithubReposRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
494
|
+
type EnvironmentsIntegrationsGithubReposRefreshCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubReposRefreshCreate>>;
|
|
495
|
+
|
|
496
|
+
const result: EnvironmentsIntegrationsGithubReposRefreshCreateOutput = await posthog.environmentsIntegrationsGithubReposRefreshCreate();
|
|
497
|
+
|
|
498
|
+
// Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### `posthog.environmentsIntegrationsGithubTeamsRetrieve`
|
|
502
|
+
|
|
503
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/github_teams/`
|
|
504
|
+
- **OpenAPI operationId**: `environments_integrations_github_teams_retrieve`
|
|
505
|
+
- **Path params**: `id`
|
|
506
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
507
|
+
- **Response codes**: `200`
|
|
508
|
+
- **Transport options**: None
|
|
509
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
510
|
+
|
|
511
|
+
**Inputs**
|
|
512
|
+
|
|
513
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
514
|
+
- Client transport options: None
|
|
515
|
+
|
|
516
|
+
**Outputs**
|
|
517
|
+
|
|
518
|
+
- Client return type: `{ teams: ({ id: number; slug: string; name: string })[]; has_more: boolean }`
|
|
519
|
+
- OpenAPI response codes: `200`
|
|
520
|
+
|
|
521
|
+
```ts
|
|
522
|
+
import posthog from "@utdk/posthog";
|
|
523
|
+
|
|
524
|
+
type EnvironmentsIntegrationsGithubTeamsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsGithubTeamsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
525
|
+
type EnvironmentsIntegrationsGithubTeamsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubTeamsRetrieve>>;
|
|
526
|
+
|
|
527
|
+
const result: EnvironmentsIntegrationsGithubTeamsRetrieveOutput = await posthog.environmentsIntegrationsGithubTeamsRetrieve();
|
|
528
|
+
|
|
529
|
+
// Result shape (from schema): { teams: ({ id: number; slug: string; name: string })[]; has_more: boolean }
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
### `posthog.environmentsIntegrationsGoogleAccessibleAccountsRetrieve`
|
|
533
|
+
|
|
534
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/google_accessible_accounts/`
|
|
535
|
+
- **OpenAPI operationId**: `environments_integrations_google_accessible_accounts_retrieve`
|
|
536
|
+
- **Path params**: `id`
|
|
537
|
+
- **Query params**: None
|
|
538
|
+
- **Response codes**: `200`
|
|
539
|
+
- **Transport options**: None
|
|
540
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
541
|
+
|
|
542
|
+
**Inputs**
|
|
543
|
+
|
|
544
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
545
|
+
- Client transport options: None
|
|
546
|
+
|
|
547
|
+
**Outputs**
|
|
548
|
+
|
|
549
|
+
- Client return type: `unknown`
|
|
550
|
+
- OpenAPI response codes: `200`
|
|
551
|
+
|
|
552
|
+
```ts
|
|
553
|
+
import posthog from "@utdk/posthog";
|
|
554
|
+
|
|
555
|
+
type EnvironmentsIntegrationsGoogleAccessibleAccountsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsGoogleAccessibleAccountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
556
|
+
type EnvironmentsIntegrationsGoogleAccessibleAccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGoogleAccessibleAccountsRetrieve>>;
|
|
557
|
+
|
|
558
|
+
const result: EnvironmentsIntegrationsGoogleAccessibleAccountsRetrieveOutput = await posthog.environmentsIntegrationsGoogleAccessibleAccountsRetrieve();
|
|
559
|
+
|
|
560
|
+
// Result shape (from schema): unknown
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
### `posthog.environmentsIntegrationsGoogleConversionActionsRetrieve`
|
|
564
|
+
|
|
565
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/google_conversion_actions/`
|
|
566
|
+
- **OpenAPI operationId**: `environments_integrations_google_conversion_actions_retrieve`
|
|
567
|
+
- **Path params**: `id`
|
|
568
|
+
- **Query params**: None
|
|
569
|
+
- **Response codes**: `200`
|
|
570
|
+
- **Transport options**: None
|
|
571
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
572
|
+
|
|
573
|
+
**Inputs**
|
|
574
|
+
|
|
575
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
576
|
+
- Client transport options: None
|
|
577
|
+
|
|
578
|
+
**Outputs**
|
|
579
|
+
|
|
580
|
+
- Client return type: `unknown`
|
|
581
|
+
- OpenAPI response codes: `200`
|
|
582
|
+
|
|
583
|
+
```ts
|
|
584
|
+
import posthog from "@utdk/posthog";
|
|
585
|
+
|
|
586
|
+
type EnvironmentsIntegrationsGoogleConversionActionsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsGoogleConversionActionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
587
|
+
type EnvironmentsIntegrationsGoogleConversionActionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGoogleConversionActionsRetrieve>>;
|
|
588
|
+
|
|
589
|
+
const result: EnvironmentsIntegrationsGoogleConversionActionsRetrieveOutput = await posthog.environmentsIntegrationsGoogleConversionActionsRetrieve();
|
|
590
|
+
|
|
591
|
+
// Result shape (from schema): unknown
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### `posthog.environmentsIntegrationsJiraProjectsRetrieve`
|
|
595
|
+
|
|
596
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/jira_projects/`
|
|
597
|
+
- **OpenAPI operationId**: `environments_integrations_jira_projects_retrieve`
|
|
598
|
+
- **Path params**: `id`
|
|
599
|
+
- **Query params**: None
|
|
600
|
+
- **Response codes**: `200`
|
|
601
|
+
- **Transport options**: None
|
|
602
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
603
|
+
|
|
604
|
+
**Inputs**
|
|
605
|
+
|
|
606
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
607
|
+
- Client transport options: None
|
|
608
|
+
|
|
609
|
+
**Outputs**
|
|
610
|
+
|
|
611
|
+
- Client return type: `{ projects: ({ id: string; key: string; name: string })[] }`
|
|
612
|
+
- OpenAPI response codes: `200`
|
|
613
|
+
|
|
614
|
+
```ts
|
|
615
|
+
import posthog from "@utdk/posthog";
|
|
616
|
+
|
|
617
|
+
type EnvironmentsIntegrationsJiraProjectsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsJiraProjectsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
618
|
+
type EnvironmentsIntegrationsJiraProjectsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsJiraProjectsRetrieve>>;
|
|
619
|
+
|
|
620
|
+
const result: EnvironmentsIntegrationsJiraProjectsRetrieveOutput = await posthog.environmentsIntegrationsJiraProjectsRetrieve();
|
|
621
|
+
|
|
622
|
+
// Result shape (from schema): { projects: ({ id: string; key: string; name: string })[] }
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
### `posthog.environmentsIntegrationsLinearTeamsRetrieve`
|
|
626
|
+
|
|
627
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/linear_teams/`
|
|
628
|
+
- **OpenAPI operationId**: `environments_integrations_linear_teams_retrieve`
|
|
629
|
+
- **Path params**: `id`
|
|
630
|
+
- **Query params**: None
|
|
631
|
+
- **Response codes**: `200`
|
|
632
|
+
- **Transport options**: None
|
|
633
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
634
|
+
|
|
635
|
+
**Inputs**
|
|
636
|
+
|
|
637
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
638
|
+
- Client transport options: None
|
|
639
|
+
|
|
640
|
+
**Outputs**
|
|
641
|
+
|
|
642
|
+
- Client return type: `{ teams: ({ id: string; name: string })[] }`
|
|
643
|
+
- OpenAPI response codes: `200`
|
|
644
|
+
|
|
645
|
+
```ts
|
|
646
|
+
import posthog from "@utdk/posthog";
|
|
647
|
+
|
|
648
|
+
type EnvironmentsIntegrationsLinearTeamsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsLinearTeamsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
649
|
+
type EnvironmentsIntegrationsLinearTeamsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsLinearTeamsRetrieve>>;
|
|
650
|
+
|
|
651
|
+
const result: EnvironmentsIntegrationsLinearTeamsRetrieveOutput = await posthog.environmentsIntegrationsLinearTeamsRetrieve();
|
|
652
|
+
|
|
653
|
+
// Result shape (from schema): { teams: ({ id: string; name: string })[] }
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
### `posthog.environmentsIntegrationsLinkedinAdsAccountsRetrieve`
|
|
657
|
+
|
|
658
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/linkedin_ads_accounts/`
|
|
659
|
+
- **OpenAPI operationId**: `environments_integrations_linkedin_ads_accounts_retrieve`
|
|
660
|
+
- **Path params**: `id`
|
|
661
|
+
- **Query params**: None
|
|
662
|
+
- **Response codes**: `200`
|
|
663
|
+
- **Transport options**: None
|
|
664
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
665
|
+
|
|
666
|
+
**Inputs**
|
|
667
|
+
|
|
668
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
669
|
+
- Client transport options: None
|
|
670
|
+
|
|
671
|
+
**Outputs**
|
|
672
|
+
|
|
673
|
+
- Client return type: `unknown`
|
|
674
|
+
- OpenAPI response codes: `200`
|
|
675
|
+
|
|
676
|
+
```ts
|
|
677
|
+
import posthog from "@utdk/posthog";
|
|
678
|
+
|
|
679
|
+
type EnvironmentsIntegrationsLinkedinAdsAccountsRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsLinkedinAdsAccountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
680
|
+
type EnvironmentsIntegrationsLinkedinAdsAccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsLinkedinAdsAccountsRetrieve>>;
|
|
681
|
+
|
|
682
|
+
const result: EnvironmentsIntegrationsLinkedinAdsAccountsRetrieveOutput = await posthog.environmentsIntegrationsLinkedinAdsAccountsRetrieve();
|
|
683
|
+
|
|
684
|
+
// Result shape (from schema): unknown
|
|
685
|
+
```
|
|
686
|
+
|
|
687
|
+
### `posthog.environmentsIntegrationsLinkedinAdsConversionRulesRetrieve`
|
|
688
|
+
|
|
689
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/linkedin_ads_conversion_rules/`
|
|
690
|
+
- **OpenAPI operationId**: `environments_integrations_linkedin_ads_conversion_rules_retrieve`
|
|
691
|
+
- **Path params**: `id`
|
|
692
|
+
- **Query params**: None
|
|
693
|
+
- **Response codes**: `200`
|
|
694
|
+
- **Transport options**: None
|
|
695
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
696
|
+
|
|
697
|
+
**Inputs**
|
|
698
|
+
|
|
699
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
700
|
+
- Client transport options: None
|
|
701
|
+
|
|
702
|
+
**Outputs**
|
|
703
|
+
|
|
704
|
+
- Client return type: `unknown`
|
|
705
|
+
- OpenAPI response codes: `200`
|
|
706
|
+
|
|
707
|
+
```ts
|
|
708
|
+
import posthog from "@utdk/posthog";
|
|
709
|
+
|
|
710
|
+
type EnvironmentsIntegrationsLinkedinAdsConversionRulesRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsLinkedinAdsConversionRulesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
711
|
+
type EnvironmentsIntegrationsLinkedinAdsConversionRulesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsLinkedinAdsConversionRulesRetrieve>>;
|
|
712
|
+
|
|
713
|
+
const result: EnvironmentsIntegrationsLinkedinAdsConversionRulesRetrieveOutput = await posthog.environmentsIntegrationsLinkedinAdsConversionRulesRetrieve();
|
|
714
|
+
|
|
715
|
+
// Result shape (from schema): unknown
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
### `posthog.environmentsIntegrationsTwilioPhoneNumbersRetrieve`
|
|
719
|
+
|
|
720
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/{id}/twilio_phone_numbers/`
|
|
721
|
+
- **OpenAPI operationId**: `environments_integrations_twilio_phone_numbers_retrieve`
|
|
722
|
+
- **Path params**: `id`
|
|
723
|
+
- **Query params**: None
|
|
724
|
+
- **Response codes**: `200`
|
|
725
|
+
- **Transport options**: None
|
|
726
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
727
|
+
|
|
728
|
+
**Inputs**
|
|
729
|
+
|
|
730
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
731
|
+
- Client transport options: None
|
|
732
|
+
|
|
733
|
+
**Outputs**
|
|
734
|
+
|
|
735
|
+
- Client return type: `unknown`
|
|
736
|
+
- OpenAPI response codes: `200`
|
|
737
|
+
|
|
738
|
+
```ts
|
|
739
|
+
import posthog from "@utdk/posthog";
|
|
740
|
+
|
|
741
|
+
type EnvironmentsIntegrationsTwilioPhoneNumbersRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsTwilioPhoneNumbersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
742
|
+
type EnvironmentsIntegrationsTwilioPhoneNumbersRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsTwilioPhoneNumbersRetrieve>>;
|
|
743
|
+
|
|
744
|
+
const result: EnvironmentsIntegrationsTwilioPhoneNumbersRetrieveOutput = await posthog.environmentsIntegrationsTwilioPhoneNumbersRetrieve();
|
|
745
|
+
|
|
746
|
+
// Result shape (from schema): unknown
|
|
747
|
+
```
|
|
748
|
+
|
|
749
|
+
### `posthog.environmentsIntegrationsAuthorizeRetrieve`
|
|
750
|
+
|
|
751
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/authorize/`
|
|
752
|
+
- **OpenAPI operationId**: `environments_integrations_authorize_retrieve`
|
|
753
|
+
- **Path params**: None
|
|
754
|
+
- **Query params**: None
|
|
755
|
+
- **Response codes**: `200`
|
|
756
|
+
- **Transport options**: None
|
|
757
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
758
|
+
|
|
759
|
+
**Inputs**
|
|
760
|
+
|
|
761
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
762
|
+
- Client transport options: None
|
|
763
|
+
|
|
764
|
+
**Outputs**
|
|
765
|
+
|
|
766
|
+
- Client return type: `unknown`
|
|
767
|
+
- OpenAPI response codes: `200`
|
|
768
|
+
|
|
769
|
+
```ts
|
|
770
|
+
import posthog from "@utdk/posthog";
|
|
771
|
+
|
|
772
|
+
type EnvironmentsIntegrationsAuthorizeRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsAuthorizeRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
773
|
+
type EnvironmentsIntegrationsAuthorizeRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsAuthorizeRetrieve>>;
|
|
774
|
+
|
|
775
|
+
const result: EnvironmentsIntegrationsAuthorizeRetrieveOutput = await posthog.environmentsIntegrationsAuthorizeRetrieve();
|
|
776
|
+
|
|
777
|
+
// Result shape (from schema): unknown
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
### `posthog.environmentsIntegrationsDomainConnectApplyUrlCreate`
|
|
781
|
+
|
|
782
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/domain-connect/apply-url/`
|
|
783
|
+
- **What it does**: Unified endpoint for generating Domain Connect apply URLs.
|
|
784
|
+
|
|
785
|
+
Accepts a context ("email" or "proxy") and the relevant resource ID.
|
|
786
|
+
The backend resolves the domain, template variables, and service ID
|
|
787
|
+
based on context, then builds the signed apply URL.
|
|
788
|
+
- **OpenAPI operationId**: `environments_integrations_domain_connect_apply_url_create`
|
|
789
|
+
- **Path params**: None
|
|
790
|
+
- **Query params**: None
|
|
791
|
+
- **Response codes**: `200`
|
|
792
|
+
- **Transport options**: None
|
|
793
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
794
|
+
|
|
795
|
+
**Inputs**
|
|
796
|
+
|
|
797
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
798
|
+
- Client transport options: None
|
|
799
|
+
|
|
800
|
+
**Outputs**
|
|
801
|
+
|
|
802
|
+
- Client return type: `unknown`
|
|
803
|
+
- OpenAPI response codes: `200`
|
|
804
|
+
|
|
805
|
+
```ts
|
|
806
|
+
import posthog from "@utdk/posthog";
|
|
807
|
+
|
|
808
|
+
type EnvironmentsIntegrationsDomainConnectApplyUrlCreateInput = Parameters<typeof posthog.environmentsIntegrationsDomainConnectApplyUrlCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
809
|
+
type EnvironmentsIntegrationsDomainConnectApplyUrlCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsDomainConnectApplyUrlCreate>>;
|
|
810
|
+
|
|
811
|
+
const result: EnvironmentsIntegrationsDomainConnectApplyUrlCreateOutput = await posthog.environmentsIntegrationsDomainConnectApplyUrlCreate();
|
|
812
|
+
|
|
813
|
+
// Result shape (from schema): unknown
|
|
814
|
+
```
|
|
815
|
+
|
|
816
|
+
### `posthog.environmentsIntegrationsDomainConnectCheckRetrieve`
|
|
817
|
+
|
|
818
|
+
- **HTTP**: `GET /api/environments/{environment_id}/integrations/domain-connect/check/`
|
|
819
|
+
- **OpenAPI operationId**: `environments_integrations_domain_connect_check_retrieve`
|
|
820
|
+
- **Path params**: None
|
|
821
|
+
- **Query params**: None
|
|
822
|
+
- **Response codes**: `200`
|
|
823
|
+
- **Transport options**: None
|
|
824
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
825
|
+
|
|
826
|
+
**Inputs**
|
|
827
|
+
|
|
828
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
829
|
+
- Client transport options: None
|
|
830
|
+
|
|
831
|
+
**Outputs**
|
|
832
|
+
|
|
833
|
+
- Client return type: `unknown`
|
|
834
|
+
- OpenAPI response codes: `200`
|
|
835
|
+
|
|
836
|
+
```ts
|
|
837
|
+
import posthog from "@utdk/posthog";
|
|
838
|
+
|
|
839
|
+
type EnvironmentsIntegrationsDomainConnectCheckRetrieveInput = Parameters<typeof posthog.environmentsIntegrationsDomainConnectCheckRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
840
|
+
type EnvironmentsIntegrationsDomainConnectCheckRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsDomainConnectCheckRetrieve>>;
|
|
841
|
+
|
|
842
|
+
const result: EnvironmentsIntegrationsDomainConnectCheckRetrieveOutput = await posthog.environmentsIntegrationsDomainConnectCheckRetrieve();
|
|
843
|
+
|
|
844
|
+
// Result shape (from schema): unknown
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
### `posthog.environmentsIntegrationsGithubLinkExistingCreate`
|
|
848
|
+
|
|
849
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/github/link_existing/`
|
|
850
|
+
- **What it does**: Reuse a GitHub installation already linked to a sibling team in the same organization.
|
|
851
|
+
- **OpenAPI operationId**: `environments_integrations_github_link_existing_create`
|
|
852
|
+
- **Path params**: None
|
|
853
|
+
- **Query params**: None
|
|
854
|
+
- **Response codes**: `200`
|
|
855
|
+
- **Transport options**: None
|
|
856
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
857
|
+
|
|
858
|
+
**Inputs**
|
|
859
|
+
|
|
860
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
861
|
+
- Client transport options: None
|
|
862
|
+
|
|
863
|
+
**Outputs**
|
|
864
|
+
|
|
865
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
866
|
+
- OpenAPI response codes: `200`
|
|
867
|
+
|
|
868
|
+
```ts
|
|
869
|
+
import posthog from "@utdk/posthog";
|
|
870
|
+
|
|
871
|
+
type EnvironmentsIntegrationsGithubLinkExistingCreateInput = Parameters<typeof posthog.environmentsIntegrationsGithubLinkExistingCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
872
|
+
type EnvironmentsIntegrationsGithubLinkExistingCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubLinkExistingCreate>>;
|
|
873
|
+
|
|
874
|
+
const result: EnvironmentsIntegrationsGithubLinkExistingCreateOutput = await posthog.environmentsIntegrationsGithubLinkExistingCreate();
|
|
875
|
+
|
|
876
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
877
|
+
```
|
|
878
|
+
|
|
879
|
+
### `posthog.environmentsIntegrationsGithubOauthAuthorizeCreate`
|
|
880
|
+
|
|
881
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/github/oauth_authorize/`
|
|
882
|
+
- **What it does**: Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one.
|
|
883
|
+
- **OpenAPI operationId**: `environments_integrations_github_oauth_authorize_create`
|
|
884
|
+
- **Path params**: None
|
|
885
|
+
- **Query params**: None
|
|
886
|
+
- **Response codes**: `200`
|
|
887
|
+
- **Transport options**: None
|
|
888
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
889
|
+
|
|
890
|
+
**Inputs**
|
|
891
|
+
|
|
892
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
893
|
+
- Client transport options: None
|
|
894
|
+
|
|
895
|
+
**Outputs**
|
|
896
|
+
|
|
897
|
+
- Client return type: `{ oauth_url: string }`
|
|
898
|
+
- OpenAPI response codes: `200`
|
|
899
|
+
|
|
900
|
+
```ts
|
|
901
|
+
import posthog from "@utdk/posthog";
|
|
902
|
+
|
|
903
|
+
type EnvironmentsIntegrationsGithubOauthAuthorizeCreateInput = Parameters<typeof posthog.environmentsIntegrationsGithubOauthAuthorizeCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
904
|
+
type EnvironmentsIntegrationsGithubOauthAuthorizeCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubOauthAuthorizeCreate>>;
|
|
905
|
+
|
|
906
|
+
const result: EnvironmentsIntegrationsGithubOauthAuthorizeCreateOutput = await posthog.environmentsIntegrationsGithubOauthAuthorizeCreate();
|
|
907
|
+
|
|
908
|
+
// Result shape (from schema): { oauth_url: string }
|
|
909
|
+
```
|
|
910
|
+
|
|
911
|
+
### `posthog.environmentsIntegrationsGithubPrepareCallbackCreate`
|
|
912
|
+
|
|
913
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/github/prepare_callback/`
|
|
914
|
+
- **What it does**: Seed GitHub setup callback state without redirecting to GitHub.
|
|
915
|
+
|
|
916
|
+
Used when the user opens an existing installation's settings on github.com (e.g. PostHog
|
|
917
|
+
Code "Update in GitHub") so the subsequent Setup URL redirect can be validated.
|
|
918
|
+
- **OpenAPI operationId**: `environments_integrations_github_prepare_callback_create`
|
|
919
|
+
- **Path params**: None
|
|
920
|
+
- **Query params**: None
|
|
921
|
+
- **Response codes**: `204`
|
|
922
|
+
- **Transport options**: None
|
|
923
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
924
|
+
|
|
925
|
+
**Inputs**
|
|
926
|
+
|
|
927
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
928
|
+
- Client transport options: None
|
|
929
|
+
|
|
930
|
+
**Outputs**
|
|
931
|
+
|
|
932
|
+
- Client return type: `unknown`
|
|
933
|
+
- OpenAPI response codes: `204`
|
|
934
|
+
|
|
935
|
+
```ts
|
|
936
|
+
import posthog from "@utdk/posthog";
|
|
937
|
+
|
|
938
|
+
type EnvironmentsIntegrationsGithubPrepareCallbackCreateInput = Parameters<typeof posthog.environmentsIntegrationsGithubPrepareCallbackCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
939
|
+
type EnvironmentsIntegrationsGithubPrepareCallbackCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsGithubPrepareCallbackCreate>>;
|
|
940
|
+
|
|
941
|
+
const result: EnvironmentsIntegrationsGithubPrepareCallbackCreateOutput = await posthog.environmentsIntegrationsGithubPrepareCallbackCreate();
|
|
942
|
+
|
|
943
|
+
// Result shape (from schema): unknown
|
|
944
|
+
```
|
|
945
|
+
|
|
946
|
+
### `posthog.environmentsIntegrationsRequestAccessCreate`
|
|
947
|
+
|
|
948
|
+
- **HTTP**: `POST /api/environments/{environment_id}/integrations/request_access/`
|
|
949
|
+
- **What it does**: Notify project admins that a member is requesting an integration be connected.
|
|
950
|
+
- **OpenAPI operationId**: `environments_integrations_request_access_create`
|
|
951
|
+
- **Path params**: None
|
|
952
|
+
- **Query params**: None
|
|
953
|
+
- **Response codes**: `200`
|
|
954
|
+
- **Transport options**: None
|
|
955
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
956
|
+
|
|
957
|
+
**Inputs**
|
|
958
|
+
|
|
959
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
960
|
+
- Client transport options: None
|
|
961
|
+
|
|
962
|
+
**Outputs**
|
|
963
|
+
|
|
964
|
+
- Client return type: `{ success: boolean }`
|
|
965
|
+
- OpenAPI response codes: `200`
|
|
966
|
+
|
|
967
|
+
```ts
|
|
968
|
+
import posthog from "@utdk/posthog";
|
|
969
|
+
|
|
970
|
+
type EnvironmentsIntegrationsRequestAccessCreateInput = Parameters<typeof posthog.environmentsIntegrationsRequestAccessCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
971
|
+
type EnvironmentsIntegrationsRequestAccessCreateOutput = Awaited<ReturnType<typeof posthog.environmentsIntegrationsRequestAccessCreate>>;
|
|
972
|
+
|
|
973
|
+
const result: EnvironmentsIntegrationsRequestAccessCreateOutput = await posthog.environmentsIntegrationsRequestAccessCreate();
|
|
974
|
+
|
|
975
|
+
// Result shape (from schema): { success: boolean }
|
|
976
|
+
```
|
|
977
|
+
|
|
978
|
+
### `posthog.integrationsList`
|
|
979
|
+
|
|
980
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/`
|
|
981
|
+
- **OpenAPI operationId**: `integrations_list`
|
|
982
|
+
- **Path params**: None
|
|
983
|
+
- **Query params**: `kind`, `limit`, `offset`
|
|
984
|
+
- **Response codes**: `200`
|
|
985
|
+
- **Transport options**: None
|
|
986
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
987
|
+
|
|
988
|
+
**Inputs**
|
|
989
|
+
|
|
990
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
991
|
+
- Client transport options: None
|
|
992
|
+
|
|
993
|
+
**Outputs**
|
|
994
|
+
|
|
995
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customeri...`
|
|
996
|
+
- OpenAPI response codes: `200`
|
|
997
|
+
|
|
998
|
+
```ts
|
|
999
|
+
import posthog from "@utdk/posthog";
|
|
1000
|
+
|
|
1001
|
+
type IntegrationsListInput = Parameters<typeof posthog.integrationsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1002
|
+
type IntegrationsListOutput = Awaited<ReturnType<typeof posthog.integrationsList>>;
|
|
1003
|
+
|
|
1004
|
+
const result: IntegrationsListOutput = await posthog.integrationsList();
|
|
1005
|
+
|
|
1006
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customeri...
|
|
1007
|
+
```
|
|
1008
|
+
|
|
1009
|
+
### `posthog.integrationsCreate`
|
|
1010
|
+
|
|
1011
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/`
|
|
1012
|
+
- **OpenAPI operationId**: `integrations_create`
|
|
1013
|
+
- **Path params**: None
|
|
1014
|
+
- **Query params**: None
|
|
1015
|
+
- **Response codes**: `201`
|
|
1016
|
+
- **Transport options**: None
|
|
1017
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1018
|
+
|
|
1019
|
+
**Inputs**
|
|
1020
|
+
|
|
1021
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1022
|
+
- Client transport options: None
|
|
1023
|
+
|
|
1024
|
+
**Outputs**
|
|
1025
|
+
|
|
1026
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
1027
|
+
- OpenAPI response codes: `201`
|
|
1028
|
+
|
|
1029
|
+
```ts
|
|
1030
|
+
import posthog from "@utdk/posthog";
|
|
1031
|
+
|
|
1032
|
+
type IntegrationsCreateInput = Parameters<typeof posthog.integrationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1033
|
+
type IntegrationsCreateOutput = Awaited<ReturnType<typeof posthog.integrationsCreate>>;
|
|
1034
|
+
|
|
1035
|
+
const result: IntegrationsCreateOutput = await posthog.integrationsCreate();
|
|
1036
|
+
|
|
1037
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
1038
|
+
```
|
|
1039
|
+
|
|
1040
|
+
### `posthog.integrationsDestroy`
|
|
1041
|
+
|
|
1042
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/integrations/{id}/`
|
|
1043
|
+
- **OpenAPI operationId**: `integrations_destroy`
|
|
1044
|
+
- **Path params**: `id`
|
|
1045
|
+
- **Query params**: None
|
|
1046
|
+
- **Response codes**: `204`
|
|
1047
|
+
- **Transport options**: None
|
|
1048
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1049
|
+
|
|
1050
|
+
**Inputs**
|
|
1051
|
+
|
|
1052
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1053
|
+
- Client transport options: None
|
|
1054
|
+
|
|
1055
|
+
**Outputs**
|
|
1056
|
+
|
|
1057
|
+
- Client return type: `unknown`
|
|
1058
|
+
- OpenAPI response codes: `204`
|
|
1059
|
+
|
|
1060
|
+
```ts
|
|
1061
|
+
import posthog from "@utdk/posthog";
|
|
1062
|
+
|
|
1063
|
+
type IntegrationsDestroyInput = Parameters<typeof posthog.integrationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1064
|
+
type IntegrationsDestroyOutput = Awaited<ReturnType<typeof posthog.integrationsDestroy>>;
|
|
1065
|
+
|
|
1066
|
+
const result: IntegrationsDestroyOutput = await posthog.integrationsDestroy();
|
|
1067
|
+
|
|
1068
|
+
// Result shape (from schema): unknown
|
|
1069
|
+
```
|
|
1070
|
+
|
|
1071
|
+
### `posthog.integrationsRetrieve`
|
|
1072
|
+
|
|
1073
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/`
|
|
1074
|
+
- **OpenAPI operationId**: `integrations_retrieve`
|
|
1075
|
+
- **Path params**: `id`
|
|
1076
|
+
- **Query params**: None
|
|
1077
|
+
- **Response codes**: `200`
|
|
1078
|
+
- **Transport options**: None
|
|
1079
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1080
|
+
|
|
1081
|
+
**Inputs**
|
|
1082
|
+
|
|
1083
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1084
|
+
- Client transport options: None
|
|
1085
|
+
|
|
1086
|
+
**Outputs**
|
|
1087
|
+
|
|
1088
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
1089
|
+
- OpenAPI response codes: `200`
|
|
1090
|
+
|
|
1091
|
+
```ts
|
|
1092
|
+
import posthog from "@utdk/posthog";
|
|
1093
|
+
|
|
1094
|
+
type IntegrationsRetrieveInput = Parameters<typeof posthog.integrationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1095
|
+
type IntegrationsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsRetrieve>>;
|
|
1096
|
+
|
|
1097
|
+
const result: IntegrationsRetrieveOutput = await posthog.integrationsRetrieve();
|
|
1098
|
+
|
|
1099
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
1100
|
+
```
|
|
1101
|
+
|
|
1102
|
+
### `posthog.integrationsAnthropicManagedAgentEnvsRetrieve`
|
|
1103
|
+
|
|
1104
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/anthropic_managed_agent_environments/`
|
|
1105
|
+
- **OpenAPI operationId**: `integrations_anthropic_managed_agent_envs_retrieve`
|
|
1106
|
+
- **Path params**: `id`
|
|
1107
|
+
- **Query params**: None
|
|
1108
|
+
- **Response codes**: `200`
|
|
1109
|
+
- **Transport options**: None
|
|
1110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1111
|
+
|
|
1112
|
+
**Inputs**
|
|
1113
|
+
|
|
1114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1115
|
+
- Client transport options: None
|
|
1116
|
+
|
|
1117
|
+
**Outputs**
|
|
1118
|
+
|
|
1119
|
+
- Client return type: `unknown`
|
|
1120
|
+
- OpenAPI response codes: `200`
|
|
1121
|
+
|
|
1122
|
+
```ts
|
|
1123
|
+
import posthog from "@utdk/posthog";
|
|
1124
|
+
|
|
1125
|
+
type IntegrationsAnthropicManagedAgentEnvsRetrieveInput = Parameters<typeof posthog.integrationsAnthropicManagedAgentEnvsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1126
|
+
type IntegrationsAnthropicManagedAgentEnvsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsAnthropicManagedAgentEnvsRetrieve>>;
|
|
1127
|
+
|
|
1128
|
+
const result: IntegrationsAnthropicManagedAgentEnvsRetrieveOutput = await posthog.integrationsAnthropicManagedAgentEnvsRetrieve();
|
|
1129
|
+
|
|
1130
|
+
// Result shape (from schema): unknown
|
|
1131
|
+
```
|
|
1132
|
+
|
|
1133
|
+
### `posthog.integrationsAnthropicManagedAgentVaultsRetrieve`
|
|
1134
|
+
|
|
1135
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/anthropic_managed_agent_vaults/`
|
|
1136
|
+
- **OpenAPI operationId**: `integrations_anthropic_managed_agent_vaults_retrieve`
|
|
1137
|
+
- **Path params**: `id`
|
|
1138
|
+
- **Query params**: None
|
|
1139
|
+
- **Response codes**: `200`
|
|
1140
|
+
- **Transport options**: None
|
|
1141
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1142
|
+
|
|
1143
|
+
**Inputs**
|
|
1144
|
+
|
|
1145
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1146
|
+
- Client transport options: None
|
|
1147
|
+
|
|
1148
|
+
**Outputs**
|
|
1149
|
+
|
|
1150
|
+
- Client return type: `unknown`
|
|
1151
|
+
- OpenAPI response codes: `200`
|
|
1152
|
+
|
|
1153
|
+
```ts
|
|
1154
|
+
import posthog from "@utdk/posthog";
|
|
1155
|
+
|
|
1156
|
+
type IntegrationsAnthropicManagedAgentVaultsRetrieveInput = Parameters<typeof posthog.integrationsAnthropicManagedAgentVaultsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1157
|
+
type IntegrationsAnthropicManagedAgentVaultsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsAnthropicManagedAgentVaultsRetrieve>>;
|
|
1158
|
+
|
|
1159
|
+
const result: IntegrationsAnthropicManagedAgentVaultsRetrieveOutput = await posthog.integrationsAnthropicManagedAgentVaultsRetrieve();
|
|
1160
|
+
|
|
1161
|
+
// Result shape (from schema): unknown
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
### `posthog.integrationsAnthropicManagedAgentsRetrieve`
|
|
1165
|
+
|
|
1166
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/anthropic_managed_agents/`
|
|
1167
|
+
- **OpenAPI operationId**: `integrations_anthropic_managed_agents_retrieve`
|
|
1168
|
+
- **Path params**: `id`
|
|
1169
|
+
- **Query params**: None
|
|
1170
|
+
- **Response codes**: `200`
|
|
1171
|
+
- **Transport options**: None
|
|
1172
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1173
|
+
|
|
1174
|
+
**Inputs**
|
|
1175
|
+
|
|
1176
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1177
|
+
- Client transport options: None
|
|
1178
|
+
|
|
1179
|
+
**Outputs**
|
|
1180
|
+
|
|
1181
|
+
- Client return type: `unknown`
|
|
1182
|
+
- OpenAPI response codes: `200`
|
|
1183
|
+
|
|
1184
|
+
```ts
|
|
1185
|
+
import posthog from "@utdk/posthog";
|
|
1186
|
+
|
|
1187
|
+
type IntegrationsAnthropicManagedAgentsRetrieveInput = Parameters<typeof posthog.integrationsAnthropicManagedAgentsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1188
|
+
type IntegrationsAnthropicManagedAgentsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsAnthropicManagedAgentsRetrieve>>;
|
|
1189
|
+
|
|
1190
|
+
const result: IntegrationsAnthropicManagedAgentsRetrieveOutput = await posthog.integrationsAnthropicManagedAgentsRetrieve();
|
|
1191
|
+
|
|
1192
|
+
// Result shape (from schema): unknown
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
### `posthog.integrationsChannelsRetrieve`
|
|
1196
|
+
|
|
1197
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/channels/`
|
|
1198
|
+
- **OpenAPI operationId**: `integrations_channels_retrieve`
|
|
1199
|
+
- **Path params**: `id`
|
|
1200
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
1201
|
+
- **Response codes**: `200`
|
|
1202
|
+
- **Transport options**: None
|
|
1203
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1204
|
+
|
|
1205
|
+
**Inputs**
|
|
1206
|
+
|
|
1207
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1208
|
+
- Client transport options: None
|
|
1209
|
+
|
|
1210
|
+
**Outputs**
|
|
1211
|
+
|
|
1212
|
+
- Client return type: `{ channels: ({ id: string; name: string; is_private: boolean; is_member: boolean; is_ext_shared: boolean; is_private_without_access: boolean })[]; lastRefreshedAt?: string | null; has_more?: boolean }`
|
|
1213
|
+
- OpenAPI response codes: `200`
|
|
1214
|
+
|
|
1215
|
+
```ts
|
|
1216
|
+
import posthog from "@utdk/posthog";
|
|
1217
|
+
|
|
1218
|
+
type IntegrationsChannelsRetrieveInput = Parameters<typeof posthog.integrationsChannelsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1219
|
+
type IntegrationsChannelsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsChannelsRetrieve>>;
|
|
1220
|
+
|
|
1221
|
+
const result: IntegrationsChannelsRetrieveOutput = await posthog.integrationsChannelsRetrieve();
|
|
1222
|
+
|
|
1223
|
+
// Result shape (from schema): { channels: ({ id: string; name: string; is_private: boolean; is_member: boolean; is_ext_shared: boolean; is_private_without_access: boolean })[]; lastRefreshedAt?: string | null; has_more?: boolean }
|
|
1224
|
+
```
|
|
1225
|
+
|
|
1226
|
+
### `posthog.integrationsClickupListsRetrieve`
|
|
1227
|
+
|
|
1228
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/clickup_lists/`
|
|
1229
|
+
- **OpenAPI operationId**: `integrations_clickup_lists_retrieve`
|
|
1230
|
+
- **Path params**: `id`
|
|
1231
|
+
- **Query params**: None
|
|
1232
|
+
- **Response codes**: `200`
|
|
1233
|
+
- **Transport options**: None
|
|
1234
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1235
|
+
|
|
1236
|
+
**Inputs**
|
|
1237
|
+
|
|
1238
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1239
|
+
- Client transport options: None
|
|
1240
|
+
|
|
1241
|
+
**Outputs**
|
|
1242
|
+
|
|
1243
|
+
- Client return type: `unknown`
|
|
1244
|
+
- OpenAPI response codes: `200`
|
|
1245
|
+
|
|
1246
|
+
```ts
|
|
1247
|
+
import posthog from "@utdk/posthog";
|
|
1248
|
+
|
|
1249
|
+
type IntegrationsClickupListsRetrieveInput = Parameters<typeof posthog.integrationsClickupListsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1250
|
+
type IntegrationsClickupListsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsClickupListsRetrieve>>;
|
|
1251
|
+
|
|
1252
|
+
const result: IntegrationsClickupListsRetrieveOutput = await posthog.integrationsClickupListsRetrieve();
|
|
1253
|
+
|
|
1254
|
+
// Result shape (from schema): unknown
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
### `posthog.integrationsClickupSpacesRetrieve`
|
|
1258
|
+
|
|
1259
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/clickup_spaces/`
|
|
1260
|
+
- **OpenAPI operationId**: `integrations_clickup_spaces_retrieve`
|
|
1261
|
+
- **Path params**: `id`
|
|
1262
|
+
- **Query params**: None
|
|
1263
|
+
- **Response codes**: `200`
|
|
1264
|
+
- **Transport options**: None
|
|
1265
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1266
|
+
|
|
1267
|
+
**Inputs**
|
|
1268
|
+
|
|
1269
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1270
|
+
- Client transport options: None
|
|
1271
|
+
|
|
1272
|
+
**Outputs**
|
|
1273
|
+
|
|
1274
|
+
- Client return type: `unknown`
|
|
1275
|
+
- OpenAPI response codes: `200`
|
|
1276
|
+
|
|
1277
|
+
```ts
|
|
1278
|
+
import posthog from "@utdk/posthog";
|
|
1279
|
+
|
|
1280
|
+
type IntegrationsClickupSpacesRetrieveInput = Parameters<typeof posthog.integrationsClickupSpacesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1281
|
+
type IntegrationsClickupSpacesRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsClickupSpacesRetrieve>>;
|
|
1282
|
+
|
|
1283
|
+
const result: IntegrationsClickupSpacesRetrieveOutput = await posthog.integrationsClickupSpacesRetrieve();
|
|
1284
|
+
|
|
1285
|
+
// Result shape (from schema): unknown
|
|
1286
|
+
```
|
|
1287
|
+
|
|
1288
|
+
### `posthog.integrationsClickupWorkspacesRetrieve`
|
|
1289
|
+
|
|
1290
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/clickup_workspaces/`
|
|
1291
|
+
- **OpenAPI operationId**: `integrations_clickup_workspaces_retrieve`
|
|
1292
|
+
- **Path params**: `id`
|
|
1293
|
+
- **Query params**: None
|
|
1294
|
+
- **Response codes**: `200`
|
|
1295
|
+
- **Transport options**: None
|
|
1296
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1297
|
+
|
|
1298
|
+
**Inputs**
|
|
1299
|
+
|
|
1300
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1301
|
+
- Client transport options: None
|
|
1302
|
+
|
|
1303
|
+
**Outputs**
|
|
1304
|
+
|
|
1305
|
+
- Client return type: `unknown`
|
|
1306
|
+
- OpenAPI response codes: `200`
|
|
1307
|
+
|
|
1308
|
+
```ts
|
|
1309
|
+
import posthog from "@utdk/posthog";
|
|
1310
|
+
|
|
1311
|
+
type IntegrationsClickupWorkspacesRetrieveInput = Parameters<typeof posthog.integrationsClickupWorkspacesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1312
|
+
type IntegrationsClickupWorkspacesRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsClickupWorkspacesRetrieve>>;
|
|
1313
|
+
|
|
1314
|
+
const result: IntegrationsClickupWorkspacesRetrieveOutput = await posthog.integrationsClickupWorkspacesRetrieve();
|
|
1315
|
+
|
|
1316
|
+
// Result shape (from schema): unknown
|
|
1317
|
+
```
|
|
1318
|
+
|
|
1319
|
+
### `posthog.integrationsEmailPartialUpdate`
|
|
1320
|
+
|
|
1321
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/integrations/{id}/email/`
|
|
1322
|
+
- **OpenAPI operationId**: `integrations_email_partial_update`
|
|
1323
|
+
- **Path params**: `id`
|
|
1324
|
+
- **Query params**: None
|
|
1325
|
+
- **Response codes**: `200`
|
|
1326
|
+
- **Transport options**: None
|
|
1327
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1328
|
+
|
|
1329
|
+
**Inputs**
|
|
1330
|
+
|
|
1331
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1332
|
+
- Client transport options: None
|
|
1333
|
+
|
|
1334
|
+
**Outputs**
|
|
1335
|
+
|
|
1336
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
1337
|
+
- OpenAPI response codes: `200`
|
|
1338
|
+
|
|
1339
|
+
```ts
|
|
1340
|
+
import posthog from "@utdk/posthog";
|
|
1341
|
+
|
|
1342
|
+
type IntegrationsEmailPartialUpdateInput = Parameters<typeof posthog.integrationsEmailPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1343
|
+
type IntegrationsEmailPartialUpdateOutput = Awaited<ReturnType<typeof posthog.integrationsEmailPartialUpdate>>;
|
|
1344
|
+
|
|
1345
|
+
const result: IntegrationsEmailPartialUpdateOutput = await posthog.integrationsEmailPartialUpdate();
|
|
1346
|
+
|
|
1347
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
1348
|
+
```
|
|
1349
|
+
|
|
1350
|
+
### `posthog.integrationsEmailVerifyCreate`
|
|
1351
|
+
|
|
1352
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/{id}/email/verify/`
|
|
1353
|
+
- **OpenAPI operationId**: `integrations_email_verify_create`
|
|
1354
|
+
- **Path params**: `id`
|
|
1355
|
+
- **Query params**: None
|
|
1356
|
+
- **Response codes**: `200`
|
|
1357
|
+
- **Transport options**: None
|
|
1358
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1359
|
+
|
|
1360
|
+
**Inputs**
|
|
1361
|
+
|
|
1362
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1363
|
+
- Client transport options: None
|
|
1364
|
+
|
|
1365
|
+
**Outputs**
|
|
1366
|
+
|
|
1367
|
+
- Client return type: `unknown`
|
|
1368
|
+
- OpenAPI response codes: `200`
|
|
1369
|
+
|
|
1370
|
+
```ts
|
|
1371
|
+
import posthog from "@utdk/posthog";
|
|
1372
|
+
|
|
1373
|
+
type IntegrationsEmailVerifyCreateInput = Parameters<typeof posthog.integrationsEmailVerifyCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1374
|
+
type IntegrationsEmailVerifyCreateOutput = Awaited<ReturnType<typeof posthog.integrationsEmailVerifyCreate>>;
|
|
1375
|
+
|
|
1376
|
+
const result: IntegrationsEmailVerifyCreateOutput = await posthog.integrationsEmailVerifyCreate();
|
|
1377
|
+
|
|
1378
|
+
// Result shape (from schema): unknown
|
|
1379
|
+
```
|
|
1380
|
+
|
|
1381
|
+
### `posthog.integrationsGithubBranchesRetrieve`
|
|
1382
|
+
|
|
1383
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/github_branches/`
|
|
1384
|
+
- **OpenAPI operationId**: `integrations_github_branches_retrieve`
|
|
1385
|
+
- **Path params**: `id`
|
|
1386
|
+
- **Query params**: `limit`, `offset`, `repo`, `search`
|
|
1387
|
+
- **Response codes**: `200`
|
|
1388
|
+
- **Transport options**: None
|
|
1389
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1390
|
+
|
|
1391
|
+
**Inputs**
|
|
1392
|
+
|
|
1393
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1394
|
+
- Client transport options: None
|
|
1395
|
+
|
|
1396
|
+
**Outputs**
|
|
1397
|
+
|
|
1398
|
+
- Client return type: `{ branches: (string)[]; default_branch?: string | null; has_more: boolean }`
|
|
1399
|
+
- OpenAPI response codes: `200`
|
|
1400
|
+
|
|
1401
|
+
```ts
|
|
1402
|
+
import posthog from "@utdk/posthog";
|
|
1403
|
+
|
|
1404
|
+
type IntegrationsGithubBranchesRetrieveInput = Parameters<typeof posthog.integrationsGithubBranchesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1405
|
+
type IntegrationsGithubBranchesRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsGithubBranchesRetrieve>>;
|
|
1406
|
+
|
|
1407
|
+
const result: IntegrationsGithubBranchesRetrieveOutput = await posthog.integrationsGithubBranchesRetrieve();
|
|
1408
|
+
|
|
1409
|
+
// Result shape (from schema): { branches: (string)[]; default_branch?: string | null; has_more: boolean }
|
|
1410
|
+
```
|
|
1411
|
+
|
|
1412
|
+
### `posthog.integrationsGithubReposRetrieve`
|
|
1413
|
+
|
|
1414
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/github_repos/`
|
|
1415
|
+
- **OpenAPI operationId**: `integrations_github_repos_retrieve`
|
|
1416
|
+
- **Path params**: `id`
|
|
1417
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
1418
|
+
- **Response codes**: `200`
|
|
1419
|
+
- **Transport options**: None
|
|
1420
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1421
|
+
|
|
1422
|
+
**Inputs**
|
|
1423
|
+
|
|
1424
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1425
|
+
- Client transport options: None
|
|
1426
|
+
|
|
1427
|
+
**Outputs**
|
|
1428
|
+
|
|
1429
|
+
- Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }`
|
|
1430
|
+
- OpenAPI response codes: `200`
|
|
1431
|
+
|
|
1432
|
+
```ts
|
|
1433
|
+
import posthog from "@utdk/posthog";
|
|
1434
|
+
|
|
1435
|
+
type IntegrationsGithubReposRetrieveInput = Parameters<typeof posthog.integrationsGithubReposRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1436
|
+
type IntegrationsGithubReposRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsGithubReposRetrieve>>;
|
|
1437
|
+
|
|
1438
|
+
const result: IntegrationsGithubReposRetrieveOutput = await posthog.integrationsGithubReposRetrieve();
|
|
1439
|
+
|
|
1440
|
+
// Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[]; has_more: boolean }
|
|
1441
|
+
```
|
|
1442
|
+
|
|
1443
|
+
### `posthog.integrationsGithubReposRefreshCreate`
|
|
1444
|
+
|
|
1445
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/{id}/github_repos/refresh/`
|
|
1446
|
+
- **OpenAPI operationId**: `integrations_github_repos_refresh_create`
|
|
1447
|
+
- **Path params**: `id`
|
|
1448
|
+
- **Query params**: None
|
|
1449
|
+
- **Response codes**: `200`
|
|
1450
|
+
- **Transport options**: None
|
|
1451
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1452
|
+
|
|
1453
|
+
**Inputs**
|
|
1454
|
+
|
|
1455
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1456
|
+
- Client transport options: None
|
|
1457
|
+
|
|
1458
|
+
**Outputs**
|
|
1459
|
+
|
|
1460
|
+
- Client return type: `{ repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }`
|
|
1461
|
+
- OpenAPI response codes: `200`
|
|
1462
|
+
|
|
1463
|
+
```ts
|
|
1464
|
+
import posthog from "@utdk/posthog";
|
|
1465
|
+
|
|
1466
|
+
type IntegrationsGithubReposRefreshCreateInput = Parameters<typeof posthog.integrationsGithubReposRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1467
|
+
type IntegrationsGithubReposRefreshCreateOutput = Awaited<ReturnType<typeof posthog.integrationsGithubReposRefreshCreate>>;
|
|
1468
|
+
|
|
1469
|
+
const result: IntegrationsGithubReposRefreshCreateOutput = await posthog.integrationsGithubReposRefreshCreate();
|
|
1470
|
+
|
|
1471
|
+
// Result shape (from schema): { repositories: ({ id: number; name: string; full_name: string; private?: boolean; default_branch?: string; language?: string; pushed_at?: string; archived?: boolean; can_push?: boolean })[] }
|
|
1472
|
+
```
|
|
1473
|
+
|
|
1474
|
+
### `posthog.integrationsGithubTeamsRetrieve`
|
|
1475
|
+
|
|
1476
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/github_teams/`
|
|
1477
|
+
- **OpenAPI operationId**: `integrations_github_teams_retrieve`
|
|
1478
|
+
- **Path params**: `id`
|
|
1479
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
1480
|
+
- **Response codes**: `200`
|
|
1481
|
+
- **Transport options**: None
|
|
1482
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1483
|
+
|
|
1484
|
+
**Inputs**
|
|
1485
|
+
|
|
1486
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1487
|
+
- Client transport options: None
|
|
1488
|
+
|
|
1489
|
+
**Outputs**
|
|
1490
|
+
|
|
1491
|
+
- Client return type: `{ teams: ({ id: number; slug: string; name: string })[]; has_more: boolean }`
|
|
1492
|
+
- OpenAPI response codes: `200`
|
|
1493
|
+
|
|
1494
|
+
```ts
|
|
1495
|
+
import posthog from "@utdk/posthog";
|
|
1496
|
+
|
|
1497
|
+
type IntegrationsGithubTeamsRetrieveInput = Parameters<typeof posthog.integrationsGithubTeamsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1498
|
+
type IntegrationsGithubTeamsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsGithubTeamsRetrieve>>;
|
|
1499
|
+
|
|
1500
|
+
const result: IntegrationsGithubTeamsRetrieveOutput = await posthog.integrationsGithubTeamsRetrieve();
|
|
1501
|
+
|
|
1502
|
+
// Result shape (from schema): { teams: ({ id: number; slug: string; name: string })[]; has_more: boolean }
|
|
1503
|
+
```
|
|
1504
|
+
|
|
1505
|
+
### `posthog.integrationsGoogleAccessibleAccountsRetrieve`
|
|
1506
|
+
|
|
1507
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/google_accessible_accounts/`
|
|
1508
|
+
- **OpenAPI operationId**: `integrations_google_accessible_accounts_retrieve`
|
|
1509
|
+
- **Path params**: `id`
|
|
1510
|
+
- **Query params**: None
|
|
1511
|
+
- **Response codes**: `200`
|
|
1512
|
+
- **Transport options**: None
|
|
1513
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1514
|
+
|
|
1515
|
+
**Inputs**
|
|
1516
|
+
|
|
1517
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1518
|
+
- Client transport options: None
|
|
1519
|
+
|
|
1520
|
+
**Outputs**
|
|
1521
|
+
|
|
1522
|
+
- Client return type: `unknown`
|
|
1523
|
+
- OpenAPI response codes: `200`
|
|
1524
|
+
|
|
1525
|
+
```ts
|
|
1526
|
+
import posthog from "@utdk/posthog";
|
|
1527
|
+
|
|
1528
|
+
type IntegrationsGoogleAccessibleAccountsRetrieveInput = Parameters<typeof posthog.integrationsGoogleAccessibleAccountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1529
|
+
type IntegrationsGoogleAccessibleAccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsGoogleAccessibleAccountsRetrieve>>;
|
|
1530
|
+
|
|
1531
|
+
const result: IntegrationsGoogleAccessibleAccountsRetrieveOutput = await posthog.integrationsGoogleAccessibleAccountsRetrieve();
|
|
1532
|
+
|
|
1533
|
+
// Result shape (from schema): unknown
|
|
1534
|
+
```
|
|
1535
|
+
|
|
1536
|
+
### `posthog.integrationsGoogleConversionActionsRetrieve`
|
|
1537
|
+
|
|
1538
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/google_conversion_actions/`
|
|
1539
|
+
- **OpenAPI operationId**: `integrations_google_conversion_actions_retrieve`
|
|
1540
|
+
- **Path params**: `id`
|
|
1541
|
+
- **Query params**: None
|
|
1542
|
+
- **Response codes**: `200`
|
|
1543
|
+
- **Transport options**: None
|
|
1544
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1545
|
+
|
|
1546
|
+
**Inputs**
|
|
1547
|
+
|
|
1548
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1549
|
+
- Client transport options: None
|
|
1550
|
+
|
|
1551
|
+
**Outputs**
|
|
1552
|
+
|
|
1553
|
+
- Client return type: `unknown`
|
|
1554
|
+
- OpenAPI response codes: `200`
|
|
1555
|
+
|
|
1556
|
+
```ts
|
|
1557
|
+
import posthog from "@utdk/posthog";
|
|
1558
|
+
|
|
1559
|
+
type IntegrationsGoogleConversionActionsRetrieveInput = Parameters<typeof posthog.integrationsGoogleConversionActionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1560
|
+
type IntegrationsGoogleConversionActionsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsGoogleConversionActionsRetrieve>>;
|
|
1561
|
+
|
|
1562
|
+
const result: IntegrationsGoogleConversionActionsRetrieveOutput = await posthog.integrationsGoogleConversionActionsRetrieve();
|
|
1563
|
+
|
|
1564
|
+
// Result shape (from schema): unknown
|
|
1565
|
+
```
|
|
1566
|
+
|
|
1567
|
+
### `posthog.integrationsJiraProjectsRetrieve`
|
|
1568
|
+
|
|
1569
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/jira_projects/`
|
|
1570
|
+
- **OpenAPI operationId**: `integrations_jira_projects_retrieve`
|
|
1571
|
+
- **Path params**: `id`
|
|
1572
|
+
- **Query params**: None
|
|
1573
|
+
- **Response codes**: `200`
|
|
1574
|
+
- **Transport options**: None
|
|
1575
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1576
|
+
|
|
1577
|
+
**Inputs**
|
|
1578
|
+
|
|
1579
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1580
|
+
- Client transport options: None
|
|
1581
|
+
|
|
1582
|
+
**Outputs**
|
|
1583
|
+
|
|
1584
|
+
- Client return type: `{ projects: ({ id: string; key: string; name: string })[] }`
|
|
1585
|
+
- OpenAPI response codes: `200`
|
|
1586
|
+
|
|
1587
|
+
```ts
|
|
1588
|
+
import posthog from "@utdk/posthog";
|
|
1589
|
+
|
|
1590
|
+
type IntegrationsJiraProjectsRetrieveInput = Parameters<typeof posthog.integrationsJiraProjectsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1591
|
+
type IntegrationsJiraProjectsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsJiraProjectsRetrieve>>;
|
|
1592
|
+
|
|
1593
|
+
const result: IntegrationsJiraProjectsRetrieveOutput = await posthog.integrationsJiraProjectsRetrieve();
|
|
1594
|
+
|
|
1595
|
+
// Result shape (from schema): { projects: ({ id: string; key: string; name: string })[] }
|
|
1596
|
+
```
|
|
1597
|
+
|
|
1598
|
+
### `posthog.integrationsLinearTeamsRetrieve`
|
|
1599
|
+
|
|
1600
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/linear_teams/`
|
|
1601
|
+
- **OpenAPI operationId**: `integrations_linear_teams_retrieve`
|
|
1602
|
+
- **Path params**: `id`
|
|
1603
|
+
- **Query params**: None
|
|
1604
|
+
- **Response codes**: `200`
|
|
1605
|
+
- **Transport options**: None
|
|
1606
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1607
|
+
|
|
1608
|
+
**Inputs**
|
|
1609
|
+
|
|
1610
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1611
|
+
- Client transport options: None
|
|
1612
|
+
|
|
1613
|
+
**Outputs**
|
|
1614
|
+
|
|
1615
|
+
- Client return type: `{ teams: ({ id: string; name: string })[] }`
|
|
1616
|
+
- OpenAPI response codes: `200`
|
|
1617
|
+
|
|
1618
|
+
```ts
|
|
1619
|
+
import posthog from "@utdk/posthog";
|
|
1620
|
+
|
|
1621
|
+
type IntegrationsLinearTeamsRetrieveInput = Parameters<typeof posthog.integrationsLinearTeamsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1622
|
+
type IntegrationsLinearTeamsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsLinearTeamsRetrieve>>;
|
|
1623
|
+
|
|
1624
|
+
const result: IntegrationsLinearTeamsRetrieveOutput = await posthog.integrationsLinearTeamsRetrieve();
|
|
1625
|
+
|
|
1626
|
+
// Result shape (from schema): { teams: ({ id: string; name: string })[] }
|
|
1627
|
+
```
|
|
1628
|
+
|
|
1629
|
+
### `posthog.integrationsLinkedinAdsAccountsRetrieve`
|
|
1630
|
+
|
|
1631
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/linkedin_ads_accounts/`
|
|
1632
|
+
- **OpenAPI operationId**: `integrations_linkedin_ads_accounts_retrieve`
|
|
1633
|
+
- **Path params**: `id`
|
|
1634
|
+
- **Query params**: None
|
|
1635
|
+
- **Response codes**: `200`
|
|
1636
|
+
- **Transport options**: None
|
|
1637
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1638
|
+
|
|
1639
|
+
**Inputs**
|
|
1640
|
+
|
|
1641
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1642
|
+
- Client transport options: None
|
|
1643
|
+
|
|
1644
|
+
**Outputs**
|
|
1645
|
+
|
|
1646
|
+
- Client return type: `unknown`
|
|
1647
|
+
- OpenAPI response codes: `200`
|
|
1648
|
+
|
|
1649
|
+
```ts
|
|
1650
|
+
import posthog from "@utdk/posthog";
|
|
1651
|
+
|
|
1652
|
+
type IntegrationsLinkedinAdsAccountsRetrieveInput = Parameters<typeof posthog.integrationsLinkedinAdsAccountsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1653
|
+
type IntegrationsLinkedinAdsAccountsRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsLinkedinAdsAccountsRetrieve>>;
|
|
1654
|
+
|
|
1655
|
+
const result: IntegrationsLinkedinAdsAccountsRetrieveOutput = await posthog.integrationsLinkedinAdsAccountsRetrieve();
|
|
1656
|
+
|
|
1657
|
+
// Result shape (from schema): unknown
|
|
1658
|
+
```
|
|
1659
|
+
|
|
1660
|
+
### `posthog.integrationsLinkedinAdsConversionRulesRetrieve`
|
|
1661
|
+
|
|
1662
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/linkedin_ads_conversion_rules/`
|
|
1663
|
+
- **OpenAPI operationId**: `integrations_linkedin_ads_conversion_rules_retrieve`
|
|
1664
|
+
- **Path params**: `id`
|
|
1665
|
+
- **Query params**: None
|
|
1666
|
+
- **Response codes**: `200`
|
|
1667
|
+
- **Transport options**: None
|
|
1668
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1669
|
+
|
|
1670
|
+
**Inputs**
|
|
1671
|
+
|
|
1672
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1673
|
+
- Client transport options: None
|
|
1674
|
+
|
|
1675
|
+
**Outputs**
|
|
1676
|
+
|
|
1677
|
+
- Client return type: `unknown`
|
|
1678
|
+
- OpenAPI response codes: `200`
|
|
1679
|
+
|
|
1680
|
+
```ts
|
|
1681
|
+
import posthog from "@utdk/posthog";
|
|
1682
|
+
|
|
1683
|
+
type IntegrationsLinkedinAdsConversionRulesRetrieveInput = Parameters<typeof posthog.integrationsLinkedinAdsConversionRulesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1684
|
+
type IntegrationsLinkedinAdsConversionRulesRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsLinkedinAdsConversionRulesRetrieve>>;
|
|
1685
|
+
|
|
1686
|
+
const result: IntegrationsLinkedinAdsConversionRulesRetrieveOutput = await posthog.integrationsLinkedinAdsConversionRulesRetrieve();
|
|
1687
|
+
|
|
1688
|
+
// Result shape (from schema): unknown
|
|
1689
|
+
```
|
|
1690
|
+
|
|
1691
|
+
### `posthog.integrationsTwilioPhoneNumbersRetrieve`
|
|
1692
|
+
|
|
1693
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/{id}/twilio_phone_numbers/`
|
|
1694
|
+
- **OpenAPI operationId**: `integrations_twilio_phone_numbers_retrieve`
|
|
1695
|
+
- **Path params**: `id`
|
|
1696
|
+
- **Query params**: None
|
|
1697
|
+
- **Response codes**: `200`
|
|
1698
|
+
- **Transport options**: None
|
|
1699
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1700
|
+
|
|
1701
|
+
**Inputs**
|
|
1702
|
+
|
|
1703
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1704
|
+
- Client transport options: None
|
|
1705
|
+
|
|
1706
|
+
**Outputs**
|
|
1707
|
+
|
|
1708
|
+
- Client return type: `unknown`
|
|
1709
|
+
- OpenAPI response codes: `200`
|
|
1710
|
+
|
|
1711
|
+
```ts
|
|
1712
|
+
import posthog from "@utdk/posthog";
|
|
1713
|
+
|
|
1714
|
+
type IntegrationsTwilioPhoneNumbersRetrieveInput = Parameters<typeof posthog.integrationsTwilioPhoneNumbersRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1715
|
+
type IntegrationsTwilioPhoneNumbersRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsTwilioPhoneNumbersRetrieve>>;
|
|
1716
|
+
|
|
1717
|
+
const result: IntegrationsTwilioPhoneNumbersRetrieveOutput = await posthog.integrationsTwilioPhoneNumbersRetrieve();
|
|
1718
|
+
|
|
1719
|
+
// Result shape (from schema): unknown
|
|
1720
|
+
```
|
|
1721
|
+
|
|
1722
|
+
### `posthog.integrationsAuthorizeRetrieve`
|
|
1723
|
+
|
|
1724
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/authorize/`
|
|
1725
|
+
- **OpenAPI operationId**: `integrations_authorize_retrieve`
|
|
1726
|
+
- **Path params**: None
|
|
1727
|
+
- **Query params**: None
|
|
1728
|
+
- **Response codes**: `200`
|
|
1729
|
+
- **Transport options**: None
|
|
1730
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1731
|
+
|
|
1732
|
+
**Inputs**
|
|
1733
|
+
|
|
1734
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1735
|
+
- Client transport options: None
|
|
1736
|
+
|
|
1737
|
+
**Outputs**
|
|
1738
|
+
|
|
1739
|
+
- Client return type: `unknown`
|
|
1740
|
+
- OpenAPI response codes: `200`
|
|
1741
|
+
|
|
1742
|
+
```ts
|
|
1743
|
+
import posthog from "@utdk/posthog";
|
|
1744
|
+
|
|
1745
|
+
type IntegrationsAuthorizeRetrieveInput = Parameters<typeof posthog.integrationsAuthorizeRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1746
|
+
type IntegrationsAuthorizeRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsAuthorizeRetrieve>>;
|
|
1747
|
+
|
|
1748
|
+
const result: IntegrationsAuthorizeRetrieveOutput = await posthog.integrationsAuthorizeRetrieve();
|
|
1749
|
+
|
|
1750
|
+
// Result shape (from schema): unknown
|
|
1751
|
+
```
|
|
1752
|
+
|
|
1753
|
+
### `posthog.integrationsDomainConnectApplyUrlCreate`
|
|
1754
|
+
|
|
1755
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/domain-connect/apply-url/`
|
|
1756
|
+
- **What it does**: Unified endpoint for generating Domain Connect apply URLs.
|
|
1757
|
+
|
|
1758
|
+
Accepts a context ("email" or "proxy") and the relevant resource ID.
|
|
1759
|
+
The backend resolves the domain, template variables, and service ID
|
|
1760
|
+
based on context, then builds the signed apply URL.
|
|
1761
|
+
- **OpenAPI operationId**: `integrations_domain_connect_apply_url_create`
|
|
1762
|
+
- **Path params**: None
|
|
1763
|
+
- **Query params**: None
|
|
1764
|
+
- **Response codes**: `200`
|
|
1765
|
+
- **Transport options**: None
|
|
1766
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1767
|
+
|
|
1768
|
+
**Inputs**
|
|
1769
|
+
|
|
1770
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1771
|
+
- Client transport options: None
|
|
1772
|
+
|
|
1773
|
+
**Outputs**
|
|
1774
|
+
|
|
1775
|
+
- Client return type: `unknown`
|
|
1776
|
+
- OpenAPI response codes: `200`
|
|
1777
|
+
|
|
1778
|
+
```ts
|
|
1779
|
+
import posthog from "@utdk/posthog";
|
|
1780
|
+
|
|
1781
|
+
type IntegrationsDomainConnectApplyUrlCreateInput = Parameters<typeof posthog.integrationsDomainConnectApplyUrlCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1782
|
+
type IntegrationsDomainConnectApplyUrlCreateOutput = Awaited<ReturnType<typeof posthog.integrationsDomainConnectApplyUrlCreate>>;
|
|
1783
|
+
|
|
1784
|
+
const result: IntegrationsDomainConnectApplyUrlCreateOutput = await posthog.integrationsDomainConnectApplyUrlCreate();
|
|
1785
|
+
|
|
1786
|
+
// Result shape (from schema): unknown
|
|
1787
|
+
```
|
|
1788
|
+
|
|
1789
|
+
### `posthog.integrationsDomainConnectCheckRetrieve`
|
|
1790
|
+
|
|
1791
|
+
- **HTTP**: `GET /api/projects/{project_id}/integrations/domain-connect/check/`
|
|
1792
|
+
- **OpenAPI operationId**: `integrations_domain_connect_check_retrieve`
|
|
1793
|
+
- **Path params**: None
|
|
1794
|
+
- **Query params**: None
|
|
1795
|
+
- **Response codes**: `200`
|
|
1796
|
+
- **Transport options**: None
|
|
1797
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1798
|
+
|
|
1799
|
+
**Inputs**
|
|
1800
|
+
|
|
1801
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1802
|
+
- Client transport options: None
|
|
1803
|
+
|
|
1804
|
+
**Outputs**
|
|
1805
|
+
|
|
1806
|
+
- Client return type: `unknown`
|
|
1807
|
+
- OpenAPI response codes: `200`
|
|
1808
|
+
|
|
1809
|
+
```ts
|
|
1810
|
+
import posthog from "@utdk/posthog";
|
|
1811
|
+
|
|
1812
|
+
type IntegrationsDomainConnectCheckRetrieveInput = Parameters<typeof posthog.integrationsDomainConnectCheckRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1813
|
+
type IntegrationsDomainConnectCheckRetrieveOutput = Awaited<ReturnType<typeof posthog.integrationsDomainConnectCheckRetrieve>>;
|
|
1814
|
+
|
|
1815
|
+
const result: IntegrationsDomainConnectCheckRetrieveOutput = await posthog.integrationsDomainConnectCheckRetrieve();
|
|
1816
|
+
|
|
1817
|
+
// Result shape (from schema): unknown
|
|
1818
|
+
```
|
|
1819
|
+
|
|
1820
|
+
### `posthog.integrationsGithubLinkExistingCreate`
|
|
1821
|
+
|
|
1822
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/github/link_existing/`
|
|
1823
|
+
- **What it does**: Reuse a GitHub installation already linked to a sibling team in the same organization.
|
|
1824
|
+
- **OpenAPI operationId**: `integrations_github_link_existing_create`
|
|
1825
|
+
- **Path params**: None
|
|
1826
|
+
- **Query params**: None
|
|
1827
|
+
- **Response codes**: `200`
|
|
1828
|
+
- **Transport options**: None
|
|
1829
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1830
|
+
|
|
1831
|
+
**Inputs**
|
|
1832
|
+
|
|
1833
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1834
|
+
- Client transport options: None
|
|
1835
|
+
|
|
1836
|
+
**Outputs**
|
|
1837
|
+
|
|
1838
|
+
- Client return type: `{ id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...`
|
|
1839
|
+
- OpenAPI response codes: `200`
|
|
1840
|
+
|
|
1841
|
+
```ts
|
|
1842
|
+
import posthog from "@utdk/posthog";
|
|
1843
|
+
|
|
1844
|
+
type IntegrationsGithubLinkExistingCreateInput = Parameters<typeof posthog.integrationsGithubLinkExistingCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1845
|
+
type IntegrationsGithubLinkExistingCreateOutput = Awaited<ReturnType<typeof posthog.integrationsGithubLinkExistingCreate>>;
|
|
1846
|
+
|
|
1847
|
+
const result: IntegrationsGithubLinkExistingCreateOutput = await posthog.integrationsGithubLinkExistingCreate();
|
|
1848
|
+
|
|
1849
|
+
// Result shape (from schema): { id: number; kind: "anthropic" | "apns" | "aws-s3" | "azure-blob" | "bing-ads" | "clickup" | "customerio-app" | "customerio-track" | "customerio-webhook" | "databricks" | "email" | "firebase" | "github" | "gitlab" | "g...
|
|
1850
|
+
```
|
|
1851
|
+
|
|
1852
|
+
### `posthog.integrationsGithubOauthAuthorizeCreate`
|
|
1853
|
+
|
|
1854
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/github/oauth_authorize/`
|
|
1855
|
+
- **What it does**: Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one.
|
|
1856
|
+
- **OpenAPI operationId**: `integrations_github_oauth_authorize_create`
|
|
1857
|
+
- **Path params**: None
|
|
1858
|
+
- **Query params**: None
|
|
1859
|
+
- **Response codes**: `200`
|
|
1860
|
+
- **Transport options**: None
|
|
1861
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1862
|
+
|
|
1863
|
+
**Inputs**
|
|
1864
|
+
|
|
1865
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1866
|
+
- Client transport options: None
|
|
1867
|
+
|
|
1868
|
+
**Outputs**
|
|
1869
|
+
|
|
1870
|
+
- Client return type: `{ oauth_url: string }`
|
|
1871
|
+
- OpenAPI response codes: `200`
|
|
1872
|
+
|
|
1873
|
+
```ts
|
|
1874
|
+
import posthog from "@utdk/posthog";
|
|
1875
|
+
|
|
1876
|
+
type IntegrationsGithubOauthAuthorizeCreateInput = Parameters<typeof posthog.integrationsGithubOauthAuthorizeCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1877
|
+
type IntegrationsGithubOauthAuthorizeCreateOutput = Awaited<ReturnType<typeof posthog.integrationsGithubOauthAuthorizeCreate>>;
|
|
1878
|
+
|
|
1879
|
+
const result: IntegrationsGithubOauthAuthorizeCreateOutput = await posthog.integrationsGithubOauthAuthorizeCreate();
|
|
1880
|
+
|
|
1881
|
+
// Result shape (from schema): { oauth_url: string }
|
|
1882
|
+
```
|
|
1883
|
+
|
|
1884
|
+
### `posthog.integrationsGithubPrepareCallbackCreate`
|
|
1885
|
+
|
|
1886
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/github/prepare_callback/`
|
|
1887
|
+
- **What it does**: Seed GitHub setup callback state without redirecting to GitHub.
|
|
1888
|
+
|
|
1889
|
+
Used when the user opens an existing installation's settings on github.com (e.g. PostHog
|
|
1890
|
+
Code "Update in GitHub") so the subsequent Setup URL redirect can be validated.
|
|
1891
|
+
- **OpenAPI operationId**: `integrations_github_prepare_callback_create`
|
|
1892
|
+
- **Path params**: None
|
|
1893
|
+
- **Query params**: None
|
|
1894
|
+
- **Response codes**: `204`
|
|
1895
|
+
- **Transport options**: None
|
|
1896
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1897
|
+
|
|
1898
|
+
**Inputs**
|
|
1899
|
+
|
|
1900
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1901
|
+
- Client transport options: None
|
|
1902
|
+
|
|
1903
|
+
**Outputs**
|
|
1904
|
+
|
|
1905
|
+
- Client return type: `unknown`
|
|
1906
|
+
- OpenAPI response codes: `204`
|
|
1907
|
+
|
|
1908
|
+
```ts
|
|
1909
|
+
import posthog from "@utdk/posthog";
|
|
1910
|
+
|
|
1911
|
+
type IntegrationsGithubPrepareCallbackCreateInput = Parameters<typeof posthog.integrationsGithubPrepareCallbackCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1912
|
+
type IntegrationsGithubPrepareCallbackCreateOutput = Awaited<ReturnType<typeof posthog.integrationsGithubPrepareCallbackCreate>>;
|
|
1913
|
+
|
|
1914
|
+
const result: IntegrationsGithubPrepareCallbackCreateOutput = await posthog.integrationsGithubPrepareCallbackCreate();
|
|
1915
|
+
|
|
1916
|
+
// Result shape (from schema): unknown
|
|
1917
|
+
```
|
|
1918
|
+
|
|
1919
|
+
### `posthog.integrationsRequestAccessCreate`
|
|
1920
|
+
|
|
1921
|
+
- **HTTP**: `POST /api/projects/{project_id}/integrations/request_access/`
|
|
1922
|
+
- **What it does**: Notify project admins that a member is requesting an integration be connected.
|
|
1923
|
+
- **OpenAPI operationId**: `integrations_request_access_create`
|
|
1924
|
+
- **Path params**: None
|
|
1925
|
+
- **Query params**: None
|
|
1926
|
+
- **Response codes**: `200`
|
|
1927
|
+
- **Transport options**: None
|
|
1928
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
1929
|
+
|
|
1930
|
+
**Inputs**
|
|
1931
|
+
|
|
1932
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
1933
|
+
- Client transport options: None
|
|
1934
|
+
|
|
1935
|
+
**Outputs**
|
|
1936
|
+
|
|
1937
|
+
- Client return type: `{ success: boolean }`
|
|
1938
|
+
- OpenAPI response codes: `200`
|
|
1939
|
+
|
|
1940
|
+
```ts
|
|
1941
|
+
import posthog from "@utdk/posthog";
|
|
1942
|
+
|
|
1943
|
+
type IntegrationsRequestAccessCreateInput = Parameters<typeof posthog.integrationsRequestAccessCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
1944
|
+
type IntegrationsRequestAccessCreateOutput = Awaited<ReturnType<typeof posthog.integrationsRequestAccessCreate>>;
|
|
1945
|
+
|
|
1946
|
+
const result: IntegrationsRequestAccessCreateOutput = await posthog.integrationsRequestAccessCreate();
|
|
1947
|
+
|
|
1948
|
+
// Result shape (from schema): { success: boolean }
|
|
1949
|
+
```
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
<!-- prompt-hash:
|
|
1953
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
1954
|
+
-->
|