@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,70 @@
|
|
|
1
|
+
# Plugin Configs
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.environmentsPluginConfigsLogsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/environments/{environment_id}/plugin_configs/{plugin_config_id}/logs/`
|
|
8
|
+
- **OpenAPI operationId**: `environments_plugin_configs_logs_list`
|
|
9
|
+
- **Path params**: `plugin_config_id`
|
|
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; team_id: number; plugin_id: number; plugin_config_id: number; timestamp: string; source: "SYSTEM" | "PLUGIN" | "CONSOLE"; type: "D...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type EnvironmentsPluginConfigsLogsListInput = Parameters<typeof posthog.environmentsPluginConfigsLogsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type EnvironmentsPluginConfigsLogsListOutput = Awaited<ReturnType<typeof posthog.environmentsPluginConfigsLogsList>>;
|
|
30
|
+
|
|
31
|
+
const result: EnvironmentsPluginConfigsLogsListOutput = await posthog.environmentsPluginConfigsLogsList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; plugin_id: number; plugin_config_id: number; timestamp: string; source: "SYSTEM" | "PLUGIN" | "CONSOLE"; type: "D...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.pluginConfigsLogsList`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `GET /api/projects/{project_id}/plugin_configs/{plugin_config_id}/logs/`
|
|
39
|
+
- **OpenAPI operationId**: `plugin_configs_logs_list`
|
|
40
|
+
- **Path params**: `plugin_config_id`
|
|
41
|
+
- **Query params**: `limit`, `offset`
|
|
42
|
+
- **Response codes**: `200`
|
|
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; plugin_id: number; plugin_config_id: number; timestamp: string; source: "SYSTEM" | "PLUGIN" | "CONSOLE"; type: "D...`
|
|
54
|
+
- OpenAPI response codes: `200`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type PluginConfigsLogsListInput = Parameters<typeof posthog.pluginConfigsLogsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type PluginConfigsLogsListOutput = Awaited<ReturnType<typeof posthog.pluginConfigsLogsList>>;
|
|
61
|
+
|
|
62
|
+
const result: PluginConfigsLogsListOutput = await posthog.pluginConfigsLogsList();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; plugin_id: number; plugin_config_id: number; timestamp: string; source: "SYSTEM" | "PLUGIN" | "CONSOLE"; type: "D...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<!-- prompt-hash:
|
|
69
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
70
|
+
-->
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Product Enablement
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.productEnablementCreate`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `POST /api/projects/{project_id}/product_enablement/`
|
|
8
|
+
- **OpenAPI operationId**: `product_enablement_create`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: None
|
|
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: `{ results: { [key: string]: string | undefined } }`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type ProductEnablementCreateInput = Parameters<typeof posthog.productEnablementCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type ProductEnablementCreateOutput = Awaited<ReturnType<typeof posthog.productEnablementCreate>>;
|
|
30
|
+
|
|
31
|
+
const result: ProductEnablementCreateOutput = await posthog.productEnablementCreate();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { results: { [key: string]: string | undefined } }
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
<!-- prompt-hash:
|
|
38
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
39
|
+
-->
|
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
# Product Tours
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.productToursList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/product_tours/`
|
|
8
|
+
- **OpenAPI operationId**: `product_tours_list`
|
|
9
|
+
- **Path params**: None
|
|
10
|
+
- **Query params**: `limit`, `offset`, `search`
|
|
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; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: ...`
|
|
23
|
+
- OpenAPI response codes: `200`
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import posthog from "@utdk/posthog";
|
|
27
|
+
|
|
28
|
+
type ProductToursListInput = Parameters<typeof posthog.productToursList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
29
|
+
type ProductToursListOutput = Awaited<ReturnType<typeof posthog.productToursList>>;
|
|
30
|
+
|
|
31
|
+
const result: ProductToursListOutput = await posthog.productToursList();
|
|
32
|
+
|
|
33
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: ...
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### `posthog.productToursCreate`
|
|
37
|
+
|
|
38
|
+
- **HTTP**: `POST /api/projects/{project_id}/product_tours/`
|
|
39
|
+
- **OpenAPI operationId**: `product_tours_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; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
54
|
+
- OpenAPI response codes: `201`
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
import posthog from "@utdk/posthog";
|
|
58
|
+
|
|
59
|
+
type ProductToursCreateInput = Parameters<typeof posthog.productToursCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
60
|
+
type ProductToursCreateOutput = Awaited<ReturnType<typeof posthog.productToursCreate>>;
|
|
61
|
+
|
|
62
|
+
const result: ProductToursCreateOutput = await posthog.productToursCreate();
|
|
63
|
+
|
|
64
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### `posthog.productToursDestroy`
|
|
68
|
+
|
|
69
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/product_tours/{id}/`
|
|
70
|
+
- **OpenAPI operationId**: `product_tours_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 ProductToursDestroyInput = Parameters<typeof posthog.productToursDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
91
|
+
type ProductToursDestroyOutput = Awaited<ReturnType<typeof posthog.productToursDestroy>>;
|
|
92
|
+
|
|
93
|
+
const result: ProductToursDestroyOutput = await posthog.productToursDestroy();
|
|
94
|
+
|
|
95
|
+
// Result shape (from schema): unknown
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### `posthog.productToursRetrieve`
|
|
99
|
+
|
|
100
|
+
- **HTTP**: `GET /api/projects/{project_id}/product_tours/{id}/`
|
|
101
|
+
- **OpenAPI operationId**: `product_tours_retrieve`
|
|
102
|
+
- **Path params**: `id`
|
|
103
|
+
- **Query params**: None
|
|
104
|
+
- **Response codes**: `200`
|
|
105
|
+
- **Transport options**: None
|
|
106
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
107
|
+
|
|
108
|
+
**Inputs**
|
|
109
|
+
|
|
110
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
111
|
+
- Client transport options: None
|
|
112
|
+
|
|
113
|
+
**Outputs**
|
|
114
|
+
|
|
115
|
+
- Client return type: `{ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
116
|
+
- OpenAPI response codes: `200`
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import posthog from "@utdk/posthog";
|
|
120
|
+
|
|
121
|
+
type ProductToursRetrieveInput = Parameters<typeof posthog.productToursRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
122
|
+
type ProductToursRetrieveOutput = Awaited<ReturnType<typeof posthog.productToursRetrieve>>;
|
|
123
|
+
|
|
124
|
+
const result: ProductToursRetrieveOutput = await posthog.productToursRetrieve();
|
|
125
|
+
|
|
126
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### `posthog.productToursPartialUpdate`
|
|
130
|
+
|
|
131
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/product_tours/{id}/`
|
|
132
|
+
- **OpenAPI operationId**: `product_tours_partial_update`
|
|
133
|
+
- **Path params**: `id`
|
|
134
|
+
- **Query params**: None
|
|
135
|
+
- **Response codes**: `200`
|
|
136
|
+
- **Transport options**: None
|
|
137
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
138
|
+
|
|
139
|
+
**Inputs**
|
|
140
|
+
|
|
141
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
142
|
+
- Client transport options: None
|
|
143
|
+
|
|
144
|
+
**Outputs**
|
|
145
|
+
|
|
146
|
+
- Client return type: `{ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
147
|
+
- OpenAPI response codes: `200`
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import posthog from "@utdk/posthog";
|
|
151
|
+
|
|
152
|
+
type ProductToursPartialUpdateInput = Parameters<typeof posthog.productToursPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
153
|
+
type ProductToursPartialUpdateOutput = Awaited<ReturnType<typeof posthog.productToursPartialUpdate>>;
|
|
154
|
+
|
|
155
|
+
const result: ProductToursPartialUpdateOutput = await posthog.productToursPartialUpdate();
|
|
156
|
+
|
|
157
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### `posthog.productToursUpdate`
|
|
161
|
+
|
|
162
|
+
- **HTTP**: `PUT /api/projects/{project_id}/product_tours/{id}/`
|
|
163
|
+
- **OpenAPI operationId**: `product_tours_update`
|
|
164
|
+
- **Path params**: `id`
|
|
165
|
+
- **Query params**: None
|
|
166
|
+
- **Response codes**: `200`
|
|
167
|
+
- **Transport options**: None
|
|
168
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
169
|
+
|
|
170
|
+
**Inputs**
|
|
171
|
+
|
|
172
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
173
|
+
- Client transport options: None
|
|
174
|
+
|
|
175
|
+
**Outputs**
|
|
176
|
+
|
|
177
|
+
- Client return type: `{ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
178
|
+
- OpenAPI response codes: `200`
|
|
179
|
+
|
|
180
|
+
```ts
|
|
181
|
+
import posthog from "@utdk/posthog";
|
|
182
|
+
|
|
183
|
+
type ProductToursUpdateInput = Parameters<typeof posthog.productToursUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
184
|
+
type ProductToursUpdateOutput = Awaited<ReturnType<typeof posthog.productToursUpdate>>;
|
|
185
|
+
|
|
186
|
+
const result: ProductToursUpdateOutput = await posthog.productToursUpdate();
|
|
187
|
+
|
|
188
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### `posthog.productToursDiscardDraftDestroy`
|
|
192
|
+
|
|
193
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/product_tours/{id}/discard_draft/`
|
|
194
|
+
- **What it does**: Discard draft content.
|
|
195
|
+
- **OpenAPI operationId**: `product_tours_discard_draft_destroy`
|
|
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; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
210
|
+
- OpenAPI response codes: `200`
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
import posthog from "@utdk/posthog";
|
|
214
|
+
|
|
215
|
+
type ProductToursDiscardDraftDestroyInput = Parameters<typeof posthog.productToursDiscardDraftDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
216
|
+
type ProductToursDiscardDraftDestroyOutput = Awaited<ReturnType<typeof posthog.productToursDiscardDraftDestroy>>;
|
|
217
|
+
|
|
218
|
+
const result: ProductToursDiscardDraftDestroyOutput = await posthog.productToursDiscardDraftDestroy();
|
|
219
|
+
|
|
220
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### `posthog.productToursDraftStatusRetrieve`
|
|
224
|
+
|
|
225
|
+
- **HTTP**: `GET /api/projects/{project_id}/product_tours/{id}/draft_status/`
|
|
226
|
+
- **What it does**: Lightweight polling endpoint for draft change detection.
|
|
227
|
+
- **OpenAPI operationId**: `product_tours_draft_status_retrieve`
|
|
228
|
+
- **Path params**: `id`
|
|
229
|
+
- **Query params**: None
|
|
230
|
+
- **Response codes**: `200`
|
|
231
|
+
- **Transport options**: None
|
|
232
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
233
|
+
|
|
234
|
+
**Inputs**
|
|
235
|
+
|
|
236
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
237
|
+
- Client transport options: None
|
|
238
|
+
|
|
239
|
+
**Outputs**
|
|
240
|
+
|
|
241
|
+
- Client return type: `{ updated_at: string; has_draft: boolean }`
|
|
242
|
+
- OpenAPI response codes: `200`
|
|
243
|
+
|
|
244
|
+
```ts
|
|
245
|
+
import posthog from "@utdk/posthog";
|
|
246
|
+
|
|
247
|
+
type ProductToursDraftStatusRetrieveInput = Parameters<typeof posthog.productToursDraftStatusRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
248
|
+
type ProductToursDraftStatusRetrieveOutput = Awaited<ReturnType<typeof posthog.productToursDraftStatusRetrieve>>;
|
|
249
|
+
|
|
250
|
+
const result: ProductToursDraftStatusRetrieveOutput = await posthog.productToursDraftStatusRetrieve();
|
|
251
|
+
|
|
252
|
+
// Result shape (from schema): { updated_at: string; has_draft: boolean }
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### `posthog.productToursDraftPartialUpdate`
|
|
256
|
+
|
|
257
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/product_tours/{id}/draft/`
|
|
258
|
+
- **What it does**: Save draft content (server-side merge). No side effects triggered.
|
|
259
|
+
- **OpenAPI operationId**: `product_tours_draft_partial_update`
|
|
260
|
+
- **Path params**: `id`
|
|
261
|
+
- **Query params**: None
|
|
262
|
+
- **Response codes**: `200`
|
|
263
|
+
- **Transport options**: None
|
|
264
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
265
|
+
|
|
266
|
+
**Inputs**
|
|
267
|
+
|
|
268
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
269
|
+
- Client transport options: None
|
|
270
|
+
|
|
271
|
+
**Outputs**
|
|
272
|
+
|
|
273
|
+
- Client return type: `{ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
274
|
+
- OpenAPI response codes: `200`
|
|
275
|
+
|
|
276
|
+
```ts
|
|
277
|
+
import posthog from "@utdk/posthog";
|
|
278
|
+
|
|
279
|
+
type ProductToursDraftPartialUpdateInput = Parameters<typeof posthog.productToursDraftPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
280
|
+
type ProductToursDraftPartialUpdateOutput = Awaited<ReturnType<typeof posthog.productToursDraftPartialUpdate>>;
|
|
281
|
+
|
|
282
|
+
const result: ProductToursDraftPartialUpdateOutput = await posthog.productToursDraftPartialUpdate();
|
|
283
|
+
|
|
284
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### `posthog.productToursGenerateCreate`
|
|
288
|
+
|
|
289
|
+
- **HTTP**: `POST /api/projects/{project_id}/product_tours/{id}/generate/`
|
|
290
|
+
- **What it does**: Generate tour step content using AI.
|
|
291
|
+
- **OpenAPI operationId**: `product_tours_generate_create`
|
|
292
|
+
- **Path params**: `id`
|
|
293
|
+
- **Query params**: None
|
|
294
|
+
- **Response codes**: `200`
|
|
295
|
+
- **Transport options**: None
|
|
296
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
297
|
+
|
|
298
|
+
**Inputs**
|
|
299
|
+
|
|
300
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
301
|
+
- Client transport options: None
|
|
302
|
+
|
|
303
|
+
**Outputs**
|
|
304
|
+
|
|
305
|
+
- Client return type: `{ steps: ({ step_id: string; title: string; description: string })[] }`
|
|
306
|
+
- OpenAPI response codes: `200`
|
|
307
|
+
|
|
308
|
+
```ts
|
|
309
|
+
import posthog from "@utdk/posthog";
|
|
310
|
+
|
|
311
|
+
type ProductToursGenerateCreateInput = Parameters<typeof posthog.productToursGenerateCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
312
|
+
type ProductToursGenerateCreateOutput = Awaited<ReturnType<typeof posthog.productToursGenerateCreate>>;
|
|
313
|
+
|
|
314
|
+
const result: ProductToursGenerateCreateOutput = await posthog.productToursGenerateCreate();
|
|
315
|
+
|
|
316
|
+
// Result shape (from schema): { steps: ({ step_id: string; title: string; description: string })[] }
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### `posthog.productToursPublishDraftCreate`
|
|
320
|
+
|
|
321
|
+
- **HTTP**: `POST /api/projects/{project_id}/product_tours/{id}/publish_draft/`
|
|
322
|
+
- **What it does**: Commit draft to live tour. Runs full validation and triggers side effects.
|
|
323
|
+
|
|
324
|
+
Accepts an optional body payload. If provided, merges it into the draft
|
|
325
|
+
before publishing so the caller can save + publish in a single request.
|
|
326
|
+
- **OpenAPI operationId**: `product_tours_publish_draft_create`
|
|
327
|
+
- **Path params**: `id`
|
|
328
|
+
- **Query params**: None
|
|
329
|
+
- **Response codes**: `200`
|
|
330
|
+
- **Transport options**: None
|
|
331
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
332
|
+
|
|
333
|
+
**Inputs**
|
|
334
|
+
|
|
335
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
336
|
+
- Client transport options: None
|
|
337
|
+
|
|
338
|
+
**Outputs**
|
|
339
|
+
|
|
340
|
+
- Client return type: `{ id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...`
|
|
341
|
+
- OpenAPI response codes: `200`
|
|
342
|
+
|
|
343
|
+
```ts
|
|
344
|
+
import posthog from "@utdk/posthog";
|
|
345
|
+
|
|
346
|
+
type ProductToursPublishDraftCreateInput = Parameters<typeof posthog.productToursPublishDraftCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
347
|
+
type ProductToursPublishDraftCreateOutput = Awaited<ReturnType<typeof posthog.productToursPublishDraftCreate>>;
|
|
348
|
+
|
|
349
|
+
const result: ProductToursPublishDraftCreateOutput = await posthog.productToursPublishDraftCreate();
|
|
350
|
+
|
|
351
|
+
// Result shape (from schema): { id: string; name: string; description?: string; internal_targeting_flag: { id: number; team_id: number; name?: string; key: string; filters?: { [key: string]: unknown }; deleted?: boolean; active?: boolean; ensure_exp...
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
<!-- prompt-hash:
|
|
356
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
357
|
+
-->
|