# This file was auto-generated by Fern from our API Definition. import typing from json.decoder import JSONDecodeError from ..core.api_error import ApiError from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.jsonable_encoder import jsonable_encoder from ..core.pydantic_utilities import parse_obj_as from ..core.request_options import RequestOptions from ..core.serialization import convert_and_respect_annotation_metadata from ..errors.bad_request_error import BadRequestError from ..errors.conflict_error import ConflictError from ..errors.gone_error import GoneError from ..errors.not_found_error import NotFoundError from ..types.error_message import ErrorMessage from ..types.json_node import JsonNode from ..types.local_runner import LocalRunner from ..types.local_runner_connect_response import LocalRunnerConnectResponse from ..types.local_runner_heartbeat_response import LocalRunnerHeartbeatResponse from ..types.local_runner_job import LocalRunnerJob from ..types.local_runner_job_metadata import LocalRunnerJobMetadata from ..types.local_runner_job_page import LocalRunnerJobPage from ..types.local_runner_log_entry import LocalRunnerLogEntry from ..types.local_runner_page import LocalRunnerPage from ..types.local_runner_pair_response import LocalRunnerPairResponse from .types.local_runner_job_result_request_status import LocalRunnerJobResultRequestStatus # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawRunnersClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def get_job_logs( self, job_id: str, *, offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.List[LocalRunnerLogEntry]]: """ Get log entries for a local runner job Parameters ---------- job_id : str offset : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[typing.List[LocalRunnerLogEntry]] Log entries """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/logs", method="GET", params={ "offset": offset, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.List[LocalRunnerLogEntry], parse_obj_as( type_=typing.List[LocalRunnerLogEntry], # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def append_job_logs( self, job_id: str, *, request: typing.Sequence[LocalRunnerLogEntry], request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[None]: """ Append log entries for a running local runner job Parameters ---------- job_id : str request : typing.Sequence[LocalRunnerLogEntry] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/logs", method="POST", json=convert_and_respect_annotation_metadata( object_=request, annotation=typing.Sequence[LocalRunnerLogEntry], direction="write" ), headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def cancel_job(self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: """ Cancel a pending or running local runner job Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/cancel", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def connect_runner( self, *, pairing_code: str, runner_name: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunnerConnectResponse]: """ Exchange a pairing code or API key for local runner credentials Parameters ---------- pairing_code : str runner_name : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerConnectResponse] Runner connected """ _response = self._client_wrapper.httpx_client.request( "v1/private/local-runners/connections", method="POST", json={ "pairing_code": pairing_code, "runner_name": runner_name, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerConnectResponse, parse_obj_as( type_=LocalRunnerConnectResponse, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def create_job( self, *, agent_name: str, project_id: str, inputs: typing.Optional[JsonNode] = OMIT, mask_id: typing.Optional[str] = OMIT, metadata: typing.Optional[LocalRunnerJobMetadata] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[None]: """ Create a local runner job and enqueue it for execution Parameters ---------- agent_name : str project_id : str inputs : typing.Optional[JsonNode] mask_id : typing.Optional[str] metadata : typing.Optional[LocalRunnerJobMetadata] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( "v1/private/local-runners/jobs", method="POST", json={ "agent_name": agent_name, "inputs": inputs, "project_id": project_id, "mask_id": mask_id, "metadata": convert_and_respect_annotation_metadata( object_=metadata, annotation=LocalRunnerJobMetadata, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def generate_pairing_code( self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunnerPairResponse]: """ Generate a pairing code for a local runner in the current workspace Parameters ---------- project_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerPairResponse] Pairing code generated """ _response = self._client_wrapper.httpx_client.request( "v1/private/local-runners/pairs", method="POST", json={ "project_id": project_id, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerPairResponse, parse_obj_as( type_=LocalRunnerPairResponse, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get_job( self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunnerJob]: """ Get a single local runner job's status and results Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerJob] Job details """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJob, parse_obj_as( type_=LocalRunnerJob, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get_runner( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunner]: """ Get a single local runner with its registered agents Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunner] Runner details """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunner, parse_obj_as( type_=LocalRunner, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def heartbeat( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunnerHeartbeatResponse]: """ Refresh local runner heartbeat Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerHeartbeatResponse] Heartbeat response """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/heartbeats", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerHeartbeatResponse, parse_obj_as( type_=LocalRunnerHeartbeatResponse, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 410: raise GoneError( headers=dict(_response.headers), body=typing.cast( ErrorMessage, parse_obj_as( type_=ErrorMessage, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def list_jobs( self, runner_id: str, *, project_id: typing.Optional[str] = None, page: typing.Optional[int] = None, size: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[LocalRunnerJobPage]: """ List jobs for a local runner Parameters ---------- runner_id : str project_id : typing.Optional[str] page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerJobPage] Jobs list """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/jobs", method="GET", params={ "project_id": project_id, "page": page, "size": size, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJobPage, parse_obj_as( type_=LocalRunnerJobPage, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def list_runners( self, *, project_id: str, page: typing.Optional[int] = None, size: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[LocalRunnerPage]: """ List local runners owned by the current user in the workspace Parameters ---------- project_id : str page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerPage] Runners list """ _response = self._client_wrapper.httpx_client.request( "v1/private/local-runners", method="GET", params={ "project_id": project_id, "page": page, "size": size, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerPage, parse_obj_as( type_=LocalRunnerPage, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def next_job( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[LocalRunnerJob]: """ Long-poll for the next pending local runner job Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[LocalRunnerJob] Job available """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/jobs/next", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJob, parse_obj_as( type_=LocalRunnerJob, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def register_agents( self, runner_id: str, *, request: typing.Dict[str, typing.Optional[typing.Any]], request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[None]: """ Register or update the local runner's agent list Parameters ---------- runner_id : str request : typing.Dict[str, typing.Optional[typing.Any]] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/agents", method="PUT", json=request, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def report_job_result( self, job_id: str, *, status: LocalRunnerJobResultRequestStatus, result: typing.Optional[JsonNode] = OMIT, error: typing.Optional[str] = OMIT, trace_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[None]: """ Report local runner job completion or failure Parameters ---------- job_id : str status : LocalRunnerJobResultRequestStatus result : typing.Optional[JsonNode] error : typing.Optional[str] trace_id : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/results", method="POST", json={ "status": status, "result": result, "error": error, "trace_id": trace_id, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) class AsyncRawRunnersClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def get_job_logs( self, job_id: str, *, offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.List[LocalRunnerLogEntry]]: """ Get log entries for a local runner job Parameters ---------- job_id : str offset : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[typing.List[LocalRunnerLogEntry]] Log entries """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/logs", method="GET", params={ "offset": offset, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.List[LocalRunnerLogEntry], parse_obj_as( type_=typing.List[LocalRunnerLogEntry], # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def append_job_logs( self, job_id: str, *, request: typing.Sequence[LocalRunnerLogEntry], request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[None]: """ Append log entries for a running local runner job Parameters ---------- job_id : str request : typing.Sequence[LocalRunnerLogEntry] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/logs", method="POST", json=convert_and_respect_annotation_metadata( object_=request, annotation=typing.Sequence[LocalRunnerLogEntry], direction="write" ), headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def cancel_job( self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ Cancel a pending or running local runner job Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/cancel", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def connect_runner( self, *, pairing_code: str, runner_name: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunnerConnectResponse]: """ Exchange a pairing code or API key for local runner credentials Parameters ---------- pairing_code : str runner_name : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerConnectResponse] Runner connected """ _response = await self._client_wrapper.httpx_client.request( "v1/private/local-runners/connections", method="POST", json={ "pairing_code": pairing_code, "runner_name": runner_name, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerConnectResponse, parse_obj_as( type_=LocalRunnerConnectResponse, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def create_job( self, *, agent_name: str, project_id: str, inputs: typing.Optional[JsonNode] = OMIT, mask_id: typing.Optional[str] = OMIT, metadata: typing.Optional[LocalRunnerJobMetadata] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[None]: """ Create a local runner job and enqueue it for execution Parameters ---------- agent_name : str project_id : str inputs : typing.Optional[JsonNode] mask_id : typing.Optional[str] metadata : typing.Optional[LocalRunnerJobMetadata] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( "v1/private/local-runners/jobs", method="POST", json={ "agent_name": agent_name, "inputs": inputs, "project_id": project_id, "mask_id": mask_id, "metadata": convert_and_respect_annotation_metadata( object_=metadata, annotation=LocalRunnerJobMetadata, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 409: raise ConflictError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def generate_pairing_code( self, *, project_id: str, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunnerPairResponse]: """ Generate a pairing code for a local runner in the current workspace Parameters ---------- project_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerPairResponse] Pairing code generated """ _response = await self._client_wrapper.httpx_client.request( "v1/private/local-runners/pairs", method="POST", json={ "project_id": project_id, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerPairResponse, parse_obj_as( type_=LocalRunnerPairResponse, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get_job( self, job_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunnerJob]: """ Get a single local runner job's status and results Parameters ---------- job_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerJob] Job details """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJob, parse_obj_as( type_=LocalRunnerJob, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get_runner( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunner]: """ Get a single local runner with its registered agents Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunner] Runner details """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunner, parse_obj_as( type_=LocalRunner, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def heartbeat( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunnerHeartbeatResponse]: """ Refresh local runner heartbeat Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerHeartbeatResponse] Heartbeat response """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/heartbeats", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerHeartbeatResponse, parse_obj_as( type_=LocalRunnerHeartbeatResponse, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 410: raise GoneError( headers=dict(_response.headers), body=typing.cast( ErrorMessage, parse_obj_as( type_=ErrorMessage, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def list_jobs( self, runner_id: str, *, project_id: typing.Optional[str] = None, page: typing.Optional[int] = None, size: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[LocalRunnerJobPage]: """ List jobs for a local runner Parameters ---------- runner_id : str project_id : typing.Optional[str] page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerJobPage] Jobs list """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/jobs", method="GET", params={ "project_id": project_id, "page": page, "size": size, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJobPage, parse_obj_as( type_=LocalRunnerJobPage, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def list_runners( self, *, project_id: str, page: typing.Optional[int] = None, size: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[LocalRunnerPage]: """ List local runners owned by the current user in the workspace Parameters ---------- project_id : str page : typing.Optional[int] size : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerPage] Runners list """ _response = await self._client_wrapper.httpx_client.request( "v1/private/local-runners", method="GET", params={ "project_id": project_id, "page": page, "size": size, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerPage, parse_obj_as( type_=LocalRunnerPage, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def next_job( self, runner_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[LocalRunnerJob]: """ Long-poll for the next pending local runner job Parameters ---------- runner_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[LocalRunnerJob] Job available """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/jobs/next", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( LocalRunnerJob, parse_obj_as( type_=LocalRunnerJob, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def register_agents( self, runner_id: str, *, request: typing.Dict[str, typing.Optional[typing.Any]], request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[None]: """ Register or update the local runner's agent list Parameters ---------- runner_id : str request : typing.Dict[str, typing.Optional[typing.Any]] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/{jsonable_encoder(runner_id)}/agents", method="PUT", json=request, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def report_job_result( self, job_id: str, *, status: LocalRunnerJobResultRequestStatus, result: typing.Optional[JsonNode] = OMIT, error: typing.Optional[str] = OMIT, trace_id: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[None]: """ Report local runner job completion or failure Parameters ---------- job_id : str status : LocalRunnerJobResultRequestStatus result : typing.Optional[JsonNode] error : typing.Optional[str] trace_id : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/local-runners/jobs/{jsonable_encoder(job_id)}/results", method="POST", json={ "status": status, "result": result, "error": error, "trace_id": trace_id, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) if _response.status_code == 400: raise BadRequestError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) if _response.status_code == 404: raise NotFoundError( headers=dict(_response.headers), body=typing.cast( typing.Optional[typing.Any], parse_obj_as( type_=typing.Optional[typing.Any], # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)