# 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 ..errors.conflict_error import ConflictError from ..errors.not_found_error import NotFoundError from ..types.dashboard_page_public import DashboardPagePublic from ..types.dashboard_public import DashboardPublic from ..types.json_node_public import JsonNodePublic from ..types.json_node_write import JsonNodeWrite from .types.dashboard_update_public_scope import DashboardUpdatePublicScope from .types.dashboard_update_public_type import DashboardUpdatePublicType from .types.dashboard_write_scope import DashboardWriteScope from .types.dashboard_write_type import DashboardWriteType # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawDashboardsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def find_dashboards( self, *, page: typing.Optional[int] = None, size: typing.Optional[int] = None, name: typing.Optional[str] = None, project_id: typing.Optional[str] = None, sorting: typing.Optional[str] = None, filters: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[DashboardPagePublic]: """ Find dashboards in a workspace Parameters ---------- page : typing.Optional[int] size : typing.Optional[int] name : typing.Optional[str] project_id : typing.Optional[str] sorting : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DashboardPagePublic] Dashboard page """ _response = self._client_wrapper.httpx_client.request( "v1/private/dashboards", method="GET", params={ "page": page, "size": size, "name": name, "project_id": project_id, "sorting": sorting, "filters": filters, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPagePublic, parse_obj_as( type_=DashboardPagePublic, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _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_dashboard( self, *, name: str, config: JsonNodeWrite, project_id: typing.Optional[str] = OMIT, project_name: typing.Optional[str] = OMIT, type: typing.Optional[DashboardWriteType] = OMIT, scope: typing.Optional[DashboardWriteScope] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[DashboardPublic]: """ Create a new dashboard in a workspace Parameters ---------- name : str config : JsonNodeWrite project_id : typing.Optional[str] Project ID. Takes precedence over project_name when both are provided. project_name : typing.Optional[str] For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dashboard is created at workspace level. type : typing.Optional[DashboardWriteType] scope : typing.Optional[DashboardWriteScope] description : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DashboardPublic] Created """ _response = self._client_wrapper.httpx_client.request( "v1/private/dashboards", method="POST", json={ "project_id": project_id, "project_name": project_name, "name": name, "type": type, "scope": scope, "description": description, "config": config, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) _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_dashboard_by_id( self, dashboard_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[DashboardPublic]: """ Get dashboard by id Parameters ---------- dashboard_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DashboardPublic] Dashboard resource """ _response = self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # 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 delete_dashboard( self, dashboard_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[None]: """ Delete dashboard by id Parameters ---------- dashboard_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) _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 update_dashboard( self, dashboard_id: str, *, name: typing.Optional[str] = OMIT, type: typing.Optional[DashboardUpdatePublicType] = OMIT, scope: typing.Optional[DashboardUpdatePublicScope] = OMIT, description: typing.Optional[str] = OMIT, config: typing.Optional[JsonNodePublic] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[DashboardPublic]: """ Update dashboard by id. Partial updates are supported - only provided fields will be updated. Parameters ---------- dashboard_id : str name : typing.Optional[str] type : typing.Optional[DashboardUpdatePublicType] scope : typing.Optional[DashboardUpdatePublicScope] description : typing.Optional[str] config : typing.Optional[JsonNodePublic] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DashboardPublic] Updated dashboard """ _response = self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="PATCH", json={ "name": name, "type": type, "scope": scope, "description": description, "config": config, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # 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 == 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 delete_dashboards_batch( self, *, ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[None]: """ Delete dashboards batch Parameters ---------- ids : typing.Sequence[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[None] """ _response = self._client_wrapper.httpx_client.request( "v1/private/dashboards/delete-batch", method="POST", json={ "ids": ids, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return HttpResponse(response=_response, data=None) _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 AsyncRawDashboardsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def find_dashboards( self, *, page: typing.Optional[int] = None, size: typing.Optional[int] = None, name: typing.Optional[str] = None, project_id: typing.Optional[str] = None, sorting: typing.Optional[str] = None, filters: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[DashboardPagePublic]: """ Find dashboards in a workspace Parameters ---------- page : typing.Optional[int] size : typing.Optional[int] name : typing.Optional[str] project_id : typing.Optional[str] sorting : typing.Optional[str] filters : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DashboardPagePublic] Dashboard page """ _response = await self._client_wrapper.httpx_client.request( "v1/private/dashboards", method="GET", params={ "page": page, "size": size, "name": name, "project_id": project_id, "sorting": sorting, "filters": filters, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPagePublic, parse_obj_as( type_=DashboardPagePublic, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _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_dashboard( self, *, name: str, config: JsonNodeWrite, project_id: typing.Optional[str] = OMIT, project_name: typing.Optional[str] = OMIT, type: typing.Optional[DashboardWriteType] = OMIT, scope: typing.Optional[DashboardWriteScope] = OMIT, description: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[DashboardPublic]: """ Create a new dashboard in a workspace Parameters ---------- name : str config : JsonNodeWrite project_id : typing.Optional[str] Project ID. Takes precedence over project_name when both are provided. project_name : typing.Optional[str] For project scope, specify either project_id or project_name. If project_name is provided and the project does not exist, it will be created. Ignored when project_id is provided. If neither is provided, the dashboard is created at workspace level. type : typing.Optional[DashboardWriteType] scope : typing.Optional[DashboardWriteScope] description : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DashboardPublic] Created """ _response = await self._client_wrapper.httpx_client.request( "v1/private/dashboards", method="POST", json={ "project_id": project_id, "project_name": project_name, "name": name, "type": type, "scope": scope, "description": description, "config": config, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) _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_dashboard_by_id( self, dashboard_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[DashboardPublic]: """ Get dashboard by id Parameters ---------- dashboard_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DashboardPublic] Dashboard resource """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # 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 delete_dashboard( self, dashboard_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ Delete dashboard by id Parameters ---------- dashboard_id : str request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) _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 update_dashboard( self, dashboard_id: str, *, name: typing.Optional[str] = OMIT, type: typing.Optional[DashboardUpdatePublicType] = OMIT, scope: typing.Optional[DashboardUpdatePublicScope] = OMIT, description: typing.Optional[str] = OMIT, config: typing.Optional[JsonNodePublic] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[DashboardPublic]: """ Update dashboard by id. Partial updates are supported - only provided fields will be updated. Parameters ---------- dashboard_id : str name : typing.Optional[str] type : typing.Optional[DashboardUpdatePublicType] scope : typing.Optional[DashboardUpdatePublicScope] description : typing.Optional[str] config : typing.Optional[JsonNodePublic] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DashboardPublic] Updated dashboard """ _response = await self._client_wrapper.httpx_client.request( f"v1/private/dashboards/{jsonable_encoder(dashboard_id)}", method="PATCH", json={ "name": name, "type": type, "scope": scope, "description": description, "config": config, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DashboardPublic, parse_obj_as( type_=DashboardPublic, # 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 == 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 delete_dashboards_batch( self, *, ids: typing.Sequence[str], request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[None]: """ Delete dashboards batch Parameters ---------- ids : typing.Sequence[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[None] """ _response = await self._client_wrapper.httpx_client.request( "v1/private/dashboards/delete-batch", method="POST", json={ "ids": ids, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: return AsyncHttpResponse(response=_response, data=None) _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)