facesign-sdk 0.0.3__py3-none-any.whl

facesign_sdk/client.py

@@ -0,0 +1,1504 @@
+import httpx
+import uuid
+import urllib.parse
+from dataclasses import dataclass
+from typing import Literal, Any
+from pydantic import BaseModel, ConfigDict, Field
+
+class AgeRangeFaceFeature(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  low: int = Field(serialization_alias = "low", alias = "low")
+  high: int = Field(serialization_alias = "high", alias = "high")
+
+class ApiKey(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: str = Field(serialization_alias = "id", alias = "id")
+  name: str = Field(serialization_alias = "name", alias = "name")
+  obfuscated_value: str = Field(serialization_alias = "obfuscatedValue", alias = "obfuscatedValue")
+  last_used_at: str | None = Field(serialization_alias = "lastUsedAt", alias = "lastUsedAt", default = None)
+  plain_text_value: str | None = Field(serialization_alias = "plainTextValue", alias = "plainTextValue", default = None)
+  scope: str | None = Field(serialization_alias = "scope", alias = "scope", default = None)
+
+AssistantSpeechDeliveryExtent = Literal["none" , "partial" , "full" , "unknown"]
+AssistantSpeechEvidenceQuality = Literal["exact" , "estimated" , "provider_reported" , "unknown"]
+AssistantSpeechRealtimeStatus = Literal["active" , "completed" , "interrupted" , "failed" , "timed_out"]
+AssistantSpeechTerminalReasonCode = Literal["playback_completed" , "user_barge_in" , "reconnect_recovery" , "playback_start_timeout" , "playback_completion_timeout" , "interruption_acknowledgement_timeout" , "tts_failure_before_audio" , "tts_failure_after_partial_audio" , "avatar_failure" , "session_terminated" , "pipeline_failure"]
+AssistantSpeechTerminalStatus = Literal["completed" , "interrupted" , "failed" , "timed_out"]
+AudioCodec = Literal["opus" , "aac"]
+class Avatar(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  name: str = Field(serialization_alias = "name", alias = "name")
+  created_at: str | None = Field(serialization_alias = "createdAt", alias = "createdAt", default = None)
+  image_url: str | None = Field(serialization_alias = "imageUrl", alias = "imageUrl", default = None)
+  is_custom: bool = Field(serialization_alias = "isCustom", alias = "isCustom")
+
+LemonSliceImageState = Literal["awaiting_upload" , "uploaded" , "failed"]
+class ErrorInfo(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  code: str = Field(serialization_alias = "code", alias = "code")
+  message: str = Field(serialization_alias = "message", alias = "message")
+  fields: list[str] | None = Field(serialization_alias = "fields", alias = "fields", default = None)
+
+class BoundingBox(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  top: float = Field(serialization_alias = "top", alias = "top")
+  left: float = Field(serialization_alias = "left", alias = "left")
+  width: float = Field(serialization_alias = "width", alias = "width")
+  height: float = Field(serialization_alias = "height", alias = "height")
+
+class TrustedParticipantIdentities(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  orchestrator: str = Field(serialization_alias = "orchestrator", alias = "orchestrator")
+  avatar: str = Field(serialization_alias = "avatar", alias = "avatar")
+
+class BrowserSessionError(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  code: str = Field(serialization_alias = "code", alias = "code")
+  message: str = Field(serialization_alias = "message", alias = "message")
+  retryable: bool = Field(serialization_alias = "retryable", alias = "retryable")
+
+class City(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  name: str | None = Field(serialization_alias = "name", alias = "name", default = None)
+  geo_name_id: int | None = Field(serialization_alias = "geoNameId", alias = "geoNameId", default = None)
+  confidence: int | None = Field(serialization_alias = "confidence", alias = "confidence", default = None)
+
+class ConversationOutcome(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # Description of the condition to end the conversation and go to the mapped target
+  condition: str | None = Field(serialization_alias = "condition", alias = "condition", default = None)
+  # Once this data is collected go to the mapped target
+  collect: list[str] | None = Field(serialization_alias = "collect", alias = "collect", default = None)
+  # Node key to go to when the outcome matches
+  target: str = Field(serialization_alias = "target", alias = "target")
+
+ConversationRealtimeMode = Literal["listening" , "thinking" , "speaking" , "terminating" , "terminal"]
+SessionStatus = Literal["created" , "in_progress" , "complete" , "incomplete"]
+SessionTerminalReasonCode = Literal["queue_publish_failed" , "processor_startup_failed" , "worker_crashed" , "flow_failed" , "media_failed" , "disconnect_grace_expired" , "join_timeout" , "session_timeout" , "cancelled_by_user" , "cancelled_by_tenant" , "service_shutdown" , "internal_error" , "legacy_unclassified"]
+class ConversationTranscriptEntry(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  speaker: str = Field(serialization_alias = "speaker", alias = "speaker")
+  text: str = Field(serialization_alias = "text", alias = "text")
+
+class Country(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  iso_code: str | None = Field(serialization_alias = "isoCode", alias = "isoCode", default = None)
+  name: str | None = Field(serialization_alias = "name", alias = "name", default = None)
+  names: dict[str, str] | None = Field(serialization_alias = "names", alias = "names", default = None)
+  geo_name_id: int | None = Field(serialization_alias = "geoNameId", alias = "geoNameId", default = None)
+  confidence: int | None = Field(serialization_alias = "confidence", alias = "confidence", default = None)
+
+class CreatedAvatar(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  upload_url: str = Field(serialization_alias = "uploadUrl", alias = "uploadUrl")
+  blob_key: str = Field(serialization_alias = "blobKey", alias = "blobKey")
+
+class CreateSessionPropRequest(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  name: str = Field(serialization_alias = "name", alias = "name")
+  value: str = Field(serialization_alias = "value", alias = "value")
+
+class CreateUserApiKeyRequest(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  name: str = Field(serialization_alias = "name", alias = "name")
+  organization_id: str | None = Field(serialization_alias = "organizationId", alias = "organizationId", default = None)
+  permissions: list[str] | None = Field(serialization_alias = "permissions", alias = "permissions", default = None)
+
+class ExpressionOutcomes(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # Which node to go to when the expression evaluated to a truthy value
+  true: str = Field(serialization_alias = "true", alias = "true")
+  # Which node to go to when the expression evaluated to a falsy value
+  false: str = Field(serialization_alias = "false", alias = "false")
+
+class ExtractionDefinition(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "type", alias = "type")
+  description: str = Field(serialization_alias = "description", alias = "description")
+
+class GenderFaceFeature(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  value: str = Field(serialization_alias = "value", alias = "value")
+
+class FaceRecognitionOutcomes(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # The user matches a known face
+  match_1: str | None = Field(serialization_alias = "match", alias = "match", default = None)
+  # No matched user is found
+  no_match: str | None = Field(serialization_alias = "no_match", alias = "no_match", default = None)
+  # No face is detected
+  no_face: str | None = Field(serialization_alias = "no_face", alias = "no_face", default = None)
+
+class TurnGenerationOptions(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # Instruct the assistant's AI, in plain english to generate the speech. Use this when the speech need to be generated on the fly to be relevant to the conversation
+  instruction: str | None = Field(serialization_alias = "instruction", alias = "instruction", default = None)
+  # Text the assistant should speakm in English. Variable substitution is supported and text will be translated to the user's language on demand
+  template: str | None = Field(serialization_alias = "template", alias = "template", default = None)
+  # Provide a set of verbatim speech, in different languages, for the assistant to speak. If provided, all requested languages must be provided. No variable substitution of translation is applied
+  verbatim: dict[str, str] | None = Field(serialization_alias = "verbatim", alias = "verbatim", default = None)
+
+class VerificationCodeOutcomes(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # The user provided the correct code back
+  verified: str = Field(serialization_alias = "verified", alias = "verified")
+  # The code could not be sent to the user
+  delivery_failed: str | None = Field(serialization_alias = "delivery_failed", alias = "delivery_failed", default = None)
+  # The user failed to provide the correct code after all attempts
+  unverified: str = Field(serialization_alias = "unverified", alias = "unverified")
+  # The user cancelled the verification
+  cancelled: str | None = Field(serialization_alias = "cancelled", alias = "cancelled", default = None)
+
+class LivenessOutcomes(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # Live person is confirmed
+  authentic: str | None = Field(serialization_alias = "authentic", alias = "authentic", default = None)
+  # Deepfake or replay attack detected
+  synthetic: str | None = Field(serialization_alias = "synthetic", alias = "synthetic", default = None)
+  # No face was found in frames
+  no_face: str | None = Field(serialization_alias = "no_face", alias = "no_face", default = None)
+
+class UsageDetails(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  input_token_count: int | None = Field(serialization_alias = "inputTokenCount", alias = "inputTokenCount", default = None)
+  output_token_count: int | None = Field(serialization_alias = "outputTokenCount", alias = "outputTokenCount", default = None)
+  total_token_count: int | None = Field(serialization_alias = "totalTokenCount", alias = "totalTokenCount", default = None)
+  cached_input_token_count: int | None = Field(serialization_alias = "cachedInputTokenCount", alias = "cachedInputTokenCount", default = None)
+  reasoning_token_count: int | None = Field(serialization_alias = "reasoningTokenCount", alias = "reasoningTokenCount", default = None)
+  input_audio_token_count: int | None = Field(serialization_alias = "inputAudioTokenCount", alias = "inputAudioTokenCount", default = None)
+  input_text_token_count: int | None = Field(serialization_alias = "inputTextTokenCount", alias = "inputTextTokenCount", default = None)
+  output_audio_token_count: int | None = Field(serialization_alias = "outputAudioTokenCount", alias = "outputAudioTokenCount", default = None)
+  output_text_token_count: int | None = Field(serialization_alias = "outputTextTokenCount", alias = "outputTextTokenCount", default = None)
+  additional_counts: dict[str, int] | None = Field(serialization_alias = "additionalCounts", alias = "additionalCounts", default = None)
+
+IdentityContactType = Literal["email" , "phone"]
+class PaginationInfo(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  page: int | None = Field(serialization_alias = "page", alias = "page", default = None)
+  page_size: int | None = Field(serialization_alias = "pageSize", alias = "pageSize", default = None)
+  total_count: int | None = Field(serialization_alias = "totalCount", alias = "totalCount", default = None)
+  total_pages: int | None = Field(serialization_alias = "totalPages", alias = "totalPages", default = None)
+
+class User(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  first_name: str = Field(serialization_alias = "firstName", alias = "firstName")
+  last_name: str = Field(serialization_alias = "lastName", alias = "lastName")
+  email: str = Field(serialization_alias = "email", alias = "email")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  role: str = Field(serialization_alias = "role", alias = "role")
+
+LivenessProvider = Literal["face_intel" , "llm"]
+ParticipantRole = int
+class PostAvatarImageRequest(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  name: str = Field(serialization_alias = "name", alias = "name")
+  image_width: int = Field(serialization_alias = "imageWidth", alias = "imageWidth")
+  image_height: int = Field(serialization_alias = "imageHeight", alias = "imageHeight")
+  image_mime_type: str = Field(serialization_alias = "imageMimeType", alias = "imageMimeType")
+  image_size: int = Field(serialization_alias = "imageSize", alias = "imageSize")
+
+SessionEventType = Literal["created" , "started" , "complete" , "incomplete" , "user_connected" , "user_disconnected" , "assistant_connected" , "assistant_disconnected" , "flow_node_transition" , "flow_node_wait" , "user_data_input" , "assistant_speak" , "assistant_speech_terminal" , "assistant_idle"]
+class SessionFlowAvatar(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: str | None = Field(serialization_alias = "id", alias = "id", default = None)
+
+class SessionFlowVoice(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: str | None = Field(serialization_alias = "id", alias = "id", default = None)
+
+class UtteranceWord(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  start: float = Field(serialization_alias = "start", alias = "start")
+  end: float = Field(serialization_alias = "end", alias = "end")
+  punctuated_word: str | None = Field(serialization_alias = "punctuatedWord", alias = "punctuatedWord", default = None)
+  heard_word: str = Field(serialization_alias = "heardWord", alias = "heardWord")
+
+VideoCodec = Literal["vp8" , "vp9"]
+VideoContainer = Literal["webm"]
+class AssistantSpeechStateVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  speech_id: uuid.UUID = Field(serialization_alias = "speech_id", alias = "speech_id")
+  turn_generation_id: int = Field(serialization_alias = "turn_generation_id", alias = "turn_generation_id")
+  speech_generation_id: int = Field(serialization_alias = "speech_generation_id", alias = "speech_generation_id")
+  revision: int = Field(serialization_alias = "revision", alias = "revision")
+  status: AssistantSpeechRealtimeStatus = Field(serialization_alias = "status", alias = "status")
+  generated_text: str = Field(serialization_alias = "generated_text", alias = "generated_text")
+  delivered_text: str | None = Field(serialization_alias = "delivered_text", alias = "delivered_text", default = None)
+  delivery_extent: AssistantSpeechDeliveryExtent = Field(serialization_alias = "delivery_extent", alias = "delivery_extent")
+  start_offset_ms: int | None = Field(serialization_alias = "start_offset_ms", alias = "start_offset_ms", default = None)
+  end_offset_ms: int | None = Field(serialization_alias = "end_offset_ms", alias = "end_offset_ms", default = None)
+  estimated_played_duration_ms: int | None = Field(serialization_alias = "estimated_played_duration_ms", alias = "estimated_played_duration_ms", default = None)
+
+class AvatarConfigEntityBase(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  preview_blob_key: str | None = Field(serialization_alias = "preview_blob_key", alias = "preview_blob_key", default = None)
+
+class AvatarConfigEntityLiveAvatarConfigEntity(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "$type", alias = "$type")
+  id: str = Field(serialization_alias = "id", alias = "id")
+  preview_blob_key: str | None = Field(serialization_alias = "preview_blob_key", alias = "preview_blob_key", default = None)
+
+class AvatarConfigEntityLemonSliceAgentConfigEntity(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "$type", alias = "$type")
+  id: str = Field(serialization_alias = "id", alias = "id")
+  preview_blob_key: str | None = Field(serialization_alias = "preview_blob_key", alias = "preview_blob_key", default = None)
+
+class AvatarConfigEntityLemonSliceImageConfigEntity(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "$type", alias = "$type")
+  blob_key: str = Field(serialization_alias = "blob_key", alias = "blob_key")
+  state: LemonSliceImageState | None = Field(serialization_alias = "state", alias = "state", default = None)
+  preview_blob_key: str | None = Field(serialization_alias = "preview_blob_key", alias = "preview_blob_key", default = None)
+
+AvatarConfigEntity = AvatarConfigEntityLiveAvatarConfigEntity | AvatarConfigEntityLemonSliceAgentConfigEntity | AvatarConfigEntityLemonSliceImageConfigEntity
+
+class AvatarResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: Avatar | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class CreateApiKeyResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: ApiKey | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class ErrorResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: list[ErrorInfo] | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class GetDemoReportResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: str | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class BrowserSessionBootstrap(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  contract_version: int | None = Field(serialization_alias = "contractVersion", alias = "contractVersion", default = None)
+  session_id: uuid.UUID = Field(serialization_alias = "sessionId", alias = "sessionId")
+  language: str = Field(serialization_alias = "language", alias = "language")
+  room_url: str = Field(serialization_alias = "roomUrl", alias = "roomUrl")
+  room_token: str = Field(serialization_alias = "roomToken", alias = "roomToken")
+  trusted_participants: TrustedParticipantIdentities = Field(serialization_alias = "trustedParticipants", alias = "trustedParticipants")
+  allowed_embed_origins: list[str] = Field(serialization_alias = "allowedEmbedOrigins", alias = "allowedEmbedOrigins")
+
+class BrowserSessionErrorResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  error: BrowserSessionError = Field(serialization_alias = "error", alias = "error")
+
+class ConversationSessionTerminalState(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  status: SessionStatus = Field(serialization_alias = "status", alias = "status")
+  reason_code: SessionTerminalReasonCode | None = Field(serialization_alias = "reason_code", alias = "reason_code", default = None)
+
+class SessionEventMetadataFlowNodeTransitionEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  from_1: str | None = Field(serialization_alias = "from", alias = "from", default = None)
+  to: str | None = Field(serialization_alias = "to", alias = "to", default = None)
+
+class SessionEventMetadataFlowNodeWaitEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  node_id: str = Field(serialization_alias = "nodeId", alias = "nodeId")
+
+class SessionEventMetadataAssistantSpeakEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  speech_id: uuid.UUID | None = Field(serialization_alias = "speechId", alias = "speechId", default = None)
+  turn_generation_id: int | None = Field(serialization_alias = "turnGenerationId", alias = "turnGenerationId", default = None)
+  speech_generation_id: int | None = Field(serialization_alias = "speechGenerationId", alias = "speechGenerationId", default = None)
+
+class SessionEventMetadataAssistantSpeechTerminalEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  speech_id: uuid.UUID = Field(serialization_alias = "speechId", alias = "speechId")
+  turn_generation_id: int = Field(serialization_alias = "turnGenerationId", alias = "turnGenerationId")
+  speech_generation_id: int = Field(serialization_alias = "speechGenerationId", alias = "speechGenerationId")
+  terminal_status: AssistantSpeechTerminalStatus = Field(serialization_alias = "terminalStatus", alias = "terminalStatus")
+  delivery_extent: AssistantSpeechDeliveryExtent = Field(serialization_alias = "deliveryExtent", alias = "deliveryExtent")
+  generated_text: str = Field(serialization_alias = "generatedText", alias = "generatedText")
+  delivered_text: str | None = Field(serialization_alias = "deliveredText", alias = "deliveredText", default = None)
+  estimated_played_duration_ms: int | None = Field(serialization_alias = "estimatedPlayedDurationMs", alias = "estimatedPlayedDurationMs", default = None)
+  evidence_quality: AssistantSpeechEvidenceQuality = Field(serialization_alias = "evidenceQuality", alias = "evidenceQuality")
+  reason_code: AssistantSpeechTerminalReasonCode = Field(serialization_alias = "reasonCode", alias = "reasonCode")
+
+class SessionEventMetadataAssistantIdleEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataUserDataInputEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  field_name: str | None = Field(serialization_alias = "fieldName", alias = "fieldName", default = None)
+  value: str | None = Field(serialization_alias = "value", alias = "value", default = None)
+
+class SessionEventMetadataCreatedEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataStartedEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataCompleteEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataIncompleteEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+  reason_code: SessionTerminalReasonCode | None = Field(serialization_alias = "reasonCode", alias = "reasonCode", default = None)
+
+class SessionEventMetadataConnectedEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataDisconnectedEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+class SessionEventMetadataEmptyEventMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "$type", alias = "$type", default = None)
+
+SessionEventMetadata = SessionEventMetadataFlowNodeTransitionEventMetadata | SessionEventMetadataFlowNodeWaitEventMetadata | SessionEventMetadataAssistantSpeakEventMetadata | SessionEventMetadataAssistantSpeechTerminalEventMetadata | SessionEventMetadataAssistantIdleEventMetadata | SessionEventMetadataUserDataInputEventMetadata | SessionEventMetadataCreatedEventMetadata | SessionEventMetadataStartedEventMetadata | SessionEventMetadataCompleteEventMetadata | SessionEventMetadataIncompleteEventMetadata | SessionEventMetadataConnectedEventMetadata | SessionEventMetadataDisconnectedEventMetadata | SessionEventMetadataEmptyEventMetadata
+
+class IpInfo(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  ip: str = Field(serialization_alias = "ip", alias = "ip")
+  country: Country | None = Field(serialization_alias = "country", alias = "country", default = None)
+  region: str | None = Field(serialization_alias = "region", alias = "region", default = None)
+  region_name: str | None = Field(serialization_alias = "regionName", alias = "regionName", default = None)
+  city: City | None = Field(serialization_alias = "city", alias = "city", default = None)
+  postal_code: str | None = Field(serialization_alias = "postalCode", alias = "postalCode", default = None)
+  latitude: float | None = Field(serialization_alias = "latitude", alias = "latitude", default = None)
+  longitude: float | None = Field(serialization_alias = "longitude", alias = "longitude", default = None)
+  timezone: str | None = Field(serialization_alias = "timezone", alias = "timezone", default = None)
+  organization: str | None = Field(serialization_alias = "organization", alias = "organization", default = None)
+
+class PostAvatarImageResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: CreatedAvatar | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class FaceFeatures(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  age_range: AgeRangeFaceFeature = Field(serialization_alias = "ageRange", alias = "ageRange")
+  gender: GenderFaceFeature = Field(serialization_alias = "gender", alias = "gender")
+
+class FlowNodeConversationFlowNode(BaseModel):
+  """Communicate with the user using an AI-powered conversational turn. Instruct the assistant to say or ask the user something and route the flow based on the user's response.
+  
+  Use `answers` to categorize the user answer, then use the answer to route the flow through `outcomes`
+  Ommiting `answers` and using the `any` key in outcomes skips waiting for a user answer
+  
+  You can also collect data using the `collect` key.
+  Example:
+  {
+    "type": "conversation",
+    "generation": {
+      "template": "Hi, let's get you started"
+    },
+    "outcome": "next_node"
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  generation: TurnGenerationOptions = Field(serialization_alias = "generation", alias = "generation")
+  timeout_generation: TurnGenerationOptions | None = Field(serialization_alias = "timeout_generation", alias = "timeout_generation", default = None)
+  # How many seconds the Assistant will wait until it nudges the user
+  timeout_seconds: int | None = Field(serialization_alias = "timeout_seconds", alias = "timeout_seconds", default = None)
+  # Key-value pairs of answers and their matching next node. Keys must match one of the keys in "answers", or be "any"
+  outcomes: dict[str, ConversationOutcome] | None = Field(serialization_alias = "outcomes", alias = "outcomes", default = None)
+  # Set this proeprty to end the conversation after the assistant speech, without waiting for a user reply
+  outcome: str | None = Field(serialization_alias = "outcome", alias = "outcome", default = None)
+  timeout_outcome: str | None = Field(serialization_alias = "timeout_outcome", alias = "timeout_outcome", default = None)
+
+class FlowNodeEmail2faFlowNode(BaseModel):
+  """Send a verification code by email. The assistant will ask the user to read the code out loud and verify that the it matches.
+  Example:
+  {
+    "type": "two_factor_email",
+    "code_length": 6,
+    "max_retries": 3,
+    "subject": "Your Verification Code",
+    "outcomes": {
+      "verified": "success",
+      "unverified": "fail",
+      "delivery_failed": "fail",
+      "cancelled": "fail"
+    }
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: VerificationCodeOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  generation: TurnGenerationOptions | None = Field(serialization_alias = "generation", alias = "generation", default = None)
+  # How many digits in the code that will be sent. Default to 6
+  code_length: int | None = Field(serialization_alias = "code_length", alias = "code_length", default = None)
+  # Once the number of tries reaches this number, the outcome of the node will be 'unverified'
+  max_retries: int | None = Field(serialization_alias = "max_retries", alias = "max_retries", default = None)
+  # Subject line for the sent email
+  subject: str | None = Field(serialization_alias = "subject", alias = "subject", default = None)
+
+class FlowNodeSms2faFlowNode(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+
+class FlowNodeOnScreenCodeFlowNode(BaseModel):
+  """Example:
+  {
+    "type": "on_screen_code",
+    "code_length": 6,
+    "max_retries": 3,
+    "outcomes": {
+      "verified": "success",
+      "unverified": "fail",
+      "delivery_failed": "fail",
+      "cancelled": "fail"
+    }
+  }
+  
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: VerificationCodeOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  generation: TurnGenerationOptions | None = Field(serialization_alias = "generation", alias = "generation", default = None)
+  # How many digits in the code that will be sent. Default to 6
+  code_length: int | None = Field(serialization_alias = "code_length", alias = "code_length", default = None)
+  # Once the number of tries reaches this number, the outcome of the node will be 'unverified'
+  max_retries: int | None = Field(serialization_alias = "max_retries", alias = "max_retries", default = None)
+
+class FlowNodeCustomCodeFlowNode(BaseModel):
+  """Example:
+  {
+    "type": "custom_code",
+    "code_source": "props.code",
+    "max_retries": 3,
+    "outcomes": {
+      "verified": "success",
+      "unverified": "fail",
+      "delivery_failed": "fail",
+      "cancelled": "fail"
+    }
+  }
+  
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: VerificationCodeOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  sent_generation: TurnGenerationOptions = Field(serialization_alias = "sent_generation", alias = "sent_generation")
+  retry_generation: TurnGenerationOptions | None = Field(serialization_alias = "retry_generation", alias = "retry_generation", default = None)
+  code_not_ready_generation: TurnGenerationOptions | None = Field(serialization_alias = "code_not_ready_generation", alias = "code_not_ready_generation", default = None)
+  # Where you provide the code. Usually 'props', set at session creation or updated after the session starts. e.g. "props.code"
+  code_source: str = Field(serialization_alias = "code_source", alias = "code_source")
+  # Once the number of tries reaches this number, the outcome of the node will be 'unverified'
+  max_retries: int | None = Field(serialization_alias = "max_retries", alias = "max_retries", default = None)
+
+class FlowNodeLivenessFlowNode(BaseModel):
+  """Example:
+  {
+    "type": "liveness",
+    "outcomes": {
+      "authentic": "success",
+      "synthetic": "fail",
+      "no_face": "fail"
+    }
+  }
+  
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: LivenessOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  # Score threshold for the liveness assessment. Route to the authentic outcome if equal or above the threshold, route to the synthetic outcome if under
+  threshold: float | None = Field(serialization_alias = "threshold", alias = "threshold", default = None)
+  # Minimum number of frames that need to be analyzed before making a determination. If this node is reached before the minimum number of frames was analyzed, the user will be prompted to wait while the analysis completes. See wait_generation to configure the generated Assistant message.
+  min_frames_analyzed: int | None = Field(serialization_alias = "min_frames_analyzed", alias = "min_frames_analyzed", default = None)
+  wait_generation: TurnGenerationOptions | None = Field(serialization_alias = "wait_generation", alias = "wait_generation", default = None)
+
+class FlowNodeFaceRecognitionFlowNode(BaseModel):
+  """Find a known identity using facial recognition.
+  
+  This will find candidates identities in the database based on the faces analyzed during the session so far.
+  From there you can do 2 things:
+   - Confirm the candidate is correct by asking the user
+   - Save the candidate identity id
+  
+  When using the confirmation turn, you can customize the question the assistant ask using the TurnGenerationOptions as `confirmation_generation`. This lets you configure the assistant instruction to generate the conversation turn, or directly provide text.
+  If you do not provide text in the language the session expects, the assistant will translate from the languages you did provide.
+  You can use variable substitution in the text. The candidate identity information will be made available under `candidate_identity`
+  
+  The assistant will analyze the user response and categorize it into `agreed`, `disagreed` and `other`. Make sure the turn text you provide or generate prompts the user to reply in a way that fits those categories.
+  Example:
+  {
+    "recognition": {
+      "type": "face_recognition",
+      "outcomes": {
+        "match": "foo",
+        "no_match": "bar",
+        "no_face": "baz"
+      }
+    }
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: FaceRecognitionOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  # Minimum similarity score required for an identity to match a face
+  threshold: float | None = Field(serialization_alias = "threshold", alias = "threshold", default = None)
+  confirmation_generation: TurnGenerationOptions | None = Field(serialization_alias = "confirmation_generation", alias = "confirmation_generation", default = None)
+  # Where to save the candidate identity. If provided, the Assistant will not confirm the user identity
+  save_as: str | None = Field(serialization_alias = "save_as", alias = "save_as", default = None)
+
+class FlowNodeCollectUserDataFlowNode(BaseModel):
+  """Example:
+  {
+    "type": "collect_user_data",
+    "label": "Email",
+    "input_type": "email",
+    "save_as": "identity.email",
+    "outcome": "closing"
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  # Label displayed in the form UI
+  label: str = Field(serialization_alias = "label", alias = "label")
+  # Type used for form UI input. Possible values are: email, number, tel, text
+  input_type: str = Field(serialization_alias = "input_type", alias = "input_type")
+  # Where to save the collected data
+  save_as: str = Field(serialization_alias = "save_as", alias = "save_as")
+  # Which node to go to after the user provided the requested data
+  outcome: str = Field(serialization_alias = "outcome", alias = "outcome")
+
+class FlowNodeExpressionFlowNode(BaseModel):
+  """Example:
+  {
+    "type": "expression",
+    "expression": "state.collected_amount == props.transfer_amount",
+    "outcomes": {
+      "true": "success",
+      "false": "failure"
+    }
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  outcomes: ExpressionOutcomes = Field(serialization_alias = "outcomes", alias = "outcomes")
+  # JavaScript expression. Native JavaScript functions like `parseInt` and toLowerCase are available.
+  expression: str = Field(serialization_alias = "expression", alias = "expression")
+
+class FlowNodeStartFlowNode(BaseModel):
+  """Entry point of the Verification flow. Exactly one instance of this node must be present and it must provide an `outcome` that points to the key of a node in the flow
+  Example:
+  {
+    "start": {
+      "type": "start",
+      "outcome": "my_first_node"
+    }
+  }
+  
+  """
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  # First node of the flow
+  outcome: str = Field(serialization_alias = "outcome", alias = "outcome")
+
+class FlowNodeEndFlowNode(BaseModel):
+  """Exit node of the flow. Exactly one instance of this node must be present. Use the key of the node route other nodes to the end of the flow"""
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+
+FlowNode = FlowNodeConversationFlowNode | FlowNodeEmail2faFlowNode | FlowNodeSms2faFlowNode | FlowNodeOnScreenCodeFlowNode | FlowNodeCustomCodeFlowNode | FlowNodeLivenessFlowNode | FlowNodeFaceRecognitionFlowNode | FlowNodeCollectUserDataFlowNode | FlowNodeExpressionFlowNode | FlowNodeStartFlowNode | FlowNodeEndFlowNode
+
+class FrameAnalysisBase(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  score: float = Field(serialization_alias = "score", alias = "score")
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  created_at: str = Field(serialization_alias = "created_at", alias = "created_at")
+  version: str = Field(serialization_alias = "version", alias = "version")
+  duration_ms: int = Field(serialization_alias = "duration_ms", alias = "duration_ms")
+
+class FrameAnalysisFaceIntelFrameAnalysis(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "$type", alias = "$type")
+  ela_score: float = Field(serialization_alias = "ela_score", alias = "ela_score")
+  source_score: float = Field(serialization_alias = "source_score", alias = "source_score")
+  score: float = Field(serialization_alias = "score", alias = "score")
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  created_at: str = Field(serialization_alias = "created_at", alias = "created_at")
+  version: str = Field(serialization_alias = "version", alias = "version")
+  duration_ms: int = Field(serialization_alias = "duration_ms", alias = "duration_ms")
+
+class FrameAnalysisLlmFrameAnalysis(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str = Field(serialization_alias = "$type", alias = "$type")
+  short_description: str = Field(serialization_alias = "short_description", alias = "short_description")
+  long_description: str = Field(serialization_alias = "long_description", alias = "long_description")
+  model_key: str = Field(serialization_alias = "model_key", alias = "model_key")
+  usage: UsageDetails = Field(serialization_alias = "usage", alias = "usage")
+  score: float = Field(serialization_alias = "score", alias = "score")
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  created_at: str = Field(serialization_alias = "created_at", alias = "created_at")
+  version: str = Field(serialization_alias = "version", alias = "version")
+  duration_ms: int = Field(serialization_alias = "duration_ms", alias = "duration_ms")
+
+FrameAnalysis = FrameAnalysisFaceIntelFrameAnalysis | FrameAnalysisLlmFrameAnalysis
+
+class IdentityContact(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: IdentityContactType = Field(serialization_alias = "type", alias = "type")
+  value: str = Field(serialization_alias = "value", alias = "value")
+
+class ListApiKeyResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: list[ApiKey] | None = Field(serialization_alias = "data", alias = "data", default = None)
+  pagination: PaginationInfo | None = Field(serialization_alias = "pagination", alias = "pagination", default = None)
+
+class ListAvatarsResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: list[Avatar] | None = Field(serialization_alias = "data", alias = "data", default = None)
+  pagination: PaginationInfo | None = Field(serialization_alias = "pagination", alias = "pagination", default = None)
+
+class ListUsersResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: list[User] | None = Field(serialization_alias = "data", alias = "data", default = None)
+  pagination: PaginationInfo | None = Field(serialization_alias = "pagination", alias = "pagination", default = None)
+
+class LivenessAnalysisSummary(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  frame_count: int = Field(serialization_alias = "frame_count", alias = "frame_count")
+  score: float = Field(serialization_alias = "score", alias = "score")
+  score_without_outliers: float = Field(serialization_alias = "score_without_outliers", alias = "score_without_outliers")
+  providers: list[LivenessProvider] = Field(serialization_alias = "providers", alias = "providers")
+
+class SessionFlow(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  avatar: SessionFlowAvatar | None = Field(serialization_alias = "avatar", alias = "avatar", default = None)
+  voice: SessionFlowVoice | None = Field(serialization_alias = "voice", alias = "voice", default = None)
+  # List of filler words for the assistant to say to acknowledge the user's sentences. Grouped by language. For each time the user says something, the assistant will pick a random word from the list for the language of the user and speak it When left empty, the assistant doesn't use filler words. Empty by default
+  filler_words: dict[str, list[str]] | None = Field(serialization_alias = "filler_words", alias = "filler_words", default = None)
+  nodes: dict[str, FlowNode] | None = Field(serialization_alias = "nodes", alias = "nodes", default = None)
+  # Use this to expose any data that the verification flow may need during the session. This will be exposed to any node supporting variable substitution under `props` Nested objects are supported.
+  props: dict[str, object | None] | None = Field(serialization_alias = "props", alias = "props", default = None)
+  extract: dict[str, ExtractionDefinition] | None = Field(serialization_alias = "extract", alias = "extract", default = None)
+
+class Utterance(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  session_id: uuid.UUID = Field(serialization_alias = "sessionId", alias = "sessionId")
+  role: ParticipantRole = Field(serialization_alias = "role", alias = "role")
+  start_offset_ms: int = Field(serialization_alias = "startOffsetMs", alias = "startOffsetMs")
+  end_offset_ms: int = Field(serialization_alias = "endOffsetMs", alias = "endOffsetMs")
+  transcript: str = Field(serialization_alias = "transcript", alias = "transcript")
+  created_at: str | None = Field(serialization_alias = "createdAt", alias = "createdAt", default = None)
+  words: list[UtteranceWord] | None = Field(serialization_alias = "words", alias = "words", default = None)
+
+class VideoMetadata(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  frame_count: int | None = Field(serialization_alias = "frameCount", alias = "frameCount", default = None)
+  duration_us: int | None = Field(serialization_alias = "durationUs", alias = "durationUs", default = None)
+  frame_rate: int | None = Field(serialization_alias = "frameRate", alias = "frameRate", default = None)
+  container: VideoContainer | None = Field(serialization_alias = "container", alias = "container", default = None)
+  video_codec: VideoCodec | None = Field(serialization_alias = "videoCodec", alias = "videoCodec", default = None)
+  audio_codec: AudioCodec | None = Field(serialization_alias = "audioCodec", alias = "audioCodec", default = None)
+
+class UpdateAvatarRequest(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  name: str | None = Field(serialization_alias = "name", alias = "name", default = None)
+  config: AvatarConfigEntity | None = Field(serialization_alias = "config", alias = "config", default = None)
+
+class StartSessionResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: BrowserSessionBootstrap | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class IVerificationMessageShowUiVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transaction_id: uuid.UUID = Field(serialization_alias = "transaction_id", alias = "transaction_id")
+  input_type: str = Field(serialization_alias = "input_type", alias = "input_type")
+  label: str = Field(serialization_alias = "label", alias = "label")
+
+class IVerificationMessageUserCollectedDataVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transaction_id: uuid.UUID = Field(serialization_alias = "transaction_id", alias = "transaction_id")
+  value: str = Field(serialization_alias = "value", alias = "value")
+
+class IVerificationMessageUserSimulatedUtteranceVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transcript: str = Field(serialization_alias = "transcript", alias = "transcript")
+
+class IVerificationMessageAvatarPlaybackReadyVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+
+class IVerificationMessageUserCancelledVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+
+class IVerificationMessageShowCodeVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transaction_id: uuid.UUID = Field(serialization_alias = "transaction_id", alias = "transaction_id")
+  code: str = Field(serialization_alias = "code", alias = "code")
+
+class IVerificationMessageHideCodeVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transaction_id: uuid.UUID = Field(serialization_alias = "transaction_id", alias = "transaction_id")
+
+class IVerificationMessageSessionEndedVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  redirect_to: str | None = Field(serialization_alias = "redirect_to", alias = "redirect_to", default = None)
+
+class IVerificationMessageUserUtteranceInterimVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  transcript: str = Field(serialization_alias = "transcript", alias = "transcript")
+
+class IVerificationMessageUserUtteranceVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  transcript: str = Field(serialization_alias = "transcript", alias = "transcript")
+
+class IVerificationMessageConversationTranscriptVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  entries: list[ConversationTranscriptEntry] = Field(serialization_alias = "entries", alias = "entries")
+
+class IVerificationMessageAssistantSpeechStateVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  speech_id: uuid.UUID = Field(serialization_alias = "speech_id", alias = "speech_id")
+  turn_generation_id: int = Field(serialization_alias = "turn_generation_id", alias = "turn_generation_id")
+  speech_generation_id: int = Field(serialization_alias = "speech_generation_id", alias = "speech_generation_id")
+  revision: int = Field(serialization_alias = "revision", alias = "revision")
+  status: AssistantSpeechRealtimeStatus = Field(serialization_alias = "status", alias = "status")
+  generated_text: str = Field(serialization_alias = "generated_text", alias = "generated_text")
+  delivered_text: str | None = Field(serialization_alias = "delivered_text", alias = "delivered_text", default = None)
+  delivery_extent: AssistantSpeechDeliveryExtent = Field(serialization_alias = "delivery_extent", alias = "delivery_extent")
+  start_offset_ms: int | None = Field(serialization_alias = "start_offset_ms", alias = "start_offset_ms", default = None)
+  end_offset_ms: int | None = Field(serialization_alias = "end_offset_ms", alias = "end_offset_ms", default = None)
+  estimated_played_duration_ms: int | None = Field(serialization_alias = "estimated_played_duration_ms", alias = "estimated_played_duration_ms", default = None)
+
+class IVerificationMessageConversationSnapshotAvailableVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  version: int = Field(serialization_alias = "version", alias = "version")
+
+class IVerificationMessageConversationSnapshotRequestVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  version: int = Field(serialization_alias = "version", alias = "version")
+  client_instance_id: uuid.UUID = Field(serialization_alias = "client_instance_id", alias = "client_instance_id")
+  request_id: int = Field(serialization_alias = "request_id", alias = "request_id")
+
+class IVerificationMessageConversationSnapshotVerificationMessage(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  type: str | None = Field(serialization_alias = "type", alias = "type", default = None)
+  version: int = Field(serialization_alias = "version", alias = "version")
+  client_instance_id: uuid.UUID = Field(serialization_alias = "client_instance_id", alias = "client_instance_id")
+  request_id: int = Field(serialization_alias = "request_id", alias = "request_id")
+  mode: ConversationRealtimeMode = Field(serialization_alias = "mode", alias = "mode")
+  active_turn_generation_id: int | None = Field(serialization_alias = "active_turn_generation_id", alias = "active_turn_generation_id", default = None)
+  active_speech_id: uuid.UUID | None = Field(serialization_alias = "active_speech_id", alias = "active_speech_id", default = None)
+  active_speech_generation_id: int | None = Field(serialization_alias = "active_speech_generation_id", alias = "active_speech_generation_id", default = None)
+  transcript: list[ConversationTranscriptEntry] = Field(serialization_alias = "transcript", alias = "transcript")
+  assistant_speech: AssistantSpeechStateVerificationMessage | None = Field(serialization_alias = "assistant_speech", alias = "assistant_speech", default = None)
+  session_terminal: ConversationSessionTerminalState | None = Field(serialization_alias = "session_terminal", alias = "session_terminal", default = None)
+
+IVerificationMessage = IVerificationMessageShowUiVerificationMessage | IVerificationMessageUserCollectedDataVerificationMessage | IVerificationMessageUserSimulatedUtteranceVerificationMessage | IVerificationMessageAvatarPlaybackReadyVerificationMessage | IVerificationMessageUserCancelledVerificationMessage | IVerificationMessageShowCodeVerificationMessage | IVerificationMessageHideCodeVerificationMessage | IVerificationMessageSessionEndedVerificationMessage | IVerificationMessageUserUtteranceInterimVerificationMessage | IVerificationMessageUserUtteranceVerificationMessage | IVerificationMessageConversationTranscriptVerificationMessage | IVerificationMessageAssistantSpeechStateVerificationMessage | IVerificationMessageConversationSnapshotAvailableVerificationMessage | IVerificationMessageConversationSnapshotRequestVerificationMessage | IVerificationMessageConversationSnapshotVerificationMessage
+
+class SessionEvent(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  event_type: SessionEventType = Field(serialization_alias = "eventType", alias = "eventType")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  metadata: SessionEventMetadata = Field(serialization_alias = "metadata", alias = "metadata")
+
+class Face(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  bounding_box: BoundingBox = Field(serialization_alias = "boundingBox", alias = "boundingBox")
+  confidence: float = Field(serialization_alias = "confidence", alias = "confidence")
+  identity_id: uuid.UUID | None = Field(serialization_alias = "identityId", alias = "identityId", default = None)
+  features: FaceFeatures | None = Field(serialization_alias = "features", alias = "features", default = None)
+
+class Identity(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  preferred_name: str | None = Field(serialization_alias = "preferredName", alias = "preferredName", default = None)
+  first_name: str | None = Field(serialization_alias = "firstName", alias = "firstName", default = None)
+  last_name: str | None = Field(serialization_alias = "lastName", alias = "lastName", default = None)
+  contacts: list[IdentityContact] = Field(serialization_alias = "contacts", alias = "contacts")
+
+class AnalysisSummary(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  liveness: LivenessAnalysisSummary | None = Field(serialization_alias = "liveness", alias = "liveness", default = None)
+
+class CreateSessionRequest(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  # example: en-US
+  lang: str | None = Field(serialization_alias = "lang", alias = "lang", default = None)
+  flow: SessionFlow = Field(serialization_alias = "flow", alias = "flow")
+  saml_session_id: uuid.UUID | None = Field(serialization_alias = "samlSessionId", alias = "samlSessionId", default = None)
+
+class ListSessionUtterancesResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: list[Utterance] | None = Field(serialization_alias = "data", alias = "data", default = None)
+  pagination: PaginationInfo | None = Field(serialization_alias = "pagination", alias = "pagination", default = None)
+
+class Video(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  started_at: str | None = Field(serialization_alias = "startedAt", alias = "startedAt", default = None)
+  metadata: VideoMetadata | None = Field(serialization_alias = "metadata", alias = "metadata", default = None)
+  url: str | None = Field(serialization_alias = "url", alias = "url", default = None)
+
+class FrameWithFaces(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  analysis: list[FrameAnalysis] | None = Field(serialization_alias = "analysis", alias = "analysis", default = None)
+  timestamp: str = Field(serialization_alias = "timestamp", alias = "timestamp")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  index: int = Field(serialization_alias = "index", alias = "index")
+  url: str | None = Field(serialization_alias = "url", alias = "url", default = None)
+  faces: list[Face] = Field(serialization_alias = "faces", alias = "faces")
+
+class Session(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  started_at: str | None = Field(serialization_alias = "startedAt", alias = "startedAt", default = None)
+  finished_at: str | None = Field(serialization_alias = "finishedAt", alias = "finishedAt", default = None)
+  status: SessionStatus = Field(serialization_alias = "status", alias = "status")
+  room_name: str = Field(serialization_alias = "roomName", alias = "roomName")
+  user_identity: str = Field(serialization_alias = "userIdentity", alias = "userIdentity")
+  ws_url: str = Field(serialization_alias = "wsUrl", alias = "wsUrl")
+  session_duration_seconds: int | None = Field(serialization_alias = "sessionDurationSeconds", alias = "sessionDurationSeconds", default = None)
+  identity: Identity | None = Field(serialization_alias = "identity", alias = "identity", default = None)
+  ip: str | None = Field(serialization_alias = "ip", alias = "ip", default = None)
+  ip_info: IpInfo | None = Field(serialization_alias = "ipInfo", alias = "ipInfo", default = None)
+  analysis_summary: AnalysisSummary | None = Field(serialization_alias = "analysisSummary", alias = "analysisSummary", default = None)
+
+class SessionDetail(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  id: uuid.UUID = Field(serialization_alias = "id", alias = "id")
+  created_at: str = Field(serialization_alias = "createdAt", alias = "createdAt")
+  started_at: str | None = Field(serialization_alias = "startedAt", alias = "startedAt", default = None)
+  finished_at: str | None = Field(serialization_alias = "finishedAt", alias = "finishedAt", default = None)
+  status: SessionStatus = Field(serialization_alias = "status", alias = "status")
+  lang: str = Field(serialization_alias = "lang", alias = "lang")
+  session_duration_seconds: int = Field(serialization_alias = "sessionDurationSeconds", alias = "sessionDurationSeconds")
+  user_duration_seconds: int = Field(serialization_alias = "userDurationSeconds", alias = "userDurationSeconds")
+  assistant_duration_seconds: int = Field(serialization_alias = "assistantDurationSeconds", alias = "assistantDurationSeconds")
+  flow: SessionFlow = Field(serialization_alias = "flow", alias = "flow")
+  events: list[SessionEvent] = Field(serialization_alias = "events", alias = "events")
+  frames: list[FrameWithFaces] = Field(serialization_alias = "frames", alias = "frames")
+  user_video: Video = Field(serialization_alias = "userVideo", alias = "userVideo")
+  avatar_video: Video = Field(serialization_alias = "avatarVideo", alias = "avatarVideo")
+  identity: Identity | None = Field(serialization_alias = "identity", alias = "identity", default = None)
+  ip: str | None = Field(serialization_alias = "ip", alias = "ip", default = None)
+  ip_info: IpInfo | None = Field(serialization_alias = "ipInfo", alias = "ipInfo", default = None)
+  flow_output: dict[str, dict[str, object]] | None = Field(serialization_alias = "flowOutput", alias = "flowOutput", default = None)
+  analysis_summary: AnalysisSummary | None = Field(serialization_alias = "analysisSummary", alias = "analysisSummary", default = None)
+
+class CreatedSession(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  start_session_url: str = Field(serialization_alias = "startSessionUrl", alias = "startSessionUrl")
+  session: Session = Field(serialization_alias = "session", alias = "session")
+
+class GetSessionResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: Session | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class GetSessionDetailResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: SessionDetail | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class CreateSessionResponse(BaseModel):
+  model_config = ConfigDict(populate_by_name = True)
+  is_success: bool | None = Field(serialization_alias = "isSuccess", alias = "isSuccess", default = None)
+  message: str | None = Field(serialization_alias = "message", alias = "message", default = None)
+  errors: list[ErrorInfo] | None = Field(serialization_alias = "errors", alias = "errors", default = None)
+  data: CreatedSession | None = Field(serialization_alias = "data", alias = "data", default = None)
+
+class ClientCredentials(BaseModel):
+  api_key: str | None = None
+  single_use_token: str | None = None
+
+
+class ClientOptions(BaseModel):
+  client: Any | None = None
+  headers: dict[str, str] | None = None
+  base_url: str | None = None
+  creds: ClientCredentials | None = None
+
+@dataclass
+class ClientResponse[TRes, TErr]:
+  status_code: int
+  response_body: str | None = None
+  error: TErr | None = None
+  data: TRes | None = None
+
+class Client:
+  def __init__(self, options: ClientOptions):
+    self.client = options.client or httpx.AsyncClient()
+    self.options = options
+    self.base_url = (options.base_url or "https://api-dev.facesign.ai/").rstrip('/')
+  
+  async def get_user_api_keys(self, user_id: str) -> ClientResponse[ListApiKeyResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/users/{urllib.parse.quote(str(user_id), safe="")}/api-keys", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = ListApiKeyResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def create_user_api_key(self, user_id: str, body: CreateUserApiKeyRequest) -> ClientResponse[CreateApiKeyResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.post(f"{self.base_url}/users/{urllib.parse.quote(str(user_id), safe="")}/api-keys", json=body.model_dump(), headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 201:
+      try:
+        data = CreateApiKeyResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=201)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=201)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def revoke_user_api_key(self, id: str, user_id: str) -> ClientResponse[None, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.delete(f"{self.base_url}/users/{urllib.parse.quote(str(user_id), safe="")}/api-keys/{urllib.parse.quote(str(id), safe="")}", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 204:
+      return ClientResponse(status_code=response.status_code)
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def list_avatars(self) -> ClientResponse[ListAvatarsResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/avatars", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = ListAvatarsResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def create_avatar(self, body: PostAvatarImageRequest) -> ClientResponse[PostAvatarImageResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.post(f"{self.base_url}/avatars", json=body.model_dump(), headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 201:
+      try:
+        data = PostAvatarImageResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=201)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=201)
+      
+
+    if response.status_code == 400:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=400)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=400)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def get_avatar(self, id: uuid.UUID) -> ClientResponse[AvatarResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/avatars/{urllib.parse.quote(str(id), safe="")}", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = AvatarResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def update_avatar(self, id: uuid.UUID, body: UpdateAvatarRequest) -> ClientResponse[AvatarResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.patch(f"{self.base_url}/avatars/{urllib.parse.quote(str(id), safe="")}", json=body.model_dump(), headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = AvatarResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def delete_avatar(self, id: uuid.UUID) -> ClientResponse[None, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.delete(f"{self.base_url}/avatars/{urllib.parse.quote(str(id), safe="")}", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 204:
+      return ClientResponse(status_code=response.status_code)
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def get_demo_report(self, session_id: uuid.UUID) -> ClientResponse[GetDemoReportResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/sessions/{urllib.parse.quote(str(session_id), safe="")}/demo_report", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = GetDemoReportResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def create_session(self, body: CreateSessionRequest) -> ClientResponse[CreateSessionResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.post(f"{self.base_url}/sessions", json=body.model_dump(), headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = CreateSessionResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def start_session(self) -> ClientResponse[StartSessionResponse, BrowserSessionErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.single_use_token:
+      raise Exception("Missing security single_use_token")
+    
+    response = await self.client.post(f"{self.base_url}/sessions/attempts", headers={
+      "Authorization": f"Bearer {creds.single_use_token}",
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = StartSessionResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 404:
+      try:
+        data = BrowserSessionErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    if response.status_code == 500:
+      try:
+        data = BrowserSessionErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    if response.status_code == 503:
+      try:
+        data = BrowserSessionErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=503)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=503)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def create_session_prop(self, id: uuid.UUID, body: CreateSessionPropRequest) -> ClientResponse[None, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.post(f"{self.base_url}/sessions/{urllib.parse.quote(str(id), safe="")}/props", json=body.model_dump(), headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 201:
+      return ClientResponse(status_code=response.status_code)
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def get_session(self, id: uuid.UUID) -> ClientResponse[GetSessionResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/sessions/{urllib.parse.quote(str(id), safe="")}", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = GetSessionResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def get_session_detail(self, session_id: uuid.UUID) -> ClientResponse[GetSessionDetailResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/sessions/{urllib.parse.quote(str(session_id), safe="")}/details", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = GetSessionDetailResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 404:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=404)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=404)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def list_session_utterances(self, session_id: uuid.UUID) -> ClientResponse[ListSessionUtterancesResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/sessions/{urllib.parse.quote(str(session_id), safe="")}/utterances", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = ListSessionUtterancesResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+  async def list_users(self) -> ClientResponse[ListUsersResponse, ErrorResponse]:
+    creds = self.options.creds
+    if creds is None or not creds.api_key:
+      raise Exception("Missing security api_key")
+    
+    response = await self.client.get(f"{self.base_url}/users", headers={
+      "X-API-KEY": creds.api_key,
+    
+    } | (self.options.headers or {}))
+    if response.status_code == 200:
+      try:
+        data = ListUsersResponse.model_validate_json(response.text)
+        return ClientResponse(data=data, status_code=200)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=200)
+      
+
+    if response.status_code == 500:
+      try:
+        data = ErrorResponse.model_validate_json(response.text)
+        return ClientResponse(error=data, status_code=500)
+      
+      except Exception:
+        return ClientResponse(response_body=response.text, status_code=500)
+      
+
+    return ClientResponse(status_code=response.status_code, response_body=response.text)
+
+