Coverage for packages/clopos/src/integrify/clopos/schemas/common/response.py: 100%

1from typing import Generic, Literal, TypeVar 

2 

3from integrify.utils import UnsetField 

4from pydantic import BaseModel 

5 

6_ObjectTypeT = TypeVar('_ObjectTypeT', bound=BaseModel) 

7 

8 

9class BaseResponse(BaseModel): 

10 success: Literal[True] 

11 """Success status of the request""" 

12 

13 message: UnsetField[str] 

14 """Success message""" 

15 

16 time: int 

17 """Response time (ms)""" 

18 

19 timestamp: str 

20 """ISO 8601 date""" 

21 

22 unix: int 

23 """Unix timestamp of the response""" 

24 

25 

26class PaginatedResponse(BaseResponse): 

27 total: UnsetField[int] 

28 """Number of items returned""" 

29 

30 sorts: UnsetField[list[str]] 

31 """List of sortable fields""" 

32 

33 

34class ObjectResponse(BaseResponse, Generic[_ObjectTypeT]): 

35 data: _ObjectTypeT 

36 """Object returned""" 

37 

38 

39class ObjectListResponse(PaginatedResponse, Generic[_ObjectTypeT]): 

40 data: list[_ObjectTypeT] 

41 

42 

43class Errors(BaseModel): 

44 message: str | None = None 

45 type: str | None = None 

46 exception: str | None = None 

47 code: int | None = None 

48 http_code: int | None = None 

49 

50 

51class ErrorResponse(BaseModel): 

52 success: Literal[False] 

53 error: list[Errors] = [] 

54 message: str | None = None