@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.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
@@ -0,0 +1,634 @@
1
+ # Subscriptions
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsSubscriptionsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/subscriptions/`
8
+ - **OpenAPI operationId**: `environments_subscriptions_list`
9
+ - **Path params**: None
10
+ - **Query params**: `created_by`, `dashboard`, `dashboard_tiles`, `insight`, `insights`, `limit`, `offset`, `ordering`, `resource_type`, `search`, `target_type`
11
+ - **Response codes**: `200`
12
+ - **Transport options**: None
13
+ - **TypeScript**: [Client interface](../types.ts)
14
+
15
+ **Inputs**
16
+
17
+ - Client input type: `{ [key: string]: unknown }`
18
+ - Client transport options: None
19
+
20
+ **Outputs**
21
+
22
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsSubscriptionsListInput = Parameters<typeof posthog.environmentsSubscriptionsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsSubscriptionsListOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsList>>;
30
+
31
+ const result: EnvironmentsSubscriptionsListOutput = await posthog.environmentsSubscriptionsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string...
34
+ ```
35
+
36
+ ### `posthog.environmentsSubscriptionsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/subscriptions/`
39
+ - **OpenAPI operationId**: `environments_subscriptions_create`
40
+ - **Path params**: None
41
+ - **Query params**: None
42
+ - **Response codes**: `201`
43
+ - **Transport options**: None
44
+ - **TypeScript**: [Client interface](../types.ts)
45
+
46
+ **Inputs**
47
+
48
+ - Client input type: `{ [key: string]: unknown }`
49
+ - Client transport options: None
50
+
51
+ **Outputs**
52
+
53
+ - Client return type: `{ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
54
+ - OpenAPI response codes: `201`
55
+
56
+ ```ts
57
+ import posthog from "@utdk/posthog";
58
+
59
+ type EnvironmentsSubscriptionsCreateInput = Parameters<typeof posthog.environmentsSubscriptionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
60
+ type EnvironmentsSubscriptionsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsCreate>>;
61
+
62
+ const result: EnvironmentsSubscriptionsCreateOutput = await posthog.environmentsSubscriptionsCreate();
63
+
64
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
65
+ ```
66
+
67
+ ### `posthog.environmentsSubscriptionsDestroy`
68
+
69
+ - **HTTP**: `DELETE /api/environments/{environment_id}/subscriptions/{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_subscriptions_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 EnvironmentsSubscriptionsDestroyInput = Parameters<typeof posthog.environmentsSubscriptionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
92
+ type EnvironmentsSubscriptionsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsDestroy>>;
93
+
94
+ const result: EnvironmentsSubscriptionsDestroyOutput = await posthog.environmentsSubscriptionsDestroy();
95
+
96
+ // Result shape (from schema): unknown
97
+ ```
98
+
99
+ ### `posthog.environmentsSubscriptionsRetrieve`
100
+
101
+ - **HTTP**: `GET /api/environments/{environment_id}/subscriptions/{id}/`
102
+ - **OpenAPI operationId**: `environments_subscriptions_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: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
117
+ - OpenAPI response codes: `200`
118
+
119
+ ```ts
120
+ import posthog from "@utdk/posthog";
121
+
122
+ type EnvironmentsSubscriptionsRetrieveInput = Parameters<typeof posthog.environmentsSubscriptionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
123
+ type EnvironmentsSubscriptionsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsRetrieve>>;
124
+
125
+ const result: EnvironmentsSubscriptionsRetrieveOutput = await posthog.environmentsSubscriptionsRetrieve();
126
+
127
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
128
+ ```
129
+
130
+ ### `posthog.environmentsSubscriptionsPartialUpdate`
131
+
132
+ - **HTTP**: `PATCH /api/environments/{environment_id}/subscriptions/{id}/`
133
+ - **OpenAPI operationId**: `environments_subscriptions_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: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
148
+ - OpenAPI response codes: `200`
149
+
150
+ ```ts
151
+ import posthog from "@utdk/posthog";
152
+
153
+ type EnvironmentsSubscriptionsPartialUpdateInput = Parameters<typeof posthog.environmentsSubscriptionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
154
+ type EnvironmentsSubscriptionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsPartialUpdate>>;
155
+
156
+ const result: EnvironmentsSubscriptionsPartialUpdateOutput = await posthog.environmentsSubscriptionsPartialUpdate();
157
+
158
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
159
+ ```
160
+
161
+ ### `posthog.environmentsSubscriptionsUpdate`
162
+
163
+ - **HTTP**: `PUT /api/environments/{environment_id}/subscriptions/{id}/`
164
+ - **OpenAPI operationId**: `environments_subscriptions_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: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
179
+ - OpenAPI response codes: `200`
180
+
181
+ ```ts
182
+ import posthog from "@utdk/posthog";
183
+
184
+ type EnvironmentsSubscriptionsUpdateInput = Parameters<typeof posthog.environmentsSubscriptionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
185
+ type EnvironmentsSubscriptionsUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsUpdate>>;
186
+
187
+ const result: EnvironmentsSubscriptionsUpdateOutput = await posthog.environmentsSubscriptionsUpdate();
188
+
189
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
190
+ ```
191
+
192
+ ### `posthog.environmentsSubscriptionsTestDeliveryCreate`
193
+
194
+ - **HTTP**: `POST /api/environments/{environment_id}/subscriptions/{id}/test-delivery/`
195
+ - **OpenAPI operationId**: `environments_subscriptions_test_delivery_create`
196
+ - **Path params**: `id`
197
+ - **Query params**: None
198
+ - **Response codes**: `202`
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: `unknown`
210
+ - OpenAPI response codes: `202`
211
+
212
+ ```ts
213
+ import posthog from "@utdk/posthog";
214
+
215
+ type EnvironmentsSubscriptionsTestDeliveryCreateInput = Parameters<typeof posthog.environmentsSubscriptionsTestDeliveryCreate> extends [infer T, ...unknown[]] ? T : undefined;
216
+ type EnvironmentsSubscriptionsTestDeliveryCreateOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsTestDeliveryCreate>>;
217
+
218
+ const result: EnvironmentsSubscriptionsTestDeliveryCreateOutput = await posthog.environmentsSubscriptionsTestDeliveryCreate();
219
+
220
+ // Result shape (from schema): unknown
221
+ ```
222
+
223
+ ### `posthog.environmentsSubscriptionsDeliveriesList`
224
+
225
+ - **HTTP**: `GET /api/environments/{environment_id}/subscriptions/{subscription_id}/deliveries/`
226
+ - **What it does**: List subscription deliveries
227
+ - **OpenAPI operationId**: `environments_subscriptions_deliveries_list`
228
+ - **Path params**: `subscription_id`
229
+ - **Query params**: `cursor`, `status`
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: `{ next?: string | null; previous?: string | null; results: ({ id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: stri...`
242
+ - OpenAPI response codes: `200`
243
+
244
+ ```ts
245
+ import posthog from "@utdk/posthog";
246
+
247
+ type EnvironmentsSubscriptionsDeliveriesListInput = Parameters<typeof posthog.environmentsSubscriptionsDeliveriesList> extends [infer T, ...unknown[]] ? T : undefined;
248
+ type EnvironmentsSubscriptionsDeliveriesListOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsDeliveriesList>>;
249
+
250
+ const result: EnvironmentsSubscriptionsDeliveriesListOutput = await posthog.environmentsSubscriptionsDeliveriesList();
251
+
252
+ // Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: stri...
253
+ ```
254
+
255
+ ### `posthog.environmentsSubscriptionsDeliveriesRetrieve`
256
+
257
+ - **HTTP**: `GET /api/environments/{environment_id}/subscriptions/{subscription_id}/deliveries/{id}/`
258
+ - **What it does**: Retrieve subscription delivery
259
+ - **OpenAPI operationId**: `environments_subscriptions_deliveries_retrieve`
260
+ - **Path params**: `id`, `subscription_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; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: string; target_value: string; exported_asset_ids: (number)[]; co...`
274
+ - OpenAPI response codes: `200`
275
+
276
+ ```ts
277
+ import posthog from "@utdk/posthog";
278
+
279
+ type EnvironmentsSubscriptionsDeliveriesRetrieveInput = Parameters<typeof posthog.environmentsSubscriptionsDeliveriesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
280
+ type EnvironmentsSubscriptionsDeliveriesRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsDeliveriesRetrieve>>;
281
+
282
+ const result: EnvironmentsSubscriptionsDeliveriesRetrieveOutput = await posthog.environmentsSubscriptionsDeliveriesRetrieve();
283
+
284
+ // Result shape (from schema): { id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: string; target_value: string; exported_asset_ids: (number)[]; co...
285
+ ```
286
+
287
+ ### `posthog.environmentsSubscriptionsSummaryQuotaRetrieve`
288
+
289
+ - **HTTP**: `GET /api/environments/{environment_id}/subscriptions/summary_quota/`
290
+ - **OpenAPI operationId**: `environments_subscriptions_summary_quota_retrieve`
291
+ - **Path params**: None
292
+ - **Query params**: None
293
+ - **Response codes**: `200`
294
+ - **Transport options**: None
295
+ - **TypeScript**: [Client interface](../types.ts)
296
+
297
+ **Inputs**
298
+
299
+ - Client input type: `{ [key: string]: unknown }`
300
+ - Client transport options: None
301
+
302
+ **Outputs**
303
+
304
+ - Client return type: `{ active_count: number; limit: number | null; at_limit: boolean }`
305
+ - OpenAPI response codes: `200`
306
+
307
+ ```ts
308
+ import posthog from "@utdk/posthog";
309
+
310
+ type EnvironmentsSubscriptionsSummaryQuotaRetrieveInput = Parameters<typeof posthog.environmentsSubscriptionsSummaryQuotaRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
311
+ type EnvironmentsSubscriptionsSummaryQuotaRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsSubscriptionsSummaryQuotaRetrieve>>;
312
+
313
+ const result: EnvironmentsSubscriptionsSummaryQuotaRetrieveOutput = await posthog.environmentsSubscriptionsSummaryQuotaRetrieve();
314
+
315
+ // Result shape (from schema): { active_count: number; limit: number | null; at_limit: boolean }
316
+ ```
317
+
318
+ ### `posthog.subscriptionsList`
319
+
320
+ - **HTTP**: `GET /api/projects/{project_id}/subscriptions/`
321
+ - **OpenAPI operationId**: `subscriptions_list`
322
+ - **Path params**: None
323
+ - **Query params**: `created_by`, `dashboard`, `dashboard_tiles`, `insight`, `insights`, `limit`, `offset`, `ordering`, `resource_type`, `search`, `target_type`
324
+ - **Response codes**: `200`
325
+ - **Transport options**: None
326
+ - **TypeScript**: [Client interface](../types.ts)
327
+
328
+ **Inputs**
329
+
330
+ - Client input type: `{ [key: string]: unknown }`
331
+ - Client transport options: None
332
+
333
+ **Outputs**
334
+
335
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string...`
336
+ - OpenAPI response codes: `200`
337
+
338
+ ```ts
339
+ import posthog from "@utdk/posthog";
340
+
341
+ type SubscriptionsListInput = Parameters<typeof posthog.subscriptionsList> extends [infer T, ...unknown[]] ? T : undefined;
342
+ type SubscriptionsListOutput = Awaited<ReturnType<typeof posthog.subscriptionsList>>;
343
+
344
+ const result: SubscriptionsListOutput = await posthog.subscriptionsList();
345
+
346
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string...
347
+ ```
348
+
349
+ ### `posthog.subscriptionsCreate`
350
+
351
+ - **HTTP**: `POST /api/projects/{project_id}/subscriptions/`
352
+ - **OpenAPI operationId**: `subscriptions_create`
353
+ - **Path params**: None
354
+ - **Query params**: None
355
+ - **Response codes**: `201`
356
+ - **Transport options**: None
357
+ - **TypeScript**: [Client interface](../types.ts)
358
+
359
+ **Inputs**
360
+
361
+ - Client input type: `{ [key: string]: unknown }`
362
+ - Client transport options: None
363
+
364
+ **Outputs**
365
+
366
+ - Client return type: `{ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
367
+ - OpenAPI response codes: `201`
368
+
369
+ ```ts
370
+ import posthog from "@utdk/posthog";
371
+
372
+ type SubscriptionsCreateInput = Parameters<typeof posthog.subscriptionsCreate> extends [infer T, ...unknown[]] ? T : undefined;
373
+ type SubscriptionsCreateOutput = Awaited<ReturnType<typeof posthog.subscriptionsCreate>>;
374
+
375
+ const result: SubscriptionsCreateOutput = await posthog.subscriptionsCreate();
376
+
377
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
378
+ ```
379
+
380
+ ### `posthog.subscriptionsDestroy`
381
+
382
+ - **HTTP**: `DELETE /api/projects/{project_id}/subscriptions/{id}/`
383
+ - **What it does**: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
384
+ - **OpenAPI operationId**: `subscriptions_destroy`
385
+ - **Path params**: `id`
386
+ - **Query params**: None
387
+ - **Response codes**: `405`
388
+ - **Transport options**: None
389
+ - **TypeScript**: [Client interface](../types.ts)
390
+
391
+ **Inputs**
392
+
393
+ - Client input type: `{ [key: string]: unknown }`
394
+ - Client transport options: None
395
+
396
+ **Outputs**
397
+
398
+ - Client return type: `unknown`
399
+ - OpenAPI response codes: `405`
400
+
401
+ ```ts
402
+ import posthog from "@utdk/posthog";
403
+
404
+ type SubscriptionsDestroyInput = Parameters<typeof posthog.subscriptionsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
405
+ type SubscriptionsDestroyOutput = Awaited<ReturnType<typeof posthog.subscriptionsDestroy>>;
406
+
407
+ const result: SubscriptionsDestroyOutput = await posthog.subscriptionsDestroy();
408
+
409
+ // Result shape (from schema): unknown
410
+ ```
411
+
412
+ ### `posthog.subscriptionsRetrieve`
413
+
414
+ - **HTTP**: `GET /api/projects/{project_id}/subscriptions/{id}/`
415
+ - **OpenAPI operationId**: `subscriptions_retrieve`
416
+ - **Path params**: `id`
417
+ - **Query params**: None
418
+ - **Response codes**: `200`
419
+ - **Transport options**: None
420
+ - **TypeScript**: [Client interface](../types.ts)
421
+
422
+ **Inputs**
423
+
424
+ - Client input type: `{ [key: string]: unknown }`
425
+ - Client transport options: None
426
+
427
+ **Outputs**
428
+
429
+ - Client return type: `{ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
430
+ - OpenAPI response codes: `200`
431
+
432
+ ```ts
433
+ import posthog from "@utdk/posthog";
434
+
435
+ type SubscriptionsRetrieveInput = Parameters<typeof posthog.subscriptionsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
436
+ type SubscriptionsRetrieveOutput = Awaited<ReturnType<typeof posthog.subscriptionsRetrieve>>;
437
+
438
+ const result: SubscriptionsRetrieveOutput = await posthog.subscriptionsRetrieve();
439
+
440
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
441
+ ```
442
+
443
+ ### `posthog.subscriptionsPartialUpdate`
444
+
445
+ - **HTTP**: `PATCH /api/projects/{project_id}/subscriptions/{id}/`
446
+ - **OpenAPI operationId**: `subscriptions_partial_update`
447
+ - **Path params**: `id`
448
+ - **Query params**: None
449
+ - **Response codes**: `200`
450
+ - **Transport options**: None
451
+ - **TypeScript**: [Client interface](../types.ts)
452
+
453
+ **Inputs**
454
+
455
+ - Client input type: `{ [key: string]: unknown }`
456
+ - Client transport options: None
457
+
458
+ **Outputs**
459
+
460
+ - Client return type: `{ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
461
+ - OpenAPI response codes: `200`
462
+
463
+ ```ts
464
+ import posthog from "@utdk/posthog";
465
+
466
+ type SubscriptionsPartialUpdateInput = Parameters<typeof posthog.subscriptionsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
467
+ type SubscriptionsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.subscriptionsPartialUpdate>>;
468
+
469
+ const result: SubscriptionsPartialUpdateOutput = await posthog.subscriptionsPartialUpdate();
470
+
471
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
472
+ ```
473
+
474
+ ### `posthog.subscriptionsUpdate`
475
+
476
+ - **HTTP**: `PUT /api/projects/{project_id}/subscriptions/{id}/`
477
+ - **OpenAPI operationId**: `subscriptions_update`
478
+ - **Path params**: `id`
479
+ - **Query params**: None
480
+ - **Response codes**: `200`
481
+ - **Transport options**: None
482
+ - **TypeScript**: [Client interface](../types.ts)
483
+
484
+ **Inputs**
485
+
486
+ - Client input type: `{ [key: string]: unknown }`
487
+ - Client transport options: None
488
+
489
+ **Outputs**
490
+
491
+ - Client return type: `{ id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...`
492
+ - OpenAPI response codes: `200`
493
+
494
+ ```ts
495
+ import posthog from "@utdk/posthog";
496
+
497
+ type SubscriptionsUpdateInput = Parameters<typeof posthog.subscriptionsUpdate> extends [infer T, ...unknown[]] ? T : undefined;
498
+ type SubscriptionsUpdateOutput = Awaited<ReturnType<typeof posthog.subscriptionsUpdate>>;
499
+
500
+ const result: SubscriptionsUpdateOutput = await posthog.subscriptionsUpdate();
501
+
502
+ // Result shape (from schema): { id: number; resource_type: "insight" | "dashboard" | "ai_prompt"; dashboard?: number | null; insight?: number | null; insight_short_id: string | null; resource_name: string | null; dashboard_export_insights?: (number)...
503
+ ```
504
+
505
+ ### `posthog.subscriptionsTestDeliveryCreate`
506
+
507
+ - **HTTP**: `POST /api/projects/{project_id}/subscriptions/{id}/test-delivery/`
508
+ - **OpenAPI operationId**: `subscriptions_test_delivery_create`
509
+ - **Path params**: `id`
510
+ - **Query params**: None
511
+ - **Response codes**: `202`
512
+ - **Transport options**: None
513
+ - **TypeScript**: [Client interface](../types.ts)
514
+
515
+ **Inputs**
516
+
517
+ - Client input type: `{ [key: string]: unknown }`
518
+ - Client transport options: None
519
+
520
+ **Outputs**
521
+
522
+ - Client return type: `unknown`
523
+ - OpenAPI response codes: `202`
524
+
525
+ ```ts
526
+ import posthog from "@utdk/posthog";
527
+
528
+ type SubscriptionsTestDeliveryCreateInput = Parameters<typeof posthog.subscriptionsTestDeliveryCreate> extends [infer T, ...unknown[]] ? T : undefined;
529
+ type SubscriptionsTestDeliveryCreateOutput = Awaited<ReturnType<typeof posthog.subscriptionsTestDeliveryCreate>>;
530
+
531
+ const result: SubscriptionsTestDeliveryCreateOutput = await posthog.subscriptionsTestDeliveryCreate();
532
+
533
+ // Result shape (from schema): unknown
534
+ ```
535
+
536
+ ### `posthog.subscriptionsDeliveriesList`
537
+
538
+ - **HTTP**: `GET /api/projects/{project_id}/subscriptions/{subscription_id}/deliveries/`
539
+ - **What it does**: List subscription deliveries
540
+ - **OpenAPI operationId**: `subscriptions_deliveries_list`
541
+ - **Path params**: `subscription_id`
542
+ - **Query params**: `cursor`, `status`
543
+ - **Response codes**: `200`
544
+ - **Transport options**: None
545
+ - **TypeScript**: [Client interface](../types.ts)
546
+
547
+ **Inputs**
548
+
549
+ - Client input type: `{ [key: string]: unknown }`
550
+ - Client transport options: None
551
+
552
+ **Outputs**
553
+
554
+ - Client return type: `{ next?: string | null; previous?: string | null; results: ({ id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: stri...`
555
+ - OpenAPI response codes: `200`
556
+
557
+ ```ts
558
+ import posthog from "@utdk/posthog";
559
+
560
+ type SubscriptionsDeliveriesListInput = Parameters<typeof posthog.subscriptionsDeliveriesList> extends [infer T, ...unknown[]] ? T : undefined;
561
+ type SubscriptionsDeliveriesListOutput = Awaited<ReturnType<typeof posthog.subscriptionsDeliveriesList>>;
562
+
563
+ const result: SubscriptionsDeliveriesListOutput = await posthog.subscriptionsDeliveriesList();
564
+
565
+ // Result shape (from schema): { next?: string | null; previous?: string | null; results: ({ id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: stri...
566
+ ```
567
+
568
+ ### `posthog.subscriptionsDeliveriesRetrieve`
569
+
570
+ - **HTTP**: `GET /api/projects/{project_id}/subscriptions/{subscription_id}/deliveries/{id}/`
571
+ - **What it does**: Retrieve subscription delivery
572
+ - **OpenAPI operationId**: `subscriptions_deliveries_retrieve`
573
+ - **Path params**: `id`, `subscription_id`
574
+ - **Query params**: None
575
+ - **Response codes**: `200`
576
+ - **Transport options**: None
577
+ - **TypeScript**: [Client interface](../types.ts)
578
+
579
+ **Inputs**
580
+
581
+ - Client input type: `{ [key: string]: unknown }`
582
+ - Client transport options: None
583
+
584
+ **Outputs**
585
+
586
+ - Client return type: `{ id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: string; target_value: string; exported_asset_ids: (number)[]; co...`
587
+ - OpenAPI response codes: `200`
588
+
589
+ ```ts
590
+ import posthog from "@utdk/posthog";
591
+
592
+ type SubscriptionsDeliveriesRetrieveInput = Parameters<typeof posthog.subscriptionsDeliveriesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
593
+ type SubscriptionsDeliveriesRetrieveOutput = Awaited<ReturnType<typeof posthog.subscriptionsDeliveriesRetrieve>>;
594
+
595
+ const result: SubscriptionsDeliveriesRetrieveOutput = await posthog.subscriptionsDeliveriesRetrieve();
596
+
597
+ // Result shape (from schema): { id: string; subscription: number; temporal_workflow_id: string; idempotency_key: string; trigger_type: string; scheduled_at: string | null; target_type: string; target_value: string; exported_asset_ids: (number)[]; co...
598
+ ```
599
+
600
+ ### `posthog.subscriptionsSummaryQuotaRetrieve`
601
+
602
+ - **HTTP**: `GET /api/projects/{project_id}/subscriptions/summary_quota/`
603
+ - **OpenAPI operationId**: `subscriptions_summary_quota_retrieve`
604
+ - **Path params**: None
605
+ - **Query params**: None
606
+ - **Response codes**: `200`
607
+ - **Transport options**: None
608
+ - **TypeScript**: [Client interface](../types.ts)
609
+
610
+ **Inputs**
611
+
612
+ - Client input type: `{ [key: string]: unknown }`
613
+ - Client transport options: None
614
+
615
+ **Outputs**
616
+
617
+ - Client return type: `{ active_count: number; limit: number | null; at_limit: boolean }`
618
+ - OpenAPI response codes: `200`
619
+
620
+ ```ts
621
+ import posthog from "@utdk/posthog";
622
+
623
+ type SubscriptionsSummaryQuotaRetrieveInput = Parameters<typeof posthog.subscriptionsSummaryQuotaRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
624
+ type SubscriptionsSummaryQuotaRetrieveOutput = Awaited<ReturnType<typeof posthog.subscriptionsSummaryQuotaRetrieve>>;
625
+
626
+ const result: SubscriptionsSummaryQuotaRetrieveOutput = await posthog.subscriptionsSummaryQuotaRetrieve();
627
+
628
+ // Result shape (from schema): { active_count: number; limit: number | null; at_limit: boolean }
629
+ ```
630
+
631
+
632
+ <!-- prompt-hash:
633
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
634
+ -->