# 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.request_options import RequestOptions from ....core.serialization import convert_and_respect_annotation_metadata from ....core.unchecked_base_model import construct_type from ....errors.unprocessable_entity_error import UnprocessableEntityError from ....types.add_chapter_response_model import AddChapterResponseModel from ....types.chapter_content_input_model import ChapterContentInputModel from ....types.chapter_with_content_response_model import ChapterWithContentResponseModel from ....types.convert_chapter_response_model import ConvertChapterResponseModel from ....types.delete_chapter_response_model import DeleteChapterResponseModel from ....types.edit_chapter_response_model import EditChapterResponseModel from ....types.get_chapters_response import GetChaptersResponse from ....types.http_validation_error import HttpValidationError # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawChaptersClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def list( self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[GetChaptersResponse]: """ Returns a list of a Studio project's chapters. Parameters ---------- project_id : str The ID of the Studio project. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[GetChaptersResponse] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( GetChaptersResponse, construct_type( type_=GetChaptersResponse, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, *, name: str, from_url: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[AddChapterResponseModel]: """ Creates a new chapter either as blank or from a URL. Parameters ---------- project_id : str The ID of the Studio project. name : str The name of the chapter, used for identification only. from_url : typing.Optional[str] An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[AddChapterResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters", method="POST", json={ "name": name, "from_url": from_url, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( AddChapterResponseModel, construct_type( type_=AddChapterResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[ChapterWithContentResponseModel]: """ Returns information about a specific chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ChapterWithContentResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ChapterWithContentResponseModel, construct_type( type_=ChapterWithContentResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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 update( self, project_id: str, chapter_id: str, *, name: typing.Optional[str] = OMIT, content: typing.Optional[ChapterContentInputModel] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[EditChapterResponseModel]: """ Updates a chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. name : typing.Optional[str] The name of the chapter, used for identification only. content : typing.Optional[ChapterContentInputModel] The chapter content to use. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[EditChapterResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="POST", json={ "name": name, "content": convert_and_respect_annotation_metadata( object_=content, annotation=ChapterContentInputModel, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( EditChapterResponseModel, construct_type( type_=EditChapterResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[DeleteChapterResponseModel]: """ Deletes a chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[DeleteChapterResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DeleteChapterResponseModel, construct_type( type_=DeleteChapterResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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 convert( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> HttpResponse[ConvertChapterResponseModel]: """ Starts conversion of a specific chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[ConvertChapterResponseModel] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}/convert", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ConvertChapterResponseModel, construct_type( type_=ConvertChapterResponseModel, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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 AsyncRawChaptersClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def list( self, project_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[GetChaptersResponse]: """ Returns a list of a Studio project's chapters. Parameters ---------- project_id : str The ID of the Studio project. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[GetChaptersResponse] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( GetChaptersResponse, construct_type( type_=GetChaptersResponse, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, *, name: str, from_url: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[AddChapterResponseModel]: """ Creates a new chapter either as blank or from a URL. Parameters ---------- project_id : str The ID of the Studio project. name : str The name of the chapter, used for identification only. from_url : typing.Optional[str] An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[AddChapterResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters", method="POST", json={ "name": name, "from_url": from_url, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( AddChapterResponseModel, construct_type( type_=AddChapterResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[ChapterWithContentResponseModel]: """ Returns information about a specific chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ChapterWithContentResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="GET", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ChapterWithContentResponseModel, construct_type( type_=ChapterWithContentResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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 update( self, project_id: str, chapter_id: str, *, name: typing.Optional[str] = OMIT, content: typing.Optional[ChapterContentInputModel] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[EditChapterResponseModel]: """ Updates a chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. name : typing.Optional[str] The name of the chapter, used for identification only. content : typing.Optional[ChapterContentInputModel] The chapter content to use. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[EditChapterResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="POST", json={ "name": name, "content": convert_and_respect_annotation_metadata( object_=content, annotation=ChapterContentInputModel, direction="write" ), }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( EditChapterResponseModel, construct_type( type_=EditChapterResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[DeleteChapterResponseModel]: """ Deletes a chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[DeleteChapterResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}", method="DELETE", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( DeleteChapterResponseModel, construct_type( type_=DeleteChapterResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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 convert( self, project_id: str, chapter_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> AsyncHttpResponse[ConvertChapterResponseModel]: """ Starts conversion of a specific chapter. Parameters ---------- project_id : str The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects. chapter_id : str The ID of the chapter to be used. You can use the [List project chapters](/docs/api-reference/studio/get-chapters) endpoint to list all the available chapters. request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[ConvertChapterResponseModel] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"v1/studio/projects/{jsonable_encoder(project_id)}/chapters/{jsonable_encoder(chapter_id)}/convert", method="POST", request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( ConvertChapterResponseModel, construct_type( type_=ConvertChapterResponseModel, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # 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)