@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,200 @@
1
+ # Reverse Proxy
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.proxyRecordsList`
6
+
7
+ - **HTTP**: `GET /api/organizations/{organization_id}/proxy_records/`
8
+ - **What it does**: List all reverse proxies configured for the organization. Returns proxy records along with the maximum number allowed by the current plan.
9
+ - **OpenAPI operationId**: `proxy_records_list`
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: `({ results: ({ id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: strin...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type ProxyRecordsListInput = Parameters<typeof posthog.proxyRecordsList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type ProxyRecordsListOutput = Awaited<ReturnType<typeof posthog.proxyRecordsList>>;
31
+
32
+ const result: ProxyRecordsListOutput = await posthog.proxyRecordsList();
33
+
34
+ // Result shape (from schema): ({ results: ({ id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: strin...
35
+ ```
36
+
37
+ ### `posthog.proxyRecordsCreate`
38
+
39
+ - **HTTP**: `POST /api/organizations/{organization_id}/proxy_records/`
40
+ - **What it does**: Create a new managed reverse proxy. Provide the domain you want to proxy through. The response includes the CNAME target you need to add as a DNS record. Once the CNAME is configured, the proxy will be automatically verified and provisioned.
41
+ - **OpenAPI operationId**: `proxy_records_create`
42
+ - **Path params**: None
43
+ - **Query params**: None
44
+ - **Response codes**: `201`
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: `{ id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...`
56
+ - OpenAPI response codes: `201`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type ProxyRecordsCreateInput = Parameters<typeof posthog.proxyRecordsCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type ProxyRecordsCreateOutput = Awaited<ReturnType<typeof posthog.proxyRecordsCreate>>;
63
+
64
+ const result: ProxyRecordsCreateOutput = await posthog.proxyRecordsCreate();
65
+
66
+ // Result shape (from schema): { id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...
67
+ ```
68
+
69
+ ### `posthog.proxyRecordsDestroy`
70
+
71
+ - **HTTP**: `DELETE /api/organizations/{organization_id}/proxy_records/{id}/`
72
+ - **What it does**: Delete a reverse proxy. For proxies in 'waiting', 'erroring', or 'timed_out' status, the record is deleted immediately. For active proxies, a deletion workflow is started to clean up the provisioned infrastructure.
73
+ - **OpenAPI operationId**: `proxy_records_destroy`
74
+ - **Path params**: `id`
75
+ - **Query params**: None
76
+ - **Response codes**: `204`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `unknown`
88
+ - OpenAPI response codes: `204`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type ProxyRecordsDestroyInput = Parameters<typeof posthog.proxyRecordsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type ProxyRecordsDestroyOutput = Awaited<ReturnType<typeof posthog.proxyRecordsDestroy>>;
95
+
96
+ const result: ProxyRecordsDestroyOutput = await posthog.proxyRecordsDestroy();
97
+
98
+ // Result shape (from schema): unknown
99
+ ```
100
+
101
+ ### `posthog.proxyRecordsRetrieve`
102
+
103
+ - **HTTP**: `GET /api/organizations/{organization_id}/proxy_records/{id}/`
104
+ - **What it does**: Get details of a specific reverse proxy by ID. Returns the full configuration including domain, CNAME target, and current provisioning status.
105
+ - **OpenAPI operationId**: `proxy_records_retrieve`
106
+ - **Path params**: `id`
107
+ - **Query params**: None
108
+ - **Response codes**: `200`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `{ id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type ProxyRecordsRetrieveInput = Parameters<typeof posthog.proxyRecordsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type ProxyRecordsRetrieveOutput = Awaited<ReturnType<typeof posthog.proxyRecordsRetrieve>>;
127
+
128
+ const result: ProxyRecordsRetrieveOutput = await posthog.proxyRecordsRetrieve();
129
+
130
+ // Result shape (from schema): { id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...
131
+ ```
132
+
133
+ ### `posthog.proxyRecordsDiagnoseCreate`
134
+
135
+ - **HTTP**: `POST /api/organizations/{organization_id}/proxy_records/{id}/diagnose/`
136
+ - **What it does**: Run a deep diagnostic on a reverse proxy. Inspects DNS CNAME alignment, the certificate provider's hostname state, CAA records walked up the customer's DNS tree, HTTP-01 challenge reachability, a live event probe, and certificate expiry. Returns a structured report with each check's status and concrete remediation steps (e.g. exact DNS records to add). Use this to debug why a proxy is stuck or erroring.
137
+ - **OpenAPI operationId**: `proxy_records_diagnose_create`
138
+ - **Path params**: `id`
139
+ - **Query params**: None
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ ran_at: string; summary: { status: "healthy" | "warn" | "fail"; primary_issue: string | null; next_action: string | null }; checks: ({ id: string; name: string; status: "passed" | "warned" | "failed" | "skipped"; deta...`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type ProxyRecordsDiagnoseCreateInput = Parameters<typeof posthog.proxyRecordsDiagnoseCreate> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type ProxyRecordsDiagnoseCreateOutput = Awaited<ReturnType<typeof posthog.proxyRecordsDiagnoseCreate>>;
159
+
160
+ const result: ProxyRecordsDiagnoseCreateOutput = await posthog.proxyRecordsDiagnoseCreate();
161
+
162
+ // Result shape (from schema): { ran_at: string; summary: { status: "healthy" | "warn" | "fail"; primary_issue: string | null; next_action: string | null }; checks: ({ id: string; name: string; status: "passed" | "warned" | "failed" | "skipped"; deta...
163
+ ```
164
+
165
+ ### `posthog.proxyRecordsRetryCreate`
166
+
167
+ - **HTTP**: `POST /api/organizations/{organization_id}/proxy_records/{id}/retry/`
168
+ - **What it does**: Retry provisioning a failed reverse proxy. Only available for proxies in 'erroring' or 'timed_out' status. Resets the proxy to 'waiting' status and restarts the provisioning workflow.
169
+ - **OpenAPI operationId**: `proxy_records_retry_create`
170
+ - **Path params**: `id`
171
+ - **Query params**: None
172
+ - **Response codes**: `200`
173
+ - **Transport options**: None
174
+ - **TypeScript**: [Client interface](../types.ts)
175
+
176
+ **Inputs**
177
+
178
+ - Client input type: `{ [key: string]: unknown }`
179
+ - Client transport options: None
180
+
181
+ **Outputs**
182
+
183
+ - Client return type: `{ id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...`
184
+ - OpenAPI response codes: `200`
185
+
186
+ ```ts
187
+ import posthog from "@utdk/posthog";
188
+
189
+ type ProxyRecordsRetryCreateInput = Parameters<typeof posthog.proxyRecordsRetryCreate> extends [infer T, ...unknown[]] ? T : undefined;
190
+ type ProxyRecordsRetryCreateOutput = Awaited<ReturnType<typeof posthog.proxyRecordsRetryCreate>>;
191
+
192
+ const result: ProxyRecordsRetryCreateOutput = await posthog.proxyRecordsRetryCreate();
193
+
194
+ // Result shape (from schema): { id: string; domain: string; target_cname: string; status: "waiting" | "issuing" | "valid" | "warning" | "erroring" | "deleting" | "timed_out"; message: string | null; created_at: string; updated_at: string; created_by...
195
+ ```
196
+
197
+
198
+ <!-- prompt-hash:
199
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
200
+ -->
@@ -0,0 +1,209 @@
1
+ # Sandbox Custom Images
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.sandboxCustomImagesList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/sandbox_custom_images/`
8
+ - **What it does**: API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent.
9
+
10
+ Custom images only run on the Modal VM runtime, so every action is gated on the
11
+ `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
12
+ - **OpenAPI operationId**: `sandbox_custom_images_list`
13
+ - **Path params**: None
14
+ - **Query params**: `limit`, `offset`
15
+ - **Response codes**: `200`
16
+ - **Transport options**: None
17
+ - **TypeScript**: [Client interface](../types.ts)
18
+
19
+ **Inputs**
20
+
21
+ - Client input type: `{ [key: string]: unknown }`
22
+ - Client transport options: None
23
+
24
+ **Outputs**
25
+
26
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: stri...`
27
+ - OpenAPI response codes: `200`
28
+
29
+ ```ts
30
+ import posthog from "@utdk/posthog";
31
+
32
+ type SandboxCustomImagesListInput = Parameters<typeof posthog.sandboxCustomImagesList> extends [infer T, ...unknown[]] ? T : undefined;
33
+ type SandboxCustomImagesListOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesList>>;
34
+
35
+ const result: SandboxCustomImagesListOutput = await posthog.sandboxCustomImagesList();
36
+
37
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: stri...
38
+ ```
39
+
40
+ ### `posthog.sandboxCustomImagesCreate`
41
+
42
+ - **HTTP**: `POST /api/projects/{project_id}/sandbox_custom_images/`
43
+ - **What it does**: Create a draft custom image and start its interactive image-builder agent task. The returned builder_task_id points at the conversation.
44
+ - **OpenAPI operationId**: `sandbox_custom_images_create`
45
+ - **Path params**: None
46
+ - **Query params**: None
47
+ - **Response codes**: `201`
48
+ - **Transport options**: None
49
+ - **TypeScript**: [Client interface](../types.ts)
50
+
51
+ **Inputs**
52
+
53
+ - Client input type: `{ [key: string]: unknown }`
54
+ - Client transport options: None
55
+
56
+ **Outputs**
57
+
58
+ - Client return type: `{ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...`
59
+ - OpenAPI response codes: `201`
60
+
61
+ ```ts
62
+ import posthog from "@utdk/posthog";
63
+
64
+ type SandboxCustomImagesCreateInput = Parameters<typeof posthog.sandboxCustomImagesCreate> extends [infer T, ...unknown[]] ? T : undefined;
65
+ type SandboxCustomImagesCreateOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesCreate>>;
66
+
67
+ const result: SandboxCustomImagesCreateOutput = await posthog.sandboxCustomImagesCreate();
68
+
69
+ // Result shape (from schema): { id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...
70
+ ```
71
+
72
+ ### `posthog.sandboxCustomImagesDestroy`
73
+
74
+ - **HTTP**: `DELETE /api/projects/{project_id}/sandbox_custom_images/{id}/`
75
+ - **What it does**: API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent.
76
+
77
+ Custom images only run on the Modal VM runtime, so every action is gated on the
78
+ `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
79
+ - **OpenAPI operationId**: `sandbox_custom_images_destroy`
80
+ - **Path params**: `id`
81
+ - **Query params**: None
82
+ - **Response codes**: `204`
83
+ - **Transport options**: None
84
+ - **TypeScript**: [Client interface](../types.ts)
85
+
86
+ **Inputs**
87
+
88
+ - Client input type: `{ [key: string]: unknown }`
89
+ - Client transport options: None
90
+
91
+ **Outputs**
92
+
93
+ - Client return type: `unknown`
94
+ - OpenAPI response codes: `204`
95
+
96
+ ```ts
97
+ import posthog from "@utdk/posthog";
98
+
99
+ type SandboxCustomImagesDestroyInput = Parameters<typeof posthog.sandboxCustomImagesDestroy> extends [infer T, ...unknown[]] ? T : undefined;
100
+ type SandboxCustomImagesDestroyOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesDestroy>>;
101
+
102
+ const result: SandboxCustomImagesDestroyOutput = await posthog.sandboxCustomImagesDestroy();
103
+
104
+ // Result shape (from schema): unknown
105
+ ```
106
+
107
+ ### `posthog.sandboxCustomImagesRetrieve`
108
+
109
+ - **HTTP**: `GET /api/projects/{project_id}/sandbox_custom_images/{id}/`
110
+ - **What it does**: API for custom sandbox base images, built on top of the VM sandbox base via an image-builder agent.
111
+
112
+ Custom images only run on the Modal VM runtime, so every action is gated on the
113
+ `tasks-modal-vm-sandbox` flag (org-enabled with `user_created` in its origin_products payload).
114
+ - **OpenAPI operationId**: `sandbox_custom_images_retrieve`
115
+ - **Path params**: `id`
116
+ - **Query params**: None
117
+ - **Response codes**: `200`
118
+ - **Transport options**: None
119
+ - **TypeScript**: [Client interface](../types.ts)
120
+
121
+ **Inputs**
122
+
123
+ - Client input type: `{ [key: string]: unknown }`
124
+ - Client transport options: None
125
+
126
+ **Outputs**
127
+
128
+ - Client return type: `{ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...`
129
+ - OpenAPI response codes: `200`
130
+
131
+ ```ts
132
+ import posthog from "@utdk/posthog";
133
+
134
+ type SandboxCustomImagesRetrieveInput = Parameters<typeof posthog.sandboxCustomImagesRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
135
+ type SandboxCustomImagesRetrieveOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesRetrieve>>;
136
+
137
+ const result: SandboxCustomImagesRetrieveOutput = await posthog.sandboxCustomImagesRetrieve();
138
+
139
+ // Result shape (from schema): { id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...
140
+ ```
141
+
142
+ ### `posthog.sandboxCustomImagesBuildCreate`
143
+
144
+ - **HTTP**: `POST /api/projects/{project_id}/sandbox_custom_images/{id}/build/`
145
+ - **What it does**: Persist the image spec (from the request body or the builder agent's sandbox), run the security scan, and on pass build and publish the image.
146
+ - **OpenAPI operationId**: `sandbox_custom_images_build_create`
147
+ - **Path params**: `id`
148
+ - **Query params**: None
149
+ - **Response codes**: `200`
150
+ - **Transport options**: None
151
+ - **TypeScript**: [Client interface](../types.ts)
152
+
153
+ **Inputs**
154
+
155
+ - Client input type: `{ [key: string]: unknown }`
156
+ - Client transport options: None
157
+
158
+ **Outputs**
159
+
160
+ - Client return type: `{ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...`
161
+ - OpenAPI response codes: `200`
162
+
163
+ ```ts
164
+ import posthog from "@utdk/posthog";
165
+
166
+ type SandboxCustomImagesBuildCreateInput = Parameters<typeof posthog.sandboxCustomImagesBuildCreate> extends [infer T, ...unknown[]] ? T : undefined;
167
+ type SandboxCustomImagesBuildCreateOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesBuildCreate>>;
168
+
169
+ const result: SandboxCustomImagesBuildCreateOutput = await posthog.sandboxCustomImagesBuildCreate();
170
+
171
+ // Result shape (from schema): { id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...
172
+ ```
173
+
174
+ ### `posthog.sandboxCustomImagesBuilderTaskCreate`
175
+
176
+ - **HTTP**: `POST /api/projects/{project_id}/sandbox_custom_images/{id}/builder_task/`
177
+ - **What it does**: Revive (or reuse) the image's builder agent session. When the previous session has ended, a fresh one is started seeded with the stored spec — use this to update an existing image.
178
+ - **OpenAPI operationId**: `sandbox_custom_images_builder_task_create`
179
+ - **Path params**: `id`
180
+ - **Query params**: None
181
+ - **Response codes**: `200`
182
+ - **Transport options**: None
183
+ - **TypeScript**: [Client interface](../types.ts)
184
+
185
+ **Inputs**
186
+
187
+ - Client input type: `{ [key: string]: unknown }`
188
+ - Client transport options: None
189
+
190
+ **Outputs**
191
+
192
+ - Client return type: `{ id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...`
193
+ - OpenAPI response codes: `200`
194
+
195
+ ```ts
196
+ import posthog from "@utdk/posthog";
197
+
198
+ type SandboxCustomImagesBuilderTaskCreateInput = Parameters<typeof posthog.sandboxCustomImagesBuilderTaskCreate> extends [infer T, ...unknown[]] ? T : undefined;
199
+ type SandboxCustomImagesBuilderTaskCreateOutput = Awaited<ReturnType<typeof posthog.sandboxCustomImagesBuilderTaskCreate>>;
200
+
201
+ const result: SandboxCustomImagesBuilderTaskCreateOutput = await posthog.sandboxCustomImagesBuilderTaskCreate();
202
+
203
+ // Result shape (from schema): { id: string; name: string; description: string; repository?: string; private?: boolean; status: string; version: number; modal_image_name: string; spec?: { [key: string]: unknown }; spec_yaml?: string; scan_result?: { ...
204
+ ```
205
+
206
+
207
+ <!-- prompt-hash:
208
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
209
+ -->
@@ -0,0 +1,168 @@
1
+ # Sandbox Environments
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.sandboxList`
6
+
7
+ - **HTTP**: `GET /api/projects/{project_id}/sandbox_environments/`
8
+ - **What it does**: API for managing sandbox environments that control network access for task runs.
9
+ - **OpenAPI operationId**: `sandbox_list`
10
+ - **Path params**: None
11
+ - **Query params**: `limit`, `offset`
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: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: b...`
24
+ - OpenAPI response codes: `200`
25
+
26
+ ```ts
27
+ import posthog from "@utdk/posthog";
28
+
29
+ type SandboxListInput = Parameters<typeof posthog.sandboxList> extends [infer T, ...unknown[]] ? T : undefined;
30
+ type SandboxListOutput = Awaited<ReturnType<typeof posthog.sandboxList>>;
31
+
32
+ const result: SandboxListOutput = await posthog.sandboxList();
33
+
34
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: b...
35
+ ```
36
+
37
+ ### `posthog.sandboxCreate`
38
+
39
+ - **HTTP**: `POST /api/projects/{project_id}/sandbox_environments/`
40
+ - **What it does**: API for managing sandbox environments that control network access for task runs.
41
+ - **OpenAPI operationId**: `sandbox_create`
42
+ - **Path params**: None
43
+ - **Query params**: None
44
+ - **Response codes**: `201`
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: `{ id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...`
56
+ - OpenAPI response codes: `201`
57
+
58
+ ```ts
59
+ import posthog from "@utdk/posthog";
60
+
61
+ type SandboxCreateInput = Parameters<typeof posthog.sandboxCreate> extends [infer T, ...unknown[]] ? T : undefined;
62
+ type SandboxCreateOutput = Awaited<ReturnType<typeof posthog.sandboxCreate>>;
63
+
64
+ const result: SandboxCreateOutput = await posthog.sandboxCreate();
65
+
66
+ // Result shape (from schema): { id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...
67
+ ```
68
+
69
+ ### `posthog.sandboxDestroy`
70
+
71
+ - **HTTP**: `DELETE /api/projects/{project_id}/sandbox_environments/{id}/`
72
+ - **What it does**: API for managing sandbox environments that control network access for task runs.
73
+ - **OpenAPI operationId**: `sandbox_destroy`
74
+ - **Path params**: `id`
75
+ - **Query params**: None
76
+ - **Response codes**: `204`
77
+ - **Transport options**: None
78
+ - **TypeScript**: [Client interface](../types.ts)
79
+
80
+ **Inputs**
81
+
82
+ - Client input type: `{ [key: string]: unknown }`
83
+ - Client transport options: None
84
+
85
+ **Outputs**
86
+
87
+ - Client return type: `unknown`
88
+ - OpenAPI response codes: `204`
89
+
90
+ ```ts
91
+ import posthog from "@utdk/posthog";
92
+
93
+ type SandboxDestroyInput = Parameters<typeof posthog.sandboxDestroy> extends [infer T, ...unknown[]] ? T : undefined;
94
+ type SandboxDestroyOutput = Awaited<ReturnType<typeof posthog.sandboxDestroy>>;
95
+
96
+ const result: SandboxDestroyOutput = await posthog.sandboxDestroy();
97
+
98
+ // Result shape (from schema): unknown
99
+ ```
100
+
101
+ ### `posthog.sandboxRetrieve`
102
+
103
+ - **HTTP**: `GET /api/projects/{project_id}/sandbox_environments/{id}/`
104
+ - **What it does**: API for managing sandbox environments that control network access for task runs.
105
+ - **OpenAPI operationId**: `sandbox_retrieve`
106
+ - **Path params**: `id`
107
+ - **Query params**: None
108
+ - **Response codes**: `200`
109
+ - **Transport options**: None
110
+ - **TypeScript**: [Client interface](../types.ts)
111
+
112
+ **Inputs**
113
+
114
+ - Client input type: `{ [key: string]: unknown }`
115
+ - Client transport options: None
116
+
117
+ **Outputs**
118
+
119
+ - Client return type: `{ id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...`
120
+ - OpenAPI response codes: `200`
121
+
122
+ ```ts
123
+ import posthog from "@utdk/posthog";
124
+
125
+ type SandboxRetrieveInput = Parameters<typeof posthog.sandboxRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
126
+ type SandboxRetrieveOutput = Awaited<ReturnType<typeof posthog.sandboxRetrieve>>;
127
+
128
+ const result: SandboxRetrieveOutput = await posthog.sandboxRetrieve();
129
+
130
+ // Result shape (from schema): { id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...
131
+ ```
132
+
133
+ ### `posthog.sandboxPartialUpdate`
134
+
135
+ - **HTTP**: `PATCH /api/projects/{project_id}/sandbox_environments/{id}/`
136
+ - **What it does**: API for managing sandbox environments that control network access for task runs.
137
+ - **OpenAPI operationId**: `sandbox_partial_update`
138
+ - **Path params**: `id`
139
+ - **Query params**: None
140
+ - **Response codes**: `200`
141
+ - **Transport options**: None
142
+ - **TypeScript**: [Client interface](../types.ts)
143
+
144
+ **Inputs**
145
+
146
+ - Client input type: `{ [key: string]: unknown }`
147
+ - Client transport options: None
148
+
149
+ **Outputs**
150
+
151
+ - Client return type: `{ id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...`
152
+ - OpenAPI response codes: `200`
153
+
154
+ ```ts
155
+ import posthog from "@utdk/posthog";
156
+
157
+ type SandboxPartialUpdateInput = Parameters<typeof posthog.sandboxPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
158
+ type SandboxPartialUpdateOutput = Awaited<ReturnType<typeof posthog.sandboxPartialUpdate>>;
159
+
160
+ const result: SandboxPartialUpdateOutput = await posthog.sandboxPartialUpdate();
161
+
162
+ // Result shape (from schema): { id: string; name: string; network_access_level: string; allowed_domains?: (string)[]; repositories?: (string)[]; private: boolean; internal: boolean; created_by?: { id: number; uuid: string; distinct_id: string; first...
163
+ ```
164
+
165
+
166
+ <!-- prompt-hash:
167
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
168
+ -->