archastro.platform.v1.resources.bug_reports

 1# Copyright (c) 2026 ArchAstro Inc. All Rights Reserved.
 2# This file is auto-generated by @archastro/sdk-generator. Do not edit.
 3# Content hash: 50e6127498e6
 4
 5from __future__ import annotations
 6
 7from typing import Any, Required, TypedDict
 8
 9from ...runtime.http_client import HttpClient, SyncHttpClient
10from ...types.common import BugReport
11
12
13class BugReportCreateInput(TypedDict, total=False):
14    "Submit a bug report"
15
16    client: Required[str]
17    'Identifier of the submitting client. One of `"agent_network_web"`, `"cli"`, or `"developer_portal"`.'
18    client_version: Required[str]
19    "Build SHA or package version of the client."
20    context: dict[str, Any] | None
21    "Optional client-shaped context blob; 5 KB serialized. Stored verbatim and surfaced for triage clients commonly include url, user_agent, thread_id, message_id, etc."
22    description: Required[str]
23    "Freeform report text. 1 10,000 chars after trim."
24
25
26class AsyncBugReportResource:
27    def __init__(self, http: HttpClient):
28        self._http = http
29
30    async def create(self, input: BugReportCreateInput) -> BugReport:
31        """
32        Submit a bug report
33        Creates a bug report or freeform feedback entry on behalf of the authenticated user.
34        The `description` is stored in full; the `context` blob is stored verbatim and surfaced
35        during triage. Callers should include relevant session identifiers (URL, thread ID, etc.)
36        in `context` to speed up reproduction.
37        This endpoint requires authentication. Submissions are rate-limited to 10 reports per
38        user per hour; exceeding that limit returns 429. The `client` value must be one of the
39        recognised string identifiers listed below an unrecognised value returns 400.
40
41        Args:
42            input: Request body.
43            input.client: Identifier of the submitting client. One of `"agent_network_web"`, `"cli"`, or `"developer_portal"`.
44            input.client_version: Build SHA or package version of the client.
45            input.context: Optional client-shaped context blob; 5 KB serialized. Stored verbatim and surfaced for triage clients commonly include url, user_agent, thread_id, message_id, etc.
46            input.description: Freeform report text. 1 10,000 chars after trim.
47
48        Returns:
49            The created bug report record.
50        """
51        return await self._http.request(
52            "/api/v1/bug_reports",
53            method="POST",
54            body=input,
55            response_type=BugReport,
56        )
57
58
59class BugReportResource:
60    def __init__(self, http: SyncHttpClient):
61        self._http = http
62
63    def create(self, input: BugReportCreateInput) -> BugReport:
64        """
65        Submit a bug report
66        Creates a bug report or freeform feedback entry on behalf of the authenticated user.
67        The `description` is stored in full; the `context` blob is stored verbatim and surfaced
68        during triage. Callers should include relevant session identifiers (URL, thread ID, etc.)
69        in `context` to speed up reproduction.
70        This endpoint requires authentication. Submissions are rate-limited to 10 reports per
71        user per hour; exceeding that limit returns 429. The `client` value must be one of the
72        recognised string identifiers listed below an unrecognised value returns 400.
73
74        Args:
75            input: Request body.
76            input.client: Identifier of the submitting client. One of `"agent_network_web"`, `"cli"`, or `"developer_portal"`.
77            input.client_version: Build SHA or package version of the client.
78            input.context: Optional client-shaped context blob; 5 KB serialized. Stored verbatim and surfaced for triage clients commonly include url, user_agent, thread_id, message_id, etc.
79            input.description: Freeform report text. 1 10,000 chars after trim.
80
81        Returns:
82            The created bug report record.
83        """
84        return self._http.request(
85            "/api/v1/bug_reports",
86            method="POST",
87            body=input,
88            response_type=BugReport,
89        )