VampireSquidClient reference¶

Generated from specs/vampire_squid.yaml, cross-referenced against vars_client.generated.vampire_squid. Regenerate with just docs-generate after just generate picks up spec changes -- do not hand-edit this file.

See also: data models.

auth¶

Exchange an API key for a JWT. Header format is Authorization: APIKEY <key>¶

POST /v1/auth

result = await client.vampire_squid.v1.auth.post()

Returns: Optional[Authorization]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

health¶

Health check¶

GET /v1/health

result = await client.vampire_squid.v1.health.get()

Returns: Optional[HealthStatus]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

media¶

Find media by cameraId and timestamps¶

GET /v1/media/camera/{cameraId}/{startTimestamp}/{endTimestamp}

result = await client.vampire_squid.v1.media.camera.by_camera_id(camera_id).by_datetime_id(datetime_id).by_end_timestamp(end_timestamp).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by cameraId and datetime¶

GET /v1/media/camera/{cameraId}/{datetime}

result = await client.vampire_squid.v1.media.camera.by_camera_id(camera_id).by_datetime_id(datetime_id).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find concurrent media by videoReferenceUuid¶

GET /v1/media/concurrent/{videoReferenceUuid}

result = await client.vampire_squid.v1.media.concurrent.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Move an existing media by videoReferenceUuid and form data¶

PUT /v1/media/move/{videoReferenceUuid}

# body: MoveVideoParams
result = await client.vampire_squid.v1.media.move.by_video_reference_uuid(video_reference_uuid).put(body)

Returns: Optional[Media]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find media by sha512¶

GET /v1/media/sha512/{sha512}

result = await client.vampire_squid.v1.media.sha512.by_sha512(sha512).get()

Returns: Optional[Media]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by uri¶

GET /v1/media/uri/{uri}

result = await client.vampire_squid.v1.media.uri.by_uri(uri).get()

Returns: Optional[Media]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by filename¶

GET /v1/media/videoreference/filename/{filename}

result = await client.vampire_squid.v1.media.videoreference.filename.by_filename(filename).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by videoReferenceUuid¶

GET /v1/media/videoreference/{videoReferenceUuid}

result = await client.vampire_squid.v1.media.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[Media]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by video sequence name¶

GET /v1/media/videosequence/{name}

result = await client.vampire_squid.v1.media.videosequence.by_name(name).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find media by video name¶

GET /v1/media/video/{name}

result = await client.vampire_squid.v1.media.video.by_name(name).get()

