@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,78 @@
|
|
|
1
|
+
# Mcp Servers
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsMcpServersList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/mcp_servers/`
|
|
8
|
+
- **What it does**: Lists curated MCP server templates that users can install with one click.
|
|
9
|
+
|
|
10
|
+
Templates are seeded by PostHog operators and carry shared, encrypted
|
|
11
|
+
OAuth client credentials. Inactive templates are hidden from the catalog.
|
|
12
|
+
- **OpenAPI operationId**: `environments_mcp_servers_list`
|
|
13
|
+
- **Path params**: None
|
|
14
|
+
- **Query params**: `limit`, `offset`
|
|
15
|
+
- **Response codes**: `200`
|
|
16
|
+
- **Transport options**: None
|
|
17
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
18
|
+
|
|
19
|
+
**Inputs**
|
|
20
|
+
|
|
21
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
22
|
+
- Client transport options: None
|
|
23
|
+
|
|
24
|
+
**Outputs**
|
|
25
|
+
|
|
26
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; url: string; docs_url?: string; description?: string; auth_type?: "api_key" | "oauth"; icon_key?: string; category?:...`
|
|
27
|
+
- OpenAPI response codes: `200`
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import posthog from "@utdk/posthog";
|
|
31
|
+
|
|
32
|
+
type EnvironmentsMcpServersListInput = Parameters<typeof posthog.environmentsMcpServersList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
33
|
+
type EnvironmentsMcpServersListOutput = Awaited<ReturnType<typeof posthog.environmentsMcpServersList>>;
|
|
34
|
+
|
|
35
|
+
const result: EnvironmentsMcpServersListOutput = await posthog.environmentsMcpServersList();
|
|
36
|
+
|
|
37
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; url: string; docs_url?: string; description?: string; auth_type?: "api_key" | "oauth"; icon_key?: string; category?:...
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### `posthog.mcpServersList`
|
|
41
|
+
|
|
42
|
+
- **HTTP**: `GET /api/projects/{project_id}/mcp_servers/`
|
|
43
|
+
- **What it does**: Lists curated MCP server templates that users can install with one click.
|
|
44
|
+
|
|
45
|
+
Templates are seeded by PostHog operators and carry shared, encrypted
|
|
46
|
+
OAuth client credentials. Inactive templates are hidden from the catalog.
|
|
47
|
+
- **OpenAPI operationId**: `mcp_servers_list`
|
|
48
|
+
- **Path params**: None
|
|
49
|
+
- **Query params**: `limit`, `offset`
|
|
50
|
+
- **Response codes**: `200`
|
|
51
|
+
- **Transport options**: None
|
|
52
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
53
|
+
|
|
54
|
+
**Inputs**
|
|
55
|
+
|
|
56
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
57
|
+
- Client transport options: None
|
|
58
|
+
|
|
59
|
+
**Outputs**
|
|
60
|
+
|
|
61
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; url: string; docs_url?: string; description?: string; auth_type?: "api_key" | "oauth"; icon_key?: string; category?:...`
|
|
62
|
+
- OpenAPI response codes: `200`
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
import posthog from "@utdk/posthog";
|
|
66
|
+
|
|
67
|
+
type McpServersListInput = Parameters<typeof posthog.mcpServersList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
68
|
+
type McpServersListOutput = Awaited<ReturnType<typeof posthog.mcpServersList>>;
|
|
69
|
+
|
|
70
|
+
const result: McpServersListOutput = await posthog.mcpServersList();
|
|
71
|
+
|
|
72
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; url: string; docs_url?: string; description?: string; auth_type?: "api_key" | "oauth"; icon_key?: string; category?:...
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
<!-- prompt-hash:
|
|
77
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
78
|
+
-->
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Mcp Tools
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsMcpToolsCreate`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `POST /api/environments/{environment_id}/mcp_tools/{tool_name}/`
|
|
8
|
+
- **What it does**: Invoke an MCP tool by name.
|
|
9
|
+
|
|
10
|
+
This endpoint allows MCP callers to invoke Max AI tools directly
|
|
11
|
+
without going through the full LangChain conversation flow.
|
|
12
|
+
|
|
13
|
+
Scopes are resolved dynamically per tool via dangerously_get_required_scopes.
|
|
14
|
+
- **OpenAPI operationId**: `environments_mcp_tools_create`
|
|
15
|
+
- **Path params**: `tool_name`
|
|
16
|
+
- **Query params**: None
|
|
17
|
+
- **Response codes**: `200`
|
|
18
|
+
- **Transport options**: None
|
|
19
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
20
|
+
|
|
21
|
+
**Inputs**
|
|
22
|
+
|
|
23
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
24
|
+
- Client transport options: None
|
|
25
|
+
|
|
26
|
+
**Outputs**
|
|
27
|
+
|
|
28
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
29
|
+
- OpenAPI response codes: `200`
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
import posthog from "@utdk/posthog";
|
|
33
|
+
|
|
34
|
+
type EnvironmentsMcpToolsCreateInput = Parameters<typeof posthog.environmentsMcpToolsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
35
|
+
type EnvironmentsMcpToolsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsMcpToolsCreate>>;
|
|
36
|
+
|
|
37
|
+
const result: EnvironmentsMcpToolsCreateOutput = await posthog.environmentsMcpToolsCreate();
|
|
38
|
+
|
|
39
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### `posthog.mcpToolsCreate`
|
|
43
|
+
|
|
44
|
+
- **HTTP**: `POST /api/projects/{project_id}/mcp_tools/{tool_name}/`
|
|
45
|
+
- **What it does**: Invoke an MCP tool by name.
|
|
46
|
+
|
|
47
|
+
This endpoint allows MCP callers to invoke Max AI tools directly
|
|
48
|
+
without going through the full LangChain conversation flow.
|
|
49
|
+
|
|
50
|
+
Scopes are resolved dynamically per tool via dangerously_get_required_scopes.
|
|
51
|
+
- **OpenAPI operationId**: `mcp_tools_create`
|
|
52
|
+
- **Path params**: `tool_name`
|
|
53
|
+
- **Query params**: None
|
|
54
|
+
- **Response codes**: `200`
|
|
55
|
+
- **Transport options**: None
|
|
56
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
57
|
+
|
|
58
|
+
**Inputs**
|
|
59
|
+
|
|
60
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
61
|
+
- Client transport options: None
|
|
62
|
+
|
|
63
|
+
**Outputs**
|
|
64
|
+
|
|
65
|
+
- Client return type: `{ [key: string]: unknown }`
|
|
66
|
+
- OpenAPI response codes: `200`
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
import posthog from "@utdk/posthog";
|
|
70
|
+
|
|
71
|
+
type McpToolsCreateInput = Parameters<typeof posthog.mcpToolsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
72
|
+
type McpToolsCreateOutput = Awaited<ReturnType<typeof posthog.mcpToolsCreate>>;
|
|
73
|
+
|
|
74
|
+
const result: McpToolsCreateOutput = await posthog.mcpToolsCreate();
|
|
75
|
+
|
|
76
|
+
// Result shape (from schema): { [key: string]: unknown }
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<!-- prompt-hash:
|
|
81
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
82
|
+
-->
|
|
@@ -0,0 +1,444 @@
|
|
|
1
|
+
# Messaging Templates
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsMessagingTemplatesList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/messaging_templates/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_messaging_templates_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `limit`, `offset`
|
|
11
|
+
- **Response codes**: `200`
|
|
12
|
+
- **Transport options**: None
|
|
13
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
14
|
+
|
|
15
|
+
**Inputs**
|
|
16
|
+
|
|
17
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
18
|
+
- Client transport options: None
|
|
19
|
+
|
|
20
|
+
**Outputs**
|
|
21
|
+
|
|
22
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?:...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsMessagingTemplatesListInput = Parameters<typeof posthog.environmentsMessagingTemplatesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsMessagingTemplatesListOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsMessagingTemplatesListOutput = await posthog.environmentsMessagingTemplatesList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?:...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.environmentsMessagingTemplatesCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/environments/{environment_id}/messaging_templates/`
|
|
39
|
+
- **OpenAPI operationId**: `environments_messaging_templates_create`
|
|
40
|
+
- **Path params**: None
|
|
41
|
+
- **Query params**: None
|
|
42
|
+
- **Response codes**: `201`
|
|
43
|
+
- **Transport options**: None
|
|
44
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
45
|
+
|
|
46
|
+
**Inputs**
|
|
47
|
+
|
|
48
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
49
|
+
- Client transport options: None
|
|
50
|
+
|
|
51
|
+
**Outputs**
|
|
52
|
+
|
|
53
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type EnvironmentsMessagingTemplatesCreateInput = Parameters<typeof posthog.environmentsMessagingTemplatesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type EnvironmentsMessagingTemplatesCreateOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: EnvironmentsMessagingTemplatesCreateOutput = await posthog.environmentsMessagingTemplatesCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.environmentsMessagingTemplatesDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/environments/{environment_id}/messaging_templates/{id}/`
|
|
70
|
+
- **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
|
|
71
|
+
- **OpenAPI operationId**: `environments_messaging_templates_destroy`
|
|
72
|
+
- **Path params**: `id`
|
|
73
|
+
- **Query params**: None
|
|
74
|
+
- **Response codes**: `405`
|
|
75
|
+
- **Transport options**: None
|
|
76
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
77
|
+
|
|
78
|
+
**Inputs**
|
|
79
|
+
|
|
80
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
81
|
+
- Client transport options: None
|
|
82
|
+
|
|
83
|
+
**Outputs**
|
|
84
|
+
|
|
85
|
+
- Client return type: `unknown`
|
|
86
|
+
- OpenAPI response codes: `405`
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import posthog from "@utdk/posthog";
|
|
90
|
+
|
|
91
|
+
type EnvironmentsMessagingTemplatesDestroyInput = Parameters<typeof posthog.environmentsMessagingTemplatesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
92
|
+
type EnvironmentsMessagingTemplatesDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesDestroy>>;
|
|
93
|
+
|
|
94
|
+
const result: EnvironmentsMessagingTemplatesDestroyOutput = await posthog.environmentsMessagingTemplatesDestroy();
|
|
95
|
+
|
|
96
|
+
// Result shape (from schema): unknown
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### `posthog.environmentsMessagingTemplatesRetrieve`
|
|
100
|
+
|
|
101
|
+
- **HTTP**: `GET /api/environments/{environment_id}/messaging_templates/{id}/`
|
|
102
|
+
- **OpenAPI operationId**: `environments_messaging_templates_retrieve`
|
|
103
|
+
- **Path params**: `id`
|
|
104
|
+
- **Query params**: None
|
|
105
|
+
- **Response codes**: `200`
|
|
106
|
+
- **Transport options**: None
|
|
107
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
108
|
+
|
|
109
|
+
**Inputs**
|
|
110
|
+
|
|
111
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
112
|
+
- Client transport options: None
|
|
113
|
+
|
|
114
|
+
**Outputs**
|
|
115
|
+
|
|
116
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
117
|
+
- OpenAPI response codes: `200`
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import posthog from "@utdk/posthog";
|
|
121
|
+
|
|
122
|
+
type EnvironmentsMessagingTemplatesRetrieveInput = Parameters<typeof posthog.environmentsMessagingTemplatesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
123
|
+
type EnvironmentsMessagingTemplatesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesRetrieve>>;
|
|
124
|
+
|
|
125
|
+
const result: EnvironmentsMessagingTemplatesRetrieveOutput = await posthog.environmentsMessagingTemplatesRetrieve();
|
|
126
|
+
|
|
127
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### `posthog.environmentsMessagingTemplatesPartialUpdate`
|
|
131
|
+
|
|
132
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/messaging_templates/{id}/`
|
|
133
|
+
- **OpenAPI operationId**: `environments_messaging_templates_partial_update`
|
|
134
|
+
- **Path params**: `id`
|
|
135
|
+
- **Query params**: None
|
|
136
|
+
- **Response codes**: `200`
|
|
137
|
+
- **Transport options**: None
|
|
138
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
139
|
+
|
|
140
|
+
**Inputs**
|
|
141
|
+
|
|
142
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
143
|
+
- Client transport options: None
|
|
144
|
+
|
|
145
|
+
**Outputs**
|
|
146
|
+
|
|
147
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
148
|
+
- OpenAPI response codes: `200`
|
|
149
|
+
|
|
150
|
+
```ts
|
|
151
|
+
import posthog from "@utdk/posthog";
|
|
152
|
+
|
|
153
|
+
type EnvironmentsMessagingTemplatesPartialUpdateInput = Parameters<typeof posthog.environmentsMessagingTemplatesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
154
|
+
type EnvironmentsMessagingTemplatesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesPartialUpdate>>;
|
|
155
|
+
|
|
156
|
+
const result: EnvironmentsMessagingTemplatesPartialUpdateOutput = await posthog.environmentsMessagingTemplatesPartialUpdate();
|
|
157
|
+
|
|
158
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### `posthog.environmentsMessagingTemplatesUpdate`
|
|
162
|
+
|
|
163
|
+
- **HTTP**: `PUT /api/environments/{environment_id}/messaging_templates/{id}/`
|
|
164
|
+
- **OpenAPI operationId**: `environments_messaging_templates_update`
|
|
165
|
+
- **Path params**: `id`
|
|
166
|
+
- **Query params**: None
|
|
167
|
+
- **Response codes**: `200`
|
|
168
|
+
- **Transport options**: None
|
|
169
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
170
|
+
|
|
171
|
+
**Inputs**
|
|
172
|
+
|
|
173
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
174
|
+
- Client transport options: None
|
|
175
|
+
|
|
176
|
+
**Outputs**
|
|
177
|
+
|
|
178
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
179
|
+
- OpenAPI response codes: `200`
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
import posthog from "@utdk/posthog";
|
|
183
|
+
|
|
184
|
+
type EnvironmentsMessagingTemplatesUpdateInput = Parameters<typeof posthog.environmentsMessagingTemplatesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
185
|
+
type EnvironmentsMessagingTemplatesUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesUpdate>>;
|
|
186
|
+
|
|
187
|
+
const result: EnvironmentsMessagingTemplatesUpdateOutput = await posthog.environmentsMessagingTemplatesUpdate();
|
|
188
|
+
|
|
189
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### `posthog.environmentsMessagingTemplatesDesignPartialUpdate`
|
|
193
|
+
|
|
194
|
+
- **HTTP**: `PATCH /api/environments/{environment_id}/messaging_templates/{id}/design/`
|
|
195
|
+
- **OpenAPI operationId**: `environments_messaging_templates_design_partial_update`
|
|
196
|
+
- **Path params**: `id`
|
|
197
|
+
- **Query params**: None
|
|
198
|
+
- **Response codes**: `200`
|
|
199
|
+
- **Transport options**: None
|
|
200
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
201
|
+
|
|
202
|
+
**Inputs**
|
|
203
|
+
|
|
204
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
205
|
+
- Client transport options: None
|
|
206
|
+
|
|
207
|
+
**Outputs**
|
|
208
|
+
|
|
209
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
210
|
+
- OpenAPI response codes: `200`
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import posthog from "@utdk/posthog";
|
|
214
|
+
|
|
215
|
+
type EnvironmentsMessagingTemplatesDesignPartialUpdateInput = Parameters<typeof posthog.environmentsMessagingTemplatesDesignPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
216
|
+
type EnvironmentsMessagingTemplatesDesignPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsMessagingTemplatesDesignPartialUpdate>>;
|
|
217
|
+
|
|
218
|
+
const result: EnvironmentsMessagingTemplatesDesignPartialUpdateOutput = await posthog.environmentsMessagingTemplatesDesignPartialUpdate();
|
|
219
|
+
|
|
220
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### `posthog.messagingTemplatesList`
|
|
224
|
+
|
|
225
|
+
- **HTTP**: `GET /api/projects/{project_id}/messaging_templates/`
|
|
226
|
+
- **OpenAPI operationId**: `messaging_templates_list`
|
|
227
|
+
- **Path params**: None
|
|
228
|
+
- **Query params**: `limit`, `offset`
|
|
229
|
+
- **Response codes**: `200`
|
|
230
|
+
- **Transport options**: None
|
|
231
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
232
|
+
|
|
233
|
+
**Inputs**
|
|
234
|
+
|
|
235
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
236
|
+
- Client transport options: None
|
|
237
|
+
|
|
238
|
+
**Outputs**
|
|
239
|
+
|
|
240
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?:...`
|
|
241
|
+
- OpenAPI response codes: `200`
|
|
242
|
+
|
|
243
|
+
```ts
|
|
244
|
+
import posthog from "@utdk/posthog";
|
|
245
|
+
|
|
246
|
+
type MessagingTemplatesListInput = Parameters<typeof posthog.messagingTemplatesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
247
|
+
type MessagingTemplatesListOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesList>>;
|
|
248
|
+
|
|
249
|
+
const result: MessagingTemplatesListOutput = await posthog.messagingTemplatesList();
|
|
250
|
+
|
|
251
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?:...
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### `posthog.messagingTemplatesCreate`
|
|
255
|
+
|
|
256
|
+
- **HTTP**: `POST /api/projects/{project_id}/messaging_templates/`
|
|
257
|
+
- **OpenAPI operationId**: `messaging_templates_create`
|
|
258
|
+
- **Path params**: None
|
|
259
|
+
- **Query params**: None
|
|
260
|
+
- **Response codes**: `201`
|
|
261
|
+
- **Transport options**: None
|
|
262
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
263
|
+
|
|
264
|
+
**Inputs**
|
|
265
|
+
|
|
266
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
267
|
+
- Client transport options: None
|
|
268
|
+
|
|
269
|
+
**Outputs**
|
|
270
|
+
|
|
271
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
272
|
+
- OpenAPI response codes: `201`
|
|
273
|
+
|
|
274
|
+
```ts
|
|
275
|
+
import posthog from "@utdk/posthog";
|
|
276
|
+
|
|
277
|
+
type MessagingTemplatesCreateInput = Parameters<typeof posthog.messagingTemplatesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
278
|
+
type MessagingTemplatesCreateOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesCreate>>;
|
|
279
|
+
|
|
280
|
+
const result: MessagingTemplatesCreateOutput = await posthog.messagingTemplatesCreate();
|
|
281
|
+
|
|
282
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### `posthog.messagingTemplatesDestroy`
|
|
286
|
+
|
|
287
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/messaging_templates/{id}/`
|
|
288
|
+
- **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
|
|
289
|
+
- **OpenAPI operationId**: `messaging_templates_destroy`
|
|
290
|
+
- **Path params**: `id`
|
|
291
|
+
- **Query params**: None
|
|
292
|
+
- **Response codes**: `405`
|
|
293
|
+
- **Transport options**: None
|
|
294
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
295
|
+
|
|
296
|
+
**Inputs**
|
|
297
|
+
|
|
298
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
299
|
+
- Client transport options: None
|
|
300
|
+
|
|
301
|
+
**Outputs**
|
|
302
|
+
|
|
303
|
+
- Client return type: `unknown`
|
|
304
|
+
- OpenAPI response codes: `405`
|
|
305
|
+
|
|
306
|
+
```ts
|
|
307
|
+
import posthog from "@utdk/posthog";
|
|
308
|
+
|
|
309
|
+
type MessagingTemplatesDestroyInput = Parameters<typeof posthog.messagingTemplatesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
310
|
+
type MessagingTemplatesDestroyOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesDestroy>>;
|
|
311
|
+
|
|
312
|
+
const result: MessagingTemplatesDestroyOutput = await posthog.messagingTemplatesDestroy();
|
|
313
|
+
|
|
314
|
+
// Result shape (from schema): unknown
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
### `posthog.messagingTemplatesRetrieve`
|
|
318
|
+
|
|
319
|
+
- **HTTP**: `GET /api/projects/{project_id}/messaging_templates/{id}/`
|
|
320
|
+
- **OpenAPI operationId**: `messaging_templates_retrieve`
|
|
321
|
+
- **Path params**: `id`
|
|
322
|
+
- **Query params**: None
|
|
323
|
+
- **Response codes**: `200`
|
|
324
|
+
- **Transport options**: None
|
|
325
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
326
|
+
|
|
327
|
+
**Inputs**
|
|
328
|
+
|
|
329
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
330
|
+
- Client transport options: None
|
|
331
|
+
|
|
332
|
+
**Outputs**
|
|
333
|
+
|
|
334
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
335
|
+
- OpenAPI response codes: `200`
|
|
336
|
+
|
|
337
|
+
```ts
|
|
338
|
+
import posthog from "@utdk/posthog";
|
|
339
|
+
|
|
340
|
+
type MessagingTemplatesRetrieveInput = Parameters<typeof posthog.messagingTemplatesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
341
|
+
type MessagingTemplatesRetrieveOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesRetrieve>>;
|
|
342
|
+
|
|
343
|
+
const result: MessagingTemplatesRetrieveOutput = await posthog.messagingTemplatesRetrieve();
|
|
344
|
+
|
|
345
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
### `posthog.messagingTemplatesPartialUpdate`
|
|
349
|
+
|
|
350
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/messaging_templates/{id}/`
|
|
351
|
+
- **OpenAPI operationId**: `messaging_templates_partial_update`
|
|
352
|
+
- **Path params**: `id`
|
|
353
|
+
- **Query params**: None
|
|
354
|
+
- **Response codes**: `200`
|
|
355
|
+
- **Transport options**: None
|
|
356
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
357
|
+
|
|
358
|
+
**Inputs**
|
|
359
|
+
|
|
360
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
361
|
+
- Client transport options: None
|
|
362
|
+
|
|
363
|
+
**Outputs**
|
|
364
|
+
|
|
365
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
366
|
+
- OpenAPI response codes: `200`
|
|
367
|
+
|
|
368
|
+
```ts
|
|
369
|
+
import posthog from "@utdk/posthog";
|
|
370
|
+
|
|
371
|
+
type MessagingTemplatesPartialUpdateInput = Parameters<typeof posthog.messagingTemplatesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
372
|
+
type MessagingTemplatesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesPartialUpdate>>;
|
|
373
|
+
|
|
374
|
+
const result: MessagingTemplatesPartialUpdateOutput = await posthog.messagingTemplatesPartialUpdate();
|
|
375
|
+
|
|
376
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### `posthog.messagingTemplatesUpdate`
|
|
380
|
+
|
|
381
|
+
- **HTTP**: `PUT /api/projects/{project_id}/messaging_templates/{id}/`
|
|
382
|
+
- **OpenAPI operationId**: `messaging_templates_update`
|
|
383
|
+
- **Path params**: `id`
|
|
384
|
+
- **Query params**: None
|
|
385
|
+
- **Response codes**: `200`
|
|
386
|
+
- **Transport options**: None
|
|
387
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
388
|
+
|
|
389
|
+
**Inputs**
|
|
390
|
+
|
|
391
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
392
|
+
- Client transport options: None
|
|
393
|
+
|
|
394
|
+
**Outputs**
|
|
395
|
+
|
|
396
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
397
|
+
- OpenAPI response codes: `200`
|
|
398
|
+
|
|
399
|
+
```ts
|
|
400
|
+
import posthog from "@utdk/posthog";
|
|
401
|
+
|
|
402
|
+
type MessagingTemplatesUpdateInput = Parameters<typeof posthog.messagingTemplatesUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
403
|
+
type MessagingTemplatesUpdateOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesUpdate>>;
|
|
404
|
+
|
|
405
|
+
const result: MessagingTemplatesUpdateOutput = await posthog.messagingTemplatesUpdate();
|
|
406
|
+
|
|
407
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
### `posthog.messagingTemplatesDesignPartialUpdate`
|
|
411
|
+
|
|
412
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/messaging_templates/{id}/design/`
|
|
413
|
+
- **OpenAPI operationId**: `messaging_templates_design_partial_update`
|
|
414
|
+
- **Path params**: `id`
|
|
415
|
+
- **Query params**: None
|
|
416
|
+
- **Response codes**: `200`
|
|
417
|
+
- **Transport options**: None
|
|
418
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
419
|
+
|
|
420
|
+
**Inputs**
|
|
421
|
+
|
|
422
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
423
|
+
- Client transport options: None
|
|
424
|
+
|
|
425
|
+
**Outputs**
|
|
426
|
+
|
|
427
|
+
- Client return type: `{ id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...`
|
|
428
|
+
- OpenAPI response codes: `200`
|
|
429
|
+
|
|
430
|
+
```ts
|
|
431
|
+
import posthog from "@utdk/posthog";
|
|
432
|
+
|
|
433
|
+
type MessagingTemplatesDesignPartialUpdateInput = Parameters<typeof posthog.messagingTemplatesDesignPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
434
|
+
type MessagingTemplatesDesignPartialUpdateOutput = Awaited<ReturnType<typeof posthog.messagingTemplatesDesignPartialUpdate>>;
|
|
435
|
+
|
|
436
|
+
const result: MessagingTemplatesDesignPartialUpdateOutput = await posthog.messagingTemplatesDesignPartialUpdate();
|
|
437
|
+
|
|
438
|
+
// Result shape (from schema): { id: string; name: string; description?: string; created_at: string; updated_at: string; content?: { templating?: "liquid"; email?: { subject?: string; text?: string; html?: string; design?: { counters?: { [key: string...
|
|
439
|
+
```
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<!-- prompt-hash:
|
|
443
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
444
|
+
-->
|