InvestigationsResource

Investigation API methods.

Functions

func__init__(self, client) -> None

Initialize the resource.

paramself

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(self, request, idempotency_key=None) -> InvestigationResponse

Create an investigation with its sessions in one shot.

paramself

paramrequestInvestigationCreateRequest

Investigation create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.investigation.InvestigationResponse

Created investigation.

funcget(self, investigation_id) -> InvestigationResponse

Get an investigation by id.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

Returns

kitaru.api_models.v1.investigation.InvestigationResponse

Stored investigation.

funclist(self, params=None) -> Page[InvestigationResponse]

List investigations.

paramself

paramparamsInvestigationListParams | None

= None

Investigation list params.

Returns

kitaru.api_models.v1.base.Page

Page of investigations.

funciter(self, params=None) -> AsyncIterator[InvestigationResponse]

Iterate over all investigations.

paramself

paramparamsInvestigationListParams | None

= None

Investigation list params.

Returns

collections.abc.AsyncIterator

Async iterator over every investigation.

funcupdate(self, investigation_id, request) -> InvestigationResponse

Update an investigation's name, description, and status.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

paramrequestInvestigationUpdateRequest

Investigation update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.investigation.InvestigationResponse

Updated investigation.

funcdelete(self, investigation_id) -> None

Delete an investigation, cascading its sessions and answers.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

Returns

None

funclist_sessions(self, investigation_id, params=None) -> Page[InvestigationSessionResponse]

List the sessions of an investigation, ordered by position.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

paramparamsInvestigationSessionsListParams | None

= None

Investigation sessions list params.

Returns

kitaru.api_models.v1.base.Page

Page of investigation sessions, ordered by position.

funciter_sessions(self, investigation_id, params=None) -> AsyncIterator[InvestigationSessionResponse]

Iterate over all sessions of an investigation, ordered by position.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

paramparamsInvestigationSessionsListParams | None

= None

Investigation sessions list params.

Returns

collections.abc.AsyncIterator

Async iterator over every session of the investigation, ordered

funcupdate_session(self, investigation_id, session_id, request) -> InvestigationSessionResponse

Set or clear an investigation session's verdict.

paramself

paraminvestigation_iduuid.UUID

Id of the investigation.

paramsession_iduuid.UUID

Id of the session.

paramrequestInvestigationSessionUpdateRequest

Investigation session update request.

Returns

kitaru.api_models.v1.investigation.InvestigationSessionResponse

Updated investigation session.

Functions

On this page