Returns: Optional[list[Media]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an existing media by videoReferenceUuid and form data¶

PUT /v1/media/{videoReferenceUuid}

# body: Media
result = await client.vampire_squid.v1.media.by_video_reference_uuid(video_reference_uuid).put(body)

Returns: Optional[Media]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Update an existing media. (All uuid params will be ignored if present.)¶

PUT /v1/media

# body: Media
result = await client.vampire_squid.v1.media.put(body)

Returns: Optional[Media]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create a new media.(The uuid param will be ignored if present.)¶

POST /v1/media

# body: Media
result = await client.vampire_squid.v1.media.post(body)

Returns: Optional[Media]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

video sequences¶

Find video sequences by camera id and timestamp¶

GET /v1/videosequences/camera/{cameraid}/{timestamp}

result = await client.vampire_squid.v1.videosequences.camera.by_cameraid(cameraid).by_timestamp(timestamp).get()

Returns: Optional[list[VideoSequence]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video sequences by camera id¶

GET /v1/videosequences/camera/{cameraid}

result = await client.vampire_squid.v1.videosequences.camera.by_cameraid(cameraid).get()

Returns: Optional[list[VideoSequence]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all camera ids¶

GET /v1/videosequences/cameras

result = await client.vampire_squid.v1.videosequences.cameras.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find last update for a video sequence¶

GET /v1/videosequences/lastupdate/{uuid}

result = await client.vampire_squid.v1.videosequences.lastupdate.by_uuid(uuid).get()

Returns: Optional[LastUpdatedTime]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video sequences by camera id¶

GET /v1/videosequences/names/camera/{cameraid}

result = await client.vampire_squid.v1.videosequences.names.camera.by_cameraid(cameraid).get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video sequences by name¶

GET /v1/videosequences/name/{name}

result = await client.vampire_squid.v1.videosequences.name.by_name(name).get()

Returns: Optional[VideoSequence]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all video sequence that do not contain any video references.¶

GET /v1/videosequences/names/empty

result = await client.vampire_squid.v1.videosequences.names.empty.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all video sequence names¶

GET /v1/videosequences/names

result = await client.vampire_squid.v1.videosequences.names.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video sequences by video reference UUID¶

GET /v1/videosequences/videoreference/{videoreferenceuuid}

result = await client.vampire_squid.v1.videosequences.videoreference.by_videoreferenceuuid(videoreferenceuuid).get()

Returns: Optional[VideoSequence]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video sequences by UUID¶

GET /v1/videosequences/{uuid}

result = await client.vampire_squid.v1.videosequences.by_uuid(uuid).get()

Returns: Optional[VideoSequence]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update a video sequence¶

PUT /v1/videosequences/{uuid}

# body: VideoSequenceUpdate
result = await client.vampire_squid.v1.videosequences.by_uuid(uuid).put(body)

Returns: Optional[VideoSequence]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete a video sequence by UUID¶

DELETE /v1/videosequences/{uuid}

result = await client.vampire_squid.v1.videosequences.by_uuid(uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find all video sequences¶

GET /v1/videosequences

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.vampire_squid.v1.videosequences.videosequences_request_builder import VideosequencesRequestBuilder

request_configuration = RequestConfiguration(query_parameters=VideosequencesRequestBuilder.VideosequencesRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.vampire_squid.v1.videosequences.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[VideoSequence]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Create a video sequence¶

POST /v1/videosequences

# body: VideoSequenceCreate
result = await client.vampire_squid.v1.videosequences.post(body)

Returns: Optional[VideoSequence]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

videos¶

Find videos by its video sequence name¶

GET /v1/videos/videosequence/name/{videoSequenceName}

result = await client.vampire_squid.v1.videos.videosequence.name.by_video_sequence_name(video_sequence_name).get()

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a videos by its video sequence UUID¶

GET /v1/videos/videosequence/{videoSequenceUuid}

result = await client.vampire_squid.v1.videos.videosequence.by_video_sequence_uuid(video_sequence_uuid).get()

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a videos by its video reference UUID¶

GET /v1/videos/videoreference/{videoReferenceUuid}

result = await client.vampire_squid.v1.videos.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[Video]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find the last update time for a video by UUID¶

GET /v1/videos/lastupdate/{uuid}

result = await client.vampire_squid.v1.videos.lastupdate.by_uuid(uuid).get()

Returns: Optional[LastUpdatedTime]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a videos by its name¶

GET /v1/videos/name/{name}

result = await client.vampire_squid.v1.videos.name.by_name(name).get()

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video names by its video sequence name¶

GET /v1/videos/names/videosequence/{videoSequenceName}

result = await client.vampire_squid.v1.videos.names.videosequence.by_video_sequence_name(video_sequence_name).get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find videos by its timestamp range¶

GET /v1/videos/timestamp/{start}/{end}

result = await client.vampire_squid.v1.videos.timestamp.by_start_id(start_id).by_end(end).get()

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find videos by its timestamp¶

GET /v1/videos/timestamp/{timestamp}

result = await client.vampire_squid.v1.videos.timestamp.by_start_id(start_id).get()

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all videos¶

GET /v1/videos

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.vampire_squid.v1.videos.videos_request_builder import VideosRequestBuilder

request_configuration = RequestConfiguration(query_parameters=VideosRequestBuilder.VideosRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.vampire_squid.v1.videos.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[Video]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Create a video. Required form fields: name, video_sequence_uuid, start_timestamp (or start), duration_millis. Optional fields: description¶

POST /v1/videos

# body: str
result = await client.vampire_squid.v1.videos.post(body)

Returns: Optional[Video]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find a video by UUID¶

GET /v1/videos/{uuid}

result = await client.vampire_squid.v1.videos.by_uuid(uuid).get()

Returns: Optional[Video]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update a video by UUID. Updateable fields: name, video_sequence_uuid, start_timestamp (or start), duration_millis, description¶

PUT /v1/videos/{uuid}

# body: VideoUpdate
result = await client.vampire_squid.v1.videos.by_uuid(uuid).put(body)

Returns: Optional[Video]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete a video by UUID¶

DELETE /v1/videos/{uuid}

result = await client.vampire_squid.v1.videos.by_uuid(uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

video references¶

Find the last update time for a video reference by UUID¶

GET /v1/videoreferences/lastupdate/{uuid}

result = await client.vampire_squid.v1.videoreferences.lastupdate.by_uuid(uuid).get()

Returns: Optional[LastUpdatedTime]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a video reference by URI¶

GET /v1/videoreferences/uri/{uri}

result = await client.vampire_squid.v1.videoreferences.uri.by_uri(uri).get()

Returns: Optional[VideoReference]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video references by URIs¶

GET /v1/videoreferences/uris

result = await client.vampire_squid.v1.videoreferences.uris.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a video reference by SHA512¶

GET /v1/videoreferences/sha512/{sha512}

result = await client.vampire_squid.v1.videoreferences.sha512.by_sha512(sha512).get()

Returns: Optional[VideoReference]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a video reference by UUID¶

GET /v1/videoreferences/{uuid}

result = await client.vampire_squid.v1.videoreferences.by_uuid(uuid).get()

Returns: Optional[VideoReference]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update a video reference by UUID¶

PUT /v1/videoreferences/{uuid}

# body: VideoReferenceUpdate
result = await client.vampire_squid.v1.videoreferences.by_uuid(uuid).put(body)

Returns: Optional[VideoReference]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete a video reference by UUID¶

DELETE /v1/videoreferences/{uuid}

result = await client.vampire_squid.v1.videoreferences.by_uuid(uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find all video references¶

GET /v1/videoreferences

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.vampire_squid.v1.videoreferences.videoreferences_request_builder import VideoreferencesRequestBuilder

request_configuration = RequestConfiguration(query_parameters=VideoreferencesRequestBuilder.VideoreferencesRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.vampire_squid.v1.videoreferences.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[VideoReference]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Create a video reference¶

POST /v1/videoreferences

# body: VideoReferenceCreate
result = await client.vampire_squid.v1.videoreferences.post(body)

Returns: Optional[VideoReference]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError