@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,468 @@
|
|
|
1
|
+
# Business Knowledge
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.businessKnowledgeDocumentsWindowList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/documents/{id}/window/`
|
|
8
|
+
- **What it does**: Read-only access to parsed knowledge documents. Exposes hybrid search
|
|
9
|
+
(``search``) and a drill-down window (``window``) so an agent (PHAI or
|
|
10
|
+
MCP) can find and explore business knowledge chunks.
|
|
11
|
+
- **OpenAPI operationId**: `business_knowledge_documents_window_list`
|
|
12
|
+
- **Path params**: `id`
|
|
13
|
+
- **Query params**: `around_ordinal`, `radius`
|
|
14
|
+
- **Response codes**: `200`
|
|
15
|
+
- **Transport options**: None
|
|
16
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
17
|
+
|
|
18
|
+
**Inputs**
|
|
19
|
+
|
|
20
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
21
|
+
- Client transport options: None
|
|
22
|
+
|
|
23
|
+
**Outputs**
|
|
24
|
+
|
|
25
|
+
- Client return type: `({ chunk_id: string; ordinal: number; content: string; heading_path: string; source_name: string; document_title: string })[]`
|
|
26
|
+
- OpenAPI response codes: `200`
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import posthog from "@utdk/posthog";
|
|
30
|
+
|
|
31
|
+
type BusinessKnowledgeDocumentsWindowListInput = Parameters<typeof posthog.businessKnowledgeDocumentsWindowList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
32
|
+
type BusinessKnowledgeDocumentsWindowListOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeDocumentsWindowList>>;
|
|
33
|
+
|
|
34
|
+
const result: BusinessKnowledgeDocumentsWindowListOutput = await posthog.businessKnowledgeDocumentsWindowList();
|
|
35
|
+
|
|
36
|
+
// Result shape (from schema): ({ chunk_id: string; ordinal: number; content: string; heading_path: string; source_name: string; document_title: string })[]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### `posthog.businessKnowledgeDocumentsSearchList`
|
|
40
|
+
|
|
41
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/documents/search/`
|
|
42
|
+
- **What it does**: Read-only access to parsed knowledge documents. Exposes hybrid search
|
|
43
|
+
(``search``) and a drill-down window (``window``) so an agent (PHAI or
|
|
44
|
+
MCP) can find and explore business knowledge chunks.
|
|
45
|
+
- **OpenAPI operationId**: `business_knowledge_documents_search_list`
|
|
46
|
+
- **Path params**: None
|
|
47
|
+
- **Query params**: `limit`, `query`, `rerank`
|
|
48
|
+
- **Response codes**: `200`
|
|
49
|
+
- **Transport options**: None
|
|
50
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
51
|
+
|
|
52
|
+
**Inputs**
|
|
53
|
+
|
|
54
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
55
|
+
- Client transport options: None
|
|
56
|
+
|
|
57
|
+
**Outputs**
|
|
58
|
+
|
|
59
|
+
- Client return type: `({ chunk_id: string; document_id: string; ordinal: number; source_id: string; source_name: string; source_type: string; document_title: string; heading_path: string; content: string })[]`
|
|
60
|
+
- OpenAPI response codes: `200`
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
import posthog from "@utdk/posthog";
|
|
64
|
+
|
|
65
|
+
type BusinessKnowledgeDocumentsSearchListInput = Parameters<typeof posthog.businessKnowledgeDocumentsSearchList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
66
|
+
type BusinessKnowledgeDocumentsSearchListOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeDocumentsSearchList>>;
|
|
67
|
+
|
|
68
|
+
const result: BusinessKnowledgeDocumentsSearchListOutput = await posthog.businessKnowledgeDocumentsSearchList();
|
|
69
|
+
|
|
70
|
+
// Result shape (from schema): ({ chunk_id: string; document_id: string; ordinal: number; source_id: string; source_name: string; source_type: string; document_title: string; heading_path: string; content: string })[]
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### `posthog.businessKnowledgeGapSuggestionsList`
|
|
74
|
+
|
|
75
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/gap_suggestions/`
|
|
76
|
+
- **What it does**: Surfaces topics the support AI couldn't answer from the knowledge base.
|
|
77
|
+
|
|
78
|
+
Two list shapes controlled by the ``ticket_id`` query param:
|
|
79
|
+
- **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket.
|
|
80
|
+
- **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts,
|
|
81
|
+
for the Business knowledge suggestions panel.
|
|
82
|
+
- **OpenAPI operationId**: `business_knowledge_gap_suggestions_list`
|
|
83
|
+
- **Path params**: None
|
|
84
|
+
- **Query params**: `limit`, `offset`, `ticket_id`
|
|
85
|
+
- **Response codes**: `200`
|
|
86
|
+
- **Transport options**: None
|
|
87
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
88
|
+
|
|
89
|
+
**Inputs**
|
|
90
|
+
|
|
91
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
92
|
+
- Client transport options: None
|
|
93
|
+
|
|
94
|
+
**Outputs**
|
|
95
|
+
|
|
96
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_...`
|
|
97
|
+
- OpenAPI response codes: `200`
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import posthog from "@utdk/posthog";
|
|
101
|
+
|
|
102
|
+
type BusinessKnowledgeGapSuggestionsListInput = Parameters<typeof posthog.businessKnowledgeGapSuggestionsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
103
|
+
type BusinessKnowledgeGapSuggestionsListOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeGapSuggestionsList>>;
|
|
104
|
+
|
|
105
|
+
const result: BusinessKnowledgeGapSuggestionsListOutput = await posthog.businessKnowledgeGapSuggestionsList();
|
|
106
|
+
|
|
107
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_...
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### `posthog.businessKnowledgeGapSuggestionsAcceptCreate`
|
|
111
|
+
|
|
112
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/gap_suggestions/{id}/accept/`
|
|
113
|
+
- **What it does**: Surfaces topics the support AI couldn't answer from the knowledge base.
|
|
114
|
+
|
|
115
|
+
Two list shapes controlled by the ``ticket_id`` query param:
|
|
116
|
+
- **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket.
|
|
117
|
+
- **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts,
|
|
118
|
+
for the Business knowledge suggestions panel.
|
|
119
|
+
- **OpenAPI operationId**: `business_knowledge_gap_suggestions_accept_create`
|
|
120
|
+
- **Path params**: `id`
|
|
121
|
+
- **Query params**: None
|
|
122
|
+
- **Response codes**: `200`
|
|
123
|
+
- **Transport options**: None
|
|
124
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
125
|
+
|
|
126
|
+
**Inputs**
|
|
127
|
+
|
|
128
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
129
|
+
- Client transport options: None
|
|
130
|
+
|
|
131
|
+
**Outputs**
|
|
132
|
+
|
|
133
|
+
- Client return type: `{ id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_id: string | null; created_at: string }`
|
|
134
|
+
- OpenAPI response codes: `200`
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import posthog from "@utdk/posthog";
|
|
138
|
+
|
|
139
|
+
type BusinessKnowledgeGapSuggestionsAcceptCreateInput = Parameters<typeof posthog.businessKnowledgeGapSuggestionsAcceptCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
140
|
+
type BusinessKnowledgeGapSuggestionsAcceptCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeGapSuggestionsAcceptCreate>>;
|
|
141
|
+
|
|
142
|
+
const result: BusinessKnowledgeGapSuggestionsAcceptCreateOutput = await posthog.businessKnowledgeGapSuggestionsAcceptCreate();
|
|
143
|
+
|
|
144
|
+
// Result shape (from schema): { id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_id: string | null; created_at: string }
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### `posthog.businessKnowledgeGapSuggestionsDismissCreate`
|
|
148
|
+
|
|
149
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/gap_suggestions/{id}/dismiss/`
|
|
150
|
+
- **What it does**: Surfaces topics the support AI couldn't answer from the knowledge base.
|
|
151
|
+
|
|
152
|
+
Two list shapes controlled by the ``ticket_id`` query param:
|
|
153
|
+
- **per-ticket** (``?ticket_id=<uuid>``): individual gap rows for that ticket.
|
|
154
|
+
- **aggregated** (no ``ticket_id``): gaps grouped by normalized topic with counts,
|
|
155
|
+
for the Business knowledge suggestions panel.
|
|
156
|
+
- **OpenAPI operationId**: `business_knowledge_gap_suggestions_dismiss_create`
|
|
157
|
+
- **Path params**: `id`
|
|
158
|
+
- **Query params**: None
|
|
159
|
+
- **Response codes**: `200`
|
|
160
|
+
- **Transport options**: None
|
|
161
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
162
|
+
|
|
163
|
+
**Inputs**
|
|
164
|
+
|
|
165
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
166
|
+
- Client transport options: None
|
|
167
|
+
|
|
168
|
+
**Outputs**
|
|
169
|
+
|
|
170
|
+
- Client return type: `{ id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_id: string | null; created_at: string }`
|
|
171
|
+
- OpenAPI response codes: `200`
|
|
172
|
+
|
|
173
|
+
```ts
|
|
174
|
+
import posthog from "@utdk/posthog";
|
|
175
|
+
|
|
176
|
+
type BusinessKnowledgeGapSuggestionsDismissCreateInput = Parameters<typeof posthog.businessKnowledgeGapSuggestionsDismissCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
177
|
+
type BusinessKnowledgeGapSuggestionsDismissCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeGapSuggestionsDismissCreate>>;
|
|
178
|
+
|
|
179
|
+
const result: BusinessKnowledgeGapSuggestionsDismissCreateOutput = await posthog.businessKnowledgeGapSuggestionsDismissCreate();
|
|
180
|
+
|
|
181
|
+
// Result shape (from schema): { id: string; ticket_id: string; topic: string; normalized_topic: string; ticket_type: string; outcome: string; status: string; resolved_source_id: string | null; created_at: string }
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### `posthog.businessKnowledgeGapSuggestionsAcceptTopicCreate`
|
|
185
|
+
|
|
186
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/gap_suggestions/accept_topic/`
|
|
187
|
+
- **What it does**: Accept all pending suggestions for a normalized topic cluster.
|
|
188
|
+
- **OpenAPI operationId**: `business_knowledge_gap_suggestions_accept_topic_create`
|
|
189
|
+
- **Path params**: None
|
|
190
|
+
- **Query params**: None
|
|
191
|
+
- **Response codes**: `200`
|
|
192
|
+
- **Transport options**: None
|
|
193
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
194
|
+
|
|
195
|
+
**Inputs**
|
|
196
|
+
|
|
197
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
198
|
+
- Client transport options: None
|
|
199
|
+
|
|
200
|
+
**Outputs**
|
|
201
|
+
|
|
202
|
+
- Client return type: `{ normalized_topic: string; updated: number }`
|
|
203
|
+
- OpenAPI response codes: `200`
|
|
204
|
+
|
|
205
|
+
```ts
|
|
206
|
+
import posthog from "@utdk/posthog";
|
|
207
|
+
|
|
208
|
+
type BusinessKnowledgeGapSuggestionsAcceptTopicCreateInput = Parameters<typeof posthog.businessKnowledgeGapSuggestionsAcceptTopicCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
209
|
+
type BusinessKnowledgeGapSuggestionsAcceptTopicCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeGapSuggestionsAcceptTopicCreate>>;
|
|
210
|
+
|
|
211
|
+
const result: BusinessKnowledgeGapSuggestionsAcceptTopicCreateOutput = await posthog.businessKnowledgeGapSuggestionsAcceptTopicCreate();
|
|
212
|
+
|
|
213
|
+
// Result shape (from schema): { normalized_topic: string; updated: number }
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
### `posthog.businessKnowledgeGapSuggestionsDismissTopicCreate`
|
|
217
|
+
|
|
218
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/gap_suggestions/dismiss_topic/`
|
|
219
|
+
- **What it does**: Dismiss all pending suggestions for a normalized topic cluster.
|
|
220
|
+
- **OpenAPI operationId**: `business_knowledge_gap_suggestions_dismiss_topic_create`
|
|
221
|
+
- **Path params**: None
|
|
222
|
+
- **Query params**: None
|
|
223
|
+
- **Response codes**: `200`
|
|
224
|
+
- **Transport options**: None
|
|
225
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
226
|
+
|
|
227
|
+
**Inputs**
|
|
228
|
+
|
|
229
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
230
|
+
- Client transport options: None
|
|
231
|
+
|
|
232
|
+
**Outputs**
|
|
233
|
+
|
|
234
|
+
- Client return type: `{ normalized_topic: string; updated: number }`
|
|
235
|
+
- OpenAPI response codes: `200`
|
|
236
|
+
|
|
237
|
+
```ts
|
|
238
|
+
import posthog from "@utdk/posthog";
|
|
239
|
+
|
|
240
|
+
type BusinessKnowledgeGapSuggestionsDismissTopicCreateInput = Parameters<typeof posthog.businessKnowledgeGapSuggestionsDismissTopicCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
241
|
+
type BusinessKnowledgeGapSuggestionsDismissTopicCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeGapSuggestionsDismissTopicCreate>>;
|
|
242
|
+
|
|
243
|
+
const result: BusinessKnowledgeGapSuggestionsDismissTopicCreateOutput = await posthog.businessKnowledgeGapSuggestionsDismissTopicCreate();
|
|
244
|
+
|
|
245
|
+
// Result shape (from schema): { normalized_topic: string; updated: number }
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### `posthog.businessKnowledgeSourcesList`
|
|
249
|
+
|
|
250
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/sources/`
|
|
251
|
+
- **OpenAPI operationId**: `business_knowledge_sources_list`
|
|
252
|
+
- **Path params**: None
|
|
253
|
+
- **Query params**: `limit`, `offset`
|
|
254
|
+
- **Response codes**: `200`
|
|
255
|
+
- **Transport options**: None
|
|
256
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
257
|
+
|
|
258
|
+
**Inputs**
|
|
259
|
+
|
|
260
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
261
|
+
- Client transport options: None
|
|
262
|
+
|
|
263
|
+
**Outputs**
|
|
264
|
+
|
|
265
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_m...`
|
|
266
|
+
- OpenAPI response codes: `200`
|
|
267
|
+
|
|
268
|
+
```ts
|
|
269
|
+
import posthog from "@utdk/posthog";
|
|
270
|
+
|
|
271
|
+
type BusinessKnowledgeSourcesListInput = Parameters<typeof posthog.businessKnowledgeSourcesList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
272
|
+
type BusinessKnowledgeSourcesListOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesList>>;
|
|
273
|
+
|
|
274
|
+
const result: BusinessKnowledgeSourcesListOutput = await posthog.businessKnowledgeSourcesList();
|
|
275
|
+
|
|
276
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_m...
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### `posthog.businessKnowledgeSourcesCreate`
|
|
280
|
+
|
|
281
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/sources/`
|
|
282
|
+
- **OpenAPI operationId**: `business_knowledge_sources_create`
|
|
283
|
+
- **Path params**: None
|
|
284
|
+
- **Query params**: None
|
|
285
|
+
- **Response codes**: `201`
|
|
286
|
+
- **Transport options**: None
|
|
287
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
288
|
+
|
|
289
|
+
**Inputs**
|
|
290
|
+
|
|
291
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
292
|
+
- Client transport options: None
|
|
293
|
+
|
|
294
|
+
**Outputs**
|
|
295
|
+
|
|
296
|
+
- Client return type: `{ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...`
|
|
297
|
+
- OpenAPI response codes: `201`
|
|
298
|
+
|
|
299
|
+
```ts
|
|
300
|
+
import posthog from "@utdk/posthog";
|
|
301
|
+
|
|
302
|
+
type BusinessKnowledgeSourcesCreateInput = Parameters<typeof posthog.businessKnowledgeSourcesCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
303
|
+
type BusinessKnowledgeSourcesCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesCreate>>;
|
|
304
|
+
|
|
305
|
+
const result: BusinessKnowledgeSourcesCreateOutput = await posthog.businessKnowledgeSourcesCreate();
|
|
306
|
+
|
|
307
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
### `posthog.businessKnowledgeSourcesDestroy`
|
|
311
|
+
|
|
312
|
+
- **HTTP**: `DELETE /api/projects/{project_id}/business_knowledge/sources/{id}/`
|
|
313
|
+
- **OpenAPI operationId**: `business_knowledge_sources_destroy`
|
|
314
|
+
- **Path params**: `id`
|
|
315
|
+
- **Query params**: None
|
|
316
|
+
- **Response codes**: `204`
|
|
317
|
+
- **Transport options**: None
|
|
318
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
319
|
+
|
|
320
|
+
**Inputs**
|
|
321
|
+
|
|
322
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
323
|
+
- Client transport options: None
|
|
324
|
+
|
|
325
|
+
**Outputs**
|
|
326
|
+
|
|
327
|
+
- Client return type: `unknown`
|
|
328
|
+
- OpenAPI response codes: `204`
|
|
329
|
+
|
|
330
|
+
```ts
|
|
331
|
+
import posthog from "@utdk/posthog";
|
|
332
|
+
|
|
333
|
+
type BusinessKnowledgeSourcesDestroyInput = Parameters<typeof posthog.businessKnowledgeSourcesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
|
|
334
|
+
type BusinessKnowledgeSourcesDestroyOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesDestroy>>;
|
|
335
|
+
|
|
336
|
+
const result: BusinessKnowledgeSourcesDestroyOutput = await posthog.businessKnowledgeSourcesDestroy();
|
|
337
|
+
|
|
338
|
+
// Result shape (from schema): unknown
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### `posthog.businessKnowledgeSourcesRetrieve`
|
|
342
|
+
|
|
343
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/sources/{id}/`
|
|
344
|
+
- **OpenAPI operationId**: `business_knowledge_sources_retrieve`
|
|
345
|
+
- **Path params**: `id`
|
|
346
|
+
- **Query params**: None
|
|
347
|
+
- **Response codes**: `200`
|
|
348
|
+
- **Transport options**: None
|
|
349
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
350
|
+
|
|
351
|
+
**Inputs**
|
|
352
|
+
|
|
353
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
354
|
+
- Client transport options: None
|
|
355
|
+
|
|
356
|
+
**Outputs**
|
|
357
|
+
|
|
358
|
+
- Client return type: `{ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...`
|
|
359
|
+
- OpenAPI response codes: `200`
|
|
360
|
+
|
|
361
|
+
```ts
|
|
362
|
+
import posthog from "@utdk/posthog";
|
|
363
|
+
|
|
364
|
+
type BusinessKnowledgeSourcesRetrieveInput = Parameters<typeof posthog.businessKnowledgeSourcesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
365
|
+
type BusinessKnowledgeSourcesRetrieveOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesRetrieve>>;
|
|
366
|
+
|
|
367
|
+
const result: BusinessKnowledgeSourcesRetrieveOutput = await posthog.businessKnowledgeSourcesRetrieve();
|
|
368
|
+
|
|
369
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### `posthog.businessKnowledgeSourcesPartialUpdate`
|
|
373
|
+
|
|
374
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/business_knowledge/sources/{id}/`
|
|
375
|
+
- **OpenAPI operationId**: `business_knowledge_sources_partial_update`
|
|
376
|
+
- **Path params**: `id`
|
|
377
|
+
- **Query params**: None
|
|
378
|
+
- **Response codes**: `200`
|
|
379
|
+
- **Transport options**: None
|
|
380
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
381
|
+
|
|
382
|
+
**Inputs**
|
|
383
|
+
|
|
384
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
385
|
+
- Client transport options: None
|
|
386
|
+
|
|
387
|
+
**Outputs**
|
|
388
|
+
|
|
389
|
+
- Client return type: `{ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...`
|
|
390
|
+
- OpenAPI response codes: `200`
|
|
391
|
+
|
|
392
|
+
```ts
|
|
393
|
+
import posthog from "@utdk/posthog";
|
|
394
|
+
|
|
395
|
+
type BusinessKnowledgeSourcesPartialUpdateInput = Parameters<typeof posthog.businessKnowledgeSourcesPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
396
|
+
type BusinessKnowledgeSourcesPartialUpdateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesPartialUpdate>>;
|
|
397
|
+
|
|
398
|
+
const result: BusinessKnowledgeSourcesPartialUpdateOutput = await posthog.businessKnowledgeSourcesPartialUpdate();
|
|
399
|
+
|
|
400
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### `posthog.businessKnowledgeSourcesRefreshCreate`
|
|
404
|
+
|
|
405
|
+
- **HTTP**: `POST /api/projects/{project_id}/business_knowledge/sources/{id}/refresh/`
|
|
406
|
+
- **OpenAPI operationId**: `business_knowledge_sources_refresh_create`
|
|
407
|
+
- **Path params**: `id`
|
|
408
|
+
- **Query params**: None
|
|
409
|
+
- **Response codes**: `200`
|
|
410
|
+
- **Transport options**: None
|
|
411
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
412
|
+
|
|
413
|
+
**Inputs**
|
|
414
|
+
|
|
415
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
416
|
+
- Client transport options: None
|
|
417
|
+
|
|
418
|
+
**Outputs**
|
|
419
|
+
|
|
420
|
+
- Client return type: `{ id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...`
|
|
421
|
+
- OpenAPI response codes: `200`
|
|
422
|
+
|
|
423
|
+
```ts
|
|
424
|
+
import posthog from "@utdk/posthog";
|
|
425
|
+
|
|
426
|
+
type BusinessKnowledgeSourcesRefreshCreateInput = Parameters<typeof posthog.businessKnowledgeSourcesRefreshCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
427
|
+
type BusinessKnowledgeSourcesRefreshCreateOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesRefreshCreate>>;
|
|
428
|
+
|
|
429
|
+
const result: BusinessKnowledgeSourcesRefreshCreateOutput = await posthog.businessKnowledgeSourcesRefreshCreate();
|
|
430
|
+
|
|
431
|
+
// Result shape (from schema): { id: string; team_id: number; name: string; source_type: "text" | "url" | "file"; status: "pending" | "processing" | "ready" | "error"; error_message: string; document_count: number; chunk_count: number; created_at: st...
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### `posthog.businessKnowledgeSourcesTextRetrieve`
|
|
435
|
+
|
|
436
|
+
- **HTTP**: `GET /api/projects/{project_id}/business_knowledge/sources/{id}/text/`
|
|
437
|
+
- **OpenAPI operationId**: `business_knowledge_sources_text_retrieve`
|
|
438
|
+
- **Path params**: `id`
|
|
439
|
+
- **Query params**: None
|
|
440
|
+
- **Response codes**: `200`
|
|
441
|
+
- **Transport options**: None
|
|
442
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
443
|
+
|
|
444
|
+
**Inputs**
|
|
445
|
+
|
|
446
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
447
|
+
- Client transport options: None
|
|
448
|
+
|
|
449
|
+
**Outputs**
|
|
450
|
+
|
|
451
|
+
- Client return type: `{ text?: string }`
|
|
452
|
+
- OpenAPI response codes: `200`
|
|
453
|
+
|
|
454
|
+
```ts
|
|
455
|
+
import posthog from "@utdk/posthog";
|
|
456
|
+
|
|
457
|
+
type BusinessKnowledgeSourcesTextRetrieveInput = Parameters<typeof posthog.businessKnowledgeSourcesTextRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
458
|
+
type BusinessKnowledgeSourcesTextRetrieveOutput = Awaited<ReturnType<typeof posthog.businessKnowledgeSourcesTextRetrieve>>;
|
|
459
|
+
|
|
460
|
+
const result: BusinessKnowledgeSourcesTextRetrieveOutput = await posthog.businessKnowledgeSourcesTextRetrieve();
|
|
461
|
+
|
|
462
|
+
// Result shape (from schema): { text?: string }
|
|
463
|
+
```
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<!-- prompt-hash:
|
|
467
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
468
|
+
-->
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# Code Invites
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.codeInvitesCheckAccessRetrieve`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/code/invites/check-access/`
|
|
8
|
+
- **What it does**: Check access
|
|
9
|
+
- **OpenAPI operationId**: `code_invites_check_access_retrieve`
|
|
10
|
+
- **Path params**: None
|
|
11
|
+
- **Query params**: None
|
|
12
|
+
- **Response codes**: `200`
|
|
13
|
+
- **Transport options**: None
|
|
14
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
15
|
+
|
|
16
|
+
**Inputs**
|
|
17
|
+
|
|
18
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
19
|
+
- Client transport options: None
|
|
20
|
+
|
|
21
|
+
**Outputs**
|
|
22
|
+
|
|
23
|
+
- Client return type: `unknown`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type CodeInvitesCheckAccessRetrieveInput = Parameters<typeof posthog.codeInvitesCheckAccessRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type CodeInvitesCheckAccessRetrieveOutput = Awaited<ReturnType<typeof posthog.codeInvitesCheckAccessRetrieve>>;
|
|
31
|
+
|
|
32
|
+
const result: CodeInvitesCheckAccessRetrieveOutput = await posthog.codeInvitesCheckAccessRetrieve();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): unknown
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.codeInvitesRedeemCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/code/invites/redeem/`
|
|
40
|
+
- **What it does**: Redeem invite code
|
|
41
|
+
- **OpenAPI operationId**: `code_invites_redeem_create`
|
|
42
|
+
- **Path params**: None
|
|
43
|
+
- **Query params**: None
|
|
44
|
+
- **Response codes**: `200`, `400`
|
|
45
|
+
- **Transport options**: None
|
|
46
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
47
|
+
|
|
48
|
+
**Inputs**
|
|
49
|
+
|
|
50
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
51
|
+
- Client transport options: None
|
|
52
|
+
|
|
53
|
+
**Outputs**
|
|
54
|
+
|
|
55
|
+
- Client return type: `unknown`
|
|
56
|
+
- OpenAPI response codes: `200`, `400`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type CodeInvitesRedeemCreateInput = Parameters<typeof posthog.codeInvitesRedeemCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type CodeInvitesRedeemCreateOutput = Awaited<ReturnType<typeof posthog.codeInvitesRedeemCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: CodeInvitesRedeemCreateOutput = await posthog.codeInvitesRedeemCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): unknown
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
<!-- prompt-hash:
|
|
71
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
72
|
+
-->
|