# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT. from dataclasses import dataclass from dataclasses import field as dc_field from dataclasses_json import DataClassJsonMixin from dataclasses_json import config as dc_config from datetime import datetime from marshmallow import fields from typing import List, Dict, Optional, Final, NewType from getstream.utils import encode_datetime, datetime_from_unix_ns @dataclass class AIAudioConfigRequest(DataClassJsonMixin): # Bodyguard credentials profile to classify transcripts with. Applies to the NLP engine only; ignored when the policy's engine is LLM. Empty falls back to the app-pinned profile, then the organization's top-level credentials profile: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="profile") ) # Deprecated pre-split rule list. Still the live config while no engine config exists; once one does it is kept as a fallback for whichever engine has none of its own rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) @dataclass class AIAudioConfigResponse(DataClassJsonMixin): # Whether the policy's engine (engine.provider, else the application's LLM configurability flag) has a rule that does something. Derived, not stored enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) # Bodyguard credentials profile transcripts are classified with. Applies to the NLP engine only profile: str = dc_field(metadata=dc_config(field_name="profile")) # The active engine's rules, flattened into the pre-split shape for clients that predate the per-engine configs. This is the whole config for a policy that has no per-engine config stored rules: "List[BodyguardRule]" = dc_field(metadata=dc_config(field_name="rules")) ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) @dataclass class AIImageConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) ocr_rules: "Optional[List[OCRRule]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_rules") ) ocr_severity_rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_severity_rules") ) rules: "Optional[List[AWSRekognitionRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AIImageLabelDefinition(DataClassJsonMixin): description: str = dc_field(metadata=dc_config(field_name="description")) group: str = dc_field(metadata=dc_config(field_name="group")) key: str = dc_field(metadata=dc_config(field_name="key")) label: str = dc_field(metadata=dc_config(field_name="label")) @dataclass class AITextConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) profile: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="profile") ) rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) severity_rules: "Optional[List[BodyguardSeverityRule]]" = dc_field( default=None, metadata=dc_config(field_name="severity_rules") ) @dataclass class AIVideoConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) rules: "Optional[List[AWSRekognitionRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AIVideoConfigRequest(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) rules: "Optional[List[AWSRekognitionRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AIVideoConfigResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) rules: "List[AWSRekognitionRule]" = dc_field(metadata=dc_config(field_name="rules")) _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) @dataclass class APIError(DataClassJsonMixin): # API error code code: int = dc_field(metadata=dc_config(field_name="code")) # Request duration duration: str = dc_field(metadata=dc_config(field_name="duration")) # Message describing an error message: str = dc_field(metadata=dc_config(field_name="message")) # URL with additional information more_info: str = dc_field(metadata=dc_config(field_name="more_info")) # Response HTTP status code status_code: int = dc_field(metadata=dc_config(field_name="StatusCode")) # Additional error-specific information details: "List[int]" = dc_field(metadata=dc_config(field_name="details")) # Milliseconds until the user's slow mode cool down period ends. Only set on code 60 (cool down) errors cooldown_remaining_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_remaining_ms") ) # Flag that indicates if the error is unrecoverable, requests that return unrecoverable errors should not be retried, this error only applies to the request that caused it unrecoverable: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="unrecoverable") ) # Additional error info exception_fields: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="exception_fields") ) @dataclass class APNConfig(DataClassJsonMixin): auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_key") ) auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_type") ) bundle_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bundle_id") ) development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="development") ) disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) host: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="host")) key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="key_id") ) notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="p12_cert") ) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @dataclass class APNConfigFields(DataClassJsonMixin): development: bool = dc_field(metadata=dc_config(field_name="development")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_key") ) auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_type") ) bundle_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bundle_id") ) host: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="host")) key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="key_id") ) notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="p12_cert") ) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @dataclass class APNS(DataClassJsonMixin): body: str = dc_field(metadata=dc_config(field_name="body")) title: str = dc_field(metadata=dc_config(field_name="title")) content_available: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="content-available") ) mutable_content: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mutable-content") ) sound: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sound") ) data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class APNSPayload(DataClassJsonMixin): body: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="body")) content_available: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="content-available") ) mutable_content: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mutable-content") ) sound: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sound") ) title: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="title") ) data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class AWSRekognitionRule(DataClassJsonMixin): # What a moderation rule does when it matches. action: "ModerationAction" = dc_field(metadata=dc_config(field_name="action")) label: str = dc_field(metadata=dc_config(field_name="label")) min_confidence: float = dc_field(metadata=dc_config(field_name="min_confidence")) subclassifications: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="subclassifications") ) @dataclass class AbsentMetric(DataClassJsonMixin): metric: str = dc_field(metadata=dc_config(field_name="metric")) reason: str = dc_field(metadata=dc_config(field_name="reason")) @dataclass class AcceptFeedMemberInviteRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AcceptFeedMemberInviteResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) member: "FeedMemberResponse" = dc_field(metadata=dc_config(field_name="member")) @dataclass class AcceptFollowRequest(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) # Optional role for the follower in the follow relationship. Server-side only. Either a built-in ('feed_follower' (the default) or 'feed_member_viewer') or any role your app has defined; grants are not inspected. follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follower_role") ) @dataclass class AcceptFollowResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) @dataclass class Action(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) text: str = dc_field(metadata=dc_config(field_name="text")) type: str = dc_field(metadata=dc_config(field_name="type")) style: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="style") ) value: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="value") ) @dataclass class ActionLogResponse(DataClassJsonMixin): # Timestamp when the action was taken created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier of the action log id: str = dc_field(metadata=dc_config(field_name="id")) # Reason for the moderation action reason: str = dc_field(metadata=dc_config(field_name="reason")) # Classification of who triggered the action (e.g. user, moderator, automod, api_integration) reporter_type: str = dc_field(metadata=dc_config(field_name="reporter_type")) # ID of the user who was the target of the action target_user_id: str = dc_field(metadata=dc_config(field_name="target_user_id")) # Type of moderation action type: str = dc_field(metadata=dc_config(field_name="type")) # ID of the user who performed the action user_id: str = dc_field(metadata=dc_config(field_name="user_id")) ai_providers: List[str] = dc_field(metadata=dc_config(field_name="ai_providers")) # Additional metadata about the action custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) # User response object target_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActionSequence(DataClassJsonMixin): action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) blur: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="blur")) cooldown_period: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) warning: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="warning") ) warning_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="warning_text") ) @dataclass class ActiveCallsBitrateStats(DataClassJsonMixin): p10: float = dc_field(metadata=dc_config(field_name="p10")) p50: float = dc_field(metadata=dc_config(field_name="p50")) @dataclass class ActiveCallsFPSStats(DataClassJsonMixin): p05: float = dc_field(metadata=dc_config(field_name="p05")) p10: float = dc_field(metadata=dc_config(field_name="p10")) p50: float = dc_field(metadata=dc_config(field_name="p50")) p90: float = dc_field(metadata=dc_config(field_name="p90")) @dataclass class ActiveCallsLatencyStats(DataClassJsonMixin): p50: float = dc_field(metadata=dc_config(field_name="p50")) p90: float = dc_field(metadata=dc_config(field_name="p90")) @dataclass class ActiveCallsMetrics(DataClassJsonMixin): join_call_api: "Optional[JoinCallAPIMetrics]" = dc_field( default=None, metadata=dc_config(field_name="join_call_api") ) publishers: "Optional[PublishersMetrics]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) subscribers: "Optional[SubscribersMetrics]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @dataclass class ActiveCallsResolutionStats(DataClassJsonMixin): p10: float = dc_field(metadata=dc_config(field_name="p10")) p50: float = dc_field(metadata=dc_config(field_name="p50")) @dataclass class ActiveCallsSummary(DataClassJsonMixin): active_calls: int = dc_field(metadata=dc_config(field_name="active_calls")) active_publishers: int = dc_field( metadata=dc_config(field_name="active_publishers") ) active_subscribers: int = dc_field( metadata=dc_config(field_name="active_subscribers") ) participants: int = dc_field(metadata=dc_config(field_name="participants")) @dataclass class ActivityAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.activity.added" in this case type: str = dc_field( default="feeds.activity.added", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.activity.deleted" in this case type: str = dc_field( default="feeds.activity.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityFeedbackEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) activity_feedback: "ActivityFeedbackEventPayload" = dc_field( metadata=dc_config(field_name="activity_feedback") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.activity.feedback" in this case type: str = dc_field( default="feeds.activity.feedback", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityFeedbackEventPayload(DataClassJsonMixin): # The type of feedback action. One of: hide, show_more, show_less action: str = dc_field(metadata=dc_config(field_name="action")) # The activity that received feedback activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) # When the feedback was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # When the feedback was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The feedback value (true/false) value: str = dc_field(metadata=dc_config(field_name="value")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class ActivityFeedbackRequest(DataClassJsonMixin): # Whether to hide this activity hide: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="hide")) # Whether to show less content like this show_less: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_less") ) # Whether to show more content like this show_more: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_more") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityFeedbackResponse(DataClassJsonMixin): # The ID of the activity that received feedback activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class ActivityFilterConfig(DataClassJsonMixin): # When true, activities authored by the feed owner are excluded from feed reads exclude_owner_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_owner_activities") ) @dataclass class ActivityMarkEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.activity.marked" in this case type: str = dc_field( default="feeds.activity.marked", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) # Whether all activities were marked as read mark_all_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_read") ) # Whether all activities were marked as seen mark_all_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_seen") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The IDs of activities marked as read mark_read: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_read") ) # The IDs of activities marked as seen mark_seen: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_seen") ) # The IDs of activities marked as watched mark_watched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_watched") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityMarksConfig(DataClassJsonMixin): # Whether to return per-activity read status on content feeds track_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_read") ) # Whether to return per-activity seen status on content feeds track_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_seen") ) @dataclass class ActivityPinResponse(DataClassJsonMixin): # When the pin was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the feed where activity is pinned feed: str = dc_field(metadata=dc_config(field_name="feed")) # When the pin was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class ActivityPinnedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the feed fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) pinned_activity: "PinActivityResponse" = dc_field( metadata=dc_config(field_name="pinned_activity") ) # The type of event: "feeds.activity.pinned" in this case type: str = dc_field( default="feeds.activity.pinned", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityProcessingConfig(DataClassJsonMixin): # When true, this feed group's allowed_tags is given to the model as a constrained vocabulary so it maps its own wording onto a configured tag instead of that output being discarded. Improves how often a tag is produced, at the cost of sending the list on every request. Scoped to this group's own list: leaving it false keeps this group's tags out of the request even when another feed group on the same activity sets it true. Requires allowed_tags. Off by default. send_allowed_tags_to_ai: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="send_allowed_tags_to_ai") ) # When set, the LLM activity processors may only write interest tags from this list. By default the model is not told about the list, so a tag is only written when the model happens to produce that exact word after lower-casing and trimming, which for any vocabulary is often not the case; set send_allowed_tags_to_ai to have the model choose from the list instead. Mutually exclusive with blocked_tags. allowed_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_tags") ) # Interest tags the LLM activity processors are never allowed to write. Mutually exclusive with allowed_tags. blocked_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_tags") ) @dataclass class ActivityProcessorConfig(DataClassJsonMixin): # Type of activity processor (required) type: str = dc_field(metadata=dc_config(field_name="type")) # Minimum number of characters the activity text must have before this processor runs. 0 (the default) disables the check. Only applies to text_interest_tags. min_text_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_text_length") ) # Minimum number of words the activity text must have before this processor runs. 0 (the default) disables the check. Only applies to text_interest_tags. Words are whitespace-separated, so scripts written without word spacing (Chinese, Japanese, Thai) always count as 1 word regardless of length — use min_text_length for those. min_word_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_word_count") ) @dataclass class ActivityReactionAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of event: "feeds.activity.reaction.added" in this case type: str = dc_field( default="feeds.activity.reaction.added", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityReactionDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of the reaction that was removed type: str = dc_field( default="feeds.activity.reaction.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityReactionUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of event: "feeds.activity.reaction.updated" in this case type: str = dc_field( default="feeds.activity.reaction.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityRemovedFromFeedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.activity.removed_from_feed" in this case type: str = dc_field( default="feeds.activity.removed_from_feed", metadata=dc_config(field_name="type"), ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityRequest(DataClassJsonMixin): # Type of activity type: str = dc_field(metadata=dc_config(field_name="type")) # List of feeds to add the activity to with a default max limit of 25 feeds feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create notification activities for mentioned users create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # Expiration time for the activity expires_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expires_at") ) # Optional ID for the activity id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of parent activity for replies/comments parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # ID of a poll to attach to activity poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) # Controls who can add comments/replies to this activity. One of: everyone, people_i_follow, nobody restrict_replies: "Optional[RestrictReplies]" = dc_field( default=None, metadata=dc_config(field_name="restrict_replies") ) # Whether to skip URL enrichment for the activity skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # Whether to skip push notifications skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Text content of the activity text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # ID of the user creating the activity user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Visibility setting for the activity. One of: public, private, tag visibility: "Optional[ActivityVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # If visibility is 'tag', this is the tag name and is required visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references collection_refs: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="collection_refs") ) # Collections to create or update as part of this request, so an activity and the collections it references can be written in one call. Their refs (name:id) are added to collection_refs automatically; you do not need to restate them, and they count toward the same per-activity collection-reference limit, which is the effective cap here. A collection that already exists has its custom data updated. Use collection_refs instead when the collection already exists and you are only referencing it, which requires no collection permissions. collections: "Optional[List[CollectionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="collections") ) # Tags for filtering activities filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags for indicating user interests interest_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="interest_tags") ) # List of users mentioned in the activity mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) @dataclass class ActivityResponse(DataClassJsonMixin): # Number of bookmarks on the activity bookmark_count: int = dc_field(metadata=dc_config(field_name="bookmark_count")) # Number of comments on the activity comment_count: int = dc_field(metadata=dc_config(field_name="comment_count")) # When the activity was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # If this activity is hidden by this user (using activity feedback) hidden: bool = dc_field(metadata=dc_config(field_name="hidden")) # Unique identifier for the activity id: str = dc_field(metadata=dc_config(field_name="id")) # Popularity score of the activity popularity: int = dc_field(metadata=dc_config(field_name="popularity")) # If this activity is obfuscated for this user. For premium content where you want to show a preview preview: bool = dc_field(metadata=dc_config(field_name="preview")) # Number of reactions to the activity reaction_count: int = dc_field(metadata=dc_config(field_name="reaction_count")) # Controls who can add comments/replies to this activity. One of: everyone, people_i_follow, nobody restrict_replies: "RestrictReplies" = dc_field( metadata=dc_config(field_name="restrict_replies") ) # Ranking score for this activity score: float = dc_field(metadata=dc_config(field_name="score")) # Number of times the activity was shared share_count: int = dc_field(metadata=dc_config(field_name="share_count")) # Type of activity type: str = dc_field(metadata=dc_config(field_name="type")) # When the activity was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Visibility setting for the activity. One of: public, private, tag visibility: "ActivityVisibility" = dc_field( metadata=dc_config(field_name="visibility") ) # Media attachments for the activity attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) # Latest 5 comments of this activity (comment replies excluded) comments: "List[CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) # List of feed IDs containing this activity feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) # Tags for filtering filter_tags: List[str] = dc_field(metadata=dc_config(field_name="filter_tags")) # Tags for user interests interest_tags: List[str] = dc_field(metadata=dc_config(field_name="interest_tags")) # Recent reactions to the activity latest_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # Users mentioned in the activity mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) # Current user's bookmarks for this activity own_bookmarks: "List[BookmarkResponse]" = dc_field( metadata=dc_config(field_name="own_bookmarks") ) # Current user's reactions to this activity own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # Enriched collection data referenced by this activity collections: "Dict[str, EnrichedCollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) # Custom data for the activity custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Grouped reactions by type reaction_groups: "Dict[str, FeedsReactionGroupResponse]" = dc_field( metadata=dc_config(field_name="reaction_groups") ) # Data for search indexing search_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="search_data") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # When the activity was deleted deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the activity was last edited edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the activity will expire expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Total count of reactions from friends on this activity friend_reaction_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="friend_reaction_count") ) # Whether this activity has been read. Only set for feed groups with notification config (track_seen/track_read enabled). is_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_read") ) # Whether this activity has been seen. Only set for feed groups with notification config (track_seen/track_read enabled). is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) # 1-based position of this activity. On ranked feeds it is the activity's slot in the ranked feed, continuing across pages; activities filtered out for this user leave gaps. Otherwise it is relative to the returned page. Only set on feed reads for paid plans with an authenticated user, when the app uses feed impressions (For You exploration, or a For You ranking that uses impressions_bucket). position: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="position") ) # Which activity selector provided this activity (e.g., 'following', 'popular', 'interest'), or 'exploration' for the For You exploration slot. Only set when using multiple activity selectors with ranking. selector_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="selector_source") ) # Text content of the activity text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Number of top-level comments (comments directly on the activity, excluding replies). Only returned by GetActivity when include_top_level_comment_count=true; never set on feed reads or events. Same status/deletion rules as comment_count; not adjusted per viewer. top_level_comment_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="top_level_comment_count") ) # If visibility is 'tag', this is the tag name visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # Reactions from users the current user follows or has mutual follows with friend_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="friend_reactions") ) # Recent shares of the activity, one entry per share (org-gated) latest_shares: "Optional[List[ShareResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_shares") ) # Codes explaining why this activity was shown (e.g. 'following', 'popular', 'interest:nba'). Only included when include_reasons is enabled in enrichment options. reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="reasons") ) current_feed: "Optional[FeedResponse]" = dc_field( default=None, metadata=dc_config(field_name="current_feed") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) metrics: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) notification_context: "Optional[NotificationContext]" = dc_field( default=None, metadata=dc_config(field_name="notification_context") ) parent: "Optional[ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Variable values used at ranking time. Only included when include_score_vars is enabled in enrichment options. score_vars: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="score_vars") ) @dataclass class ActivityRestoredEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of the event type: str = dc_field( default="feeds.activity.restored", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivitySelectorConfig(DataClassJsonMixin): # Type of selector. One of: popular, proximity, following, current_feed, query, interest, follow_suggestion type: "ActivitySelectorType" = dc_field(metadata=dc_config(field_name="type")) # Time threshold for activity selection (string). Expected RFC3339 format (e.g., 2006-01-02T15:04:05Z07:00). Cannot be used together with cutoff_window cutoff_time: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cutoff_time") ) # Flexible relative time window for activity selection (e.g., '1h', '3d', '1y'). Activities older than this duration will be filtered out. Cannot be used together with cutoff_time cutoff_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cutoff_window") ) # Minimum popularity threshold. For the 'popular' selector, omit to use the default (5); values below 1 are rejected min_popularity: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_popularity") ) # Maximum number of candidate activities this selector contributes to a ranked feed (1-1000). Omit to use the default ranking buffer. Only supported on the popular, proximity, interest and query selectors, and ignored on feeds without ranking ranking_candidate_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="ranking_candidate_limit") ) # Maximum time in milliseconds this selector may take (25-5000). A selector that runs over its budget is dropped from that read instead of failing it, and stays out for the rest of that pagination session. The budget can only tighten the default, never extend it. Omit to use the default. Only supported on the popular, proximity, interest, query and follow_suggestion selectors time_budget_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="time_budget_ms") ) # Radius in kilometers the proximity selector searches around the viewer's location (the request's viewer_location, else the user's custom.location) when its filter has no near or within_bounds. Greater than 0 and at most 250. Omit to use the default (10). Only supported on the proximity selector viewer_location_radius_km: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="viewer_location_radius_km") ) # Sort parameters for activity selection sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) feed_groups: "Optional[FeedGroupScope]" = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) # Filter for activity selection filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) params: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="params") ) @dataclass class ActivitySelectorConfigResponse(DataClassJsonMixin): # Type of selector type: "ActivitySelectorType" = dc_field(metadata=dc_config(field_name="type")) # Time threshold for activity selection (timestamp) cutoff_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="cutoff_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Flexible relative time window for activity selection (e.g., '1h', '3d', '1y') cutoff_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cutoff_window") ) # Minimum popularity threshold. For the 'popular' selector, values below 1 are normalized to the default (5) at read time. min_popularity: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_popularity") ) # Maximum number of candidate activities this selector contributes to a ranked feed ranking_candidate_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="ranking_candidate_limit") ) # Maximum time in milliseconds this selector may take before it is dropped from the read time_budget_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="time_budget_ms") ) # Radius in kilometers the proximity selector searches around the viewer's location viewer_location_radius_km: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="viewer_location_radius_km") ) # Sort parameters for activity selection sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) feed_groups: "Optional[FeedGroupScope]" = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) # Filter for activity selection filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # Generic params for selector-specific configuration params: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="params") ) ActivitySelectorTypeType = NewType("ActivitySelectorTypeType", str) class ActivitySelectorType: CURRENT_FEED: Final[ActivitySelectorTypeType] = "current_feed" FOLLOWING: Final[ActivitySelectorTypeType] = "following" FOLLOW_SUGGESTION: Final[ActivitySelectorTypeType] = "follow_suggestion" INTEREST: Final[ActivitySelectorTypeType] = "interest" POPULAR: Final[ActivitySelectorTypeType] = "popular" PROXIMITY: Final[ActivitySelectorTypeType] = "proximity" QUERY: Final[ActivitySelectorTypeType] = "query" @dataclass class ActivityUnpinnedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the feed fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) pinned_activity: "PinActivityResponse" = dc_field( metadata=dc_config(field_name="pinned_activity") ) # The type of event: "feeds.activity.unpinned" in this case type: str = dc_field( default="feeds.activity.unpinned", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActivityUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of the event type: str = dc_field( default="feeds.activity.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) ActivityVisibilityType = NewType("ActivityVisibilityType", str) class ActivityVisibility: PRIVATE: Final[ActivityVisibilityType] = "private" PUBLIC: Final[ActivityVisibilityType] = "public" TAG: Final[ActivityVisibilityType] = "tag" @dataclass class AddActivityRequest(DataClassJsonMixin): # Type of activity type: str = dc_field(metadata=dc_config(field_name="type")) # List of feeds to add the activity to with a default max limit of 25 feeds feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create notification activities for mentioned users create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Expiration time for the activity expires_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expires_at") ) force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # Optional ID for the activity id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of parent activity for replies/comments parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # ID of a poll to attach to activity poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) # Controls who can add comments/replies to this activity. One of: everyone, people_i_follow, nobody restrict_replies: "Optional[RestrictReplies]" = dc_field( default=None, metadata=dc_config(field_name="restrict_replies") ) # Whether to skip URL enrichment for the activity skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_existing: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_existing") ) # Whether to skip push notifications skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Text content of the activity text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # ID of the user creating the activity user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Visibility setting for the activity. One of: public, private, tag visibility: "Optional[ActivityVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # If visibility is 'tag', this is the tag name and is required visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references collection_refs: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="collection_refs") ) # Collections to create or update as part of this request, so an activity and the collections it references can be written in one call. Their refs (name:id) are added to collection_refs automatically; you do not need to restate them, and they count toward the same per-activity collection-reference limit, which is the effective cap here. A collection that already exists has its custom data updated. Use collection_refs instead when the collection already exists and you are only referencing it, which requires no collection permissions. collections: "Optional[List[CollectionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="collections") ) # Tags for filtering activities filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags for indicating user interests interest_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="interest_tags") ) # List of users mentioned in the activity mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) @dataclass class AddActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) # Number of mention notification activities created for mentioned users mention_notifications_created: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mention_notifications_created") ) # Contains the activity ID when skip_existing is true and the activity already existed, so it was left unchanged. skipped_existing: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="skipped_existing") ) @dataclass class AddBookmarkRequest(DataClassJsonMixin): # ID of the folder to add the bookmark to folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AddBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class AddCommentBookmarkRequest(DataClassJsonMixin): # ID of the folder to add the bookmark to folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AddCommentBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class AddCommentReactionRequest(DataClassJsonMixin): # The type of reaction, eg upvote, like, ... type: str = dc_field(metadata=dc_config(field_name="type")) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create a notification activity for this reaction create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # Whether to enforce unique reactions per user (remove other reaction types from the user when adding this one) enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Optional list of feeds to create a reference (share) activity of the commented-on activity in. The reference activity's type mirrors the reaction type. target_feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds") ) # Optional custom data to add to the reaction custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AddCommentReactionResponse(DataClassJsonMixin): # The change this write made to the number of reactions the user holds on this target: 1 when outcome is 'created', 0 when it is 'replaced' or 'unchanged'. These endpoints never return -1; a successful delete-reaction call is what decrements the count. With enforce_unique this is the delta of the user's reaction on the target; without it, the delta of reactions of this type. counter_delta: int = dc_field(metadata=dc_config(field_name="counter_delta")) # Duration of the request duration: str = dc_field(metadata=dc_config(field_name="duration")) # What this write did to the user's reaction on this target. One of: created, replaced, unchanged. 'created' means a new reaction was written and nothing was replaced; 'replaced' means enforce_unique removed one or more of the user's other reaction types; 'unchanged' means the user already held this reaction type (its custom data may still have been updated). Without enforce_unique a user can hold several reaction types on one target, so 'created' then means 'this reaction type was newly added', not 'the user's first reaction on this target'. outcome: str = dc_field(metadata=dc_config(field_name="outcome")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # Whether notification creation was accepted for asynchronous processing notification_accepted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_accepted") ) # Deprecated. Mirrors notification_accepted; use notification_accepted for async enqueue status Deprecated: use notification_accepted # Deprecated notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) # ID of the async notification-creation task; poll GET /tasks/{id} for its status notification_task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_task_id") ) # The reaction type this write replaced, or null when nothing was replaced. Non-null exactly when outcome is 'replaced'. If enforce_unique removed several reactions — possible only for data created before enforce_unique was adopted — this is the most recently created one. previous_reaction_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="previous_reaction_type") ) reference_activity: "Optional[ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="reference_activity") ) @dataclass class AddCommentRequest(DataClassJsonMixin): # Text content of the comment comment: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create a notification activity for this comment create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # Optional custom ID for the comment (max 255 characters). If not provided, a UUID will be generated. id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of the object to comment on. Required for root comments object_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="object_id") ) # Type of the object to comment on. Required for root comments object_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="object_type") ) # ID of parent comment for replies. When provided, object_id and object_type are automatically inherited from the parent comment. parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Whether to skip URL enrichment for this comment skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Media attachments for the reply attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of users mentioned in the reply mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the comment custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AddCommentResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) # Number of mention notification activities created for mentioned users mention_notifications_created: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mention_notifications_created") ) # Whether a notification activity was successfully created notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @dataclass class AddCommentsBatchRequest(DataClassJsonMixin): # List of comments to add comments: "List[AddCommentRequest]" = dc_field( metadata=dc_config(field_name="comments") ) @dataclass class AddCommentsBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of comments added comments: "List[CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) @dataclass class AddFolderRequest(DataClassJsonMixin): # Name of the folder name: str = dc_field(metadata=dc_config(field_name="name")) # Custom data for the folder custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class AddReactionRequest(DataClassJsonMixin): # Type of reaction type: str = dc_field(metadata=dc_config(field_name="type")) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create a notification activity for this reaction create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # Server-side only. If true, auto-creates the reacting user identified by user_id when they don't already exist. Default: false. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # Whether to enforce unique reactions per user (remove other reaction types from the user when adding this one) enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Optional list of feeds to create a reference (share) activity of the original activity in. The reference activity's type mirrors the reaction type. target_feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds") ) # Custom data for the reaction custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AddReactionResponse(DataClassJsonMixin): # The change this write made to the number of reactions the user holds on this target: 1 when outcome is 'created', 0 when it is 'replaced' or 'unchanged'. These endpoints never return -1; a successful delete-reaction call is what decrements the count. With enforce_unique this is the delta of the user's reaction on the target; without it, the delta of reactions of this type. counter_delta: int = dc_field(metadata=dc_config(field_name="counter_delta")) duration: str = dc_field(metadata=dc_config(field_name="duration")) # What this write did to the user's reaction on this target. One of: created, replaced, unchanged. 'created' means a new reaction was written and nothing was replaced; 'replaced' means enforce_unique removed one or more of the user's other reaction types; 'unchanged' means the user already held this reaction type (its custom data may still have been updated). Without enforce_unique a user can hold several reaction types on one target, so 'created' then means 'this reaction type was newly added', not 'the user's first reaction on this target'. outcome: str = dc_field(metadata=dc_config(field_name="outcome")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # Whether notification creation was accepted for asynchronous processing notification_accepted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_accepted") ) # Deprecated. Mirrors notification_accepted; use notification_accepted for async enqueue status Deprecated: use notification_accepted # Deprecated notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) # ID of the async notification-creation task; poll GET /tasks/{id} for its status notification_task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_task_id") ) # The reaction type this write replaced, or null when nothing was replaced. Non-null exactly when outcome is 'replaced'. If enforce_unique removed several reactions — possible only for data created before enforce_unique was adopted — this is the most recently created one. previous_reaction_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="previous_reaction_type") ) reference_activity: "Optional[ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="reference_activity") ) @dataclass class AddSegmentTargetsRequest(DataClassJsonMixin): # Target IDs target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) @dataclass class AddUserGroupMembersRequest(DataClassJsonMixin): # List of user IDs to add as members member_ids: List[str] = dc_field(metadata=dc_config(field_name="member_ids")) # Whether to add the members as group admins. Defaults to false as_admin: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="as_admin") ) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @dataclass class AddUserGroupMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class AggregatedActivityResponse(DataClassJsonMixin): # Number of activities in this aggregation activity_count: int = dc_field(metadata=dc_config(field_name="activity_count")) # When the aggregation was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Grouping identifier group: str = dc_field(metadata=dc_config(field_name="group")) # Ranking score for this aggregation score: float = dc_field(metadata=dc_config(field_name="score")) # When the aggregation was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of unique users in this aggregation user_count: int = dc_field(metadata=dc_config(field_name="user_count")) # Whether this activity group has been truncated due to exceeding the group size limit user_count_truncated: bool = dc_field( metadata=dc_config(field_name="user_count_truncated") ) # List of activities in this aggregation activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) # Whether this aggregated group has been read. Only set for feed groups with notification config (track_seen/track_read enabled). is_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_read") ) # Whether this aggregated group has been seen. Only set for feed groups with notification config (track_seen/track_read enabled). is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) @dataclass class AggregationConfig(DataClassJsonMixin): # Order of member activities inside each aggregated group for non-stories feeds: created_at_desc (newest first, default) or created_at_asc (oldest first). Stories feeds ignore this and always use oldest first. activities_sort: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activities_sort") ) # Format for activity aggregation format: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="format") ) # Maximum number of activities kept in each aggregated group. Omit to use the default: 15 for apps migrated from Feeds v2 or created on or after 2026-10-11, 100 otherwise. Must be between 1 and 100 when set. group_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="group_size") ) # Strategy for computing aggregated group scores from member activity scores when ranking is enabled. Valid values: sum, max, avg score_strategy: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="score_strategy") ) @dataclass class AnalyzeImageField(DataClassJsonMixin): # Per-image action: keep | flag | remove. action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) # Highest confidence (0–1) across detected classifications + sub-classifications. Convenience aggregate over the nested values in `classifications`. confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) # Set when moderation couldn't be determined for this image — action is absent. error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) # Echo of `content_ids[label]` when supplied on the request; omitted otherwise. id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Hierarchical list of L1 (parent) classifications. Each entry: `name`, `confidence` (0–1), and nested `subclassifications` (L2 leaves with their own confidence). Resolved against the app's effective taxonomy (custom taxonomy when configured, otherwise the standard Bodyguard catalogue). classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="classifications") ) # URLs found in the image, as `{url, source}` objects: `source` is `qr` (decoded from a QR code) or `ocr` (in text visible in the image). Independent of the action; omitted when none were found. detected_urls: "Optional[List[DetectedURLResponse]]" = dc_field( default=None, metadata=dc_config(field_name="detected_urls") ) # Flat list of Bodyguard OCR text-moderation labels on the image's extracted text (e.g. VULGARITY, PII). Each entry: `name` + `severity`. Populated when BG's OCR pipeline returned non-empty results for this image. ocr_classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_classifications") ) @dataclass class AnalyzeRequest(DataClassJsonMixin): # When true, the response carries no verdicts (status `pending`) and per-modality results arrive via `moderation.text_analysis.complete` and `moderation.image_analysis.complete` webhooks. Image moderation runs on a background worker; text moderation runs synchronously and is then delivered via webhook. async_response: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async_response") ) # Moderation policy key. Optional in stateful mode, required in stateless mode. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Original timestamp when the content was produced. Used as the `published_at` timestamp on per-content log entries that surface in `matched_contents` on aggregation-rule webhooks. content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ISO 3166-1 alpha-2 country the content is aimed at (e.g. US, DE). Ignored when country_codes is set, but an invalid value is still rejected with 400. # Deprecated country_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_code") ) # ID of the user who created the content. Required with entity_type + entity_id; omit all three for stateless mode. entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Caller-supplied content identifier. Required with entity_type + entity_creator_id; omit all three for stateless mode. entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Caller-defined entity type. Required with entity_id + entity_creator_id; omit all three for stateless mode. entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # ISO 3166-1 alpha-2 countries the content is aimed at (e.g. US, DE), up to 300. The first is the primary country. Every country is sent to the AI text and image harm detection engines as country context. Takes precedence over country_code. country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) # Optional map from a content label (either a `texts` key or an `image:` multipart label) to a caller-supplied per-instance identifier. Echoed on per-field verdicts and surfaced in `matched_contents` when an aggregation rule fires. content_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="content_ids") ) # Arbitrary metadata surfaced in the dashboard. custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Named text fields to moderate, keyed by caller label (e.g. title, description). texts: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AnalyzeResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # `complete` (all fields screened), `partial` (mix of verdicts and per-field errors), or `pending` (async). status: str = dc_field(metadata=dc_config(field_name="status")) # ID of the LLM model that scored the content (e.g. gpt-4o-mini). Omitted when no LLM verdict was used (e.g. Bodyguard-only, or `pending`). llm_model: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="llm_model") ) # reasoning_effort sent with the LLM request. Omitted when the request did not send one. llm_reasoning_effort: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="llm_reasoning_effort") ) # Per-image moderation verdicts keyed by caller label. images: "Optional[Dict[str, AnalyzeImageField]]" = dc_field( default=None, metadata=dc_config(field_name="images") ) # Per-text-field moderation verdicts keyed by caller label. texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @dataclass class AnalyzeTextField(DataClassJsonMixin): # Per-field action: keep | flag | remove. action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) # Set when moderation couldn't be determined for this field — action is absent. error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) # Echo of `content_ids[label]` when supplied on the request; omitted otherwise. id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Detected language code. language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) # Aggregate severity across the field: LOW | MEDIUM | HIGH | CRITICAL. severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) # Flat list of detected Bodyguard text labels (e.g. INSULT, VULGARITY). Each entry carries `name` and `severity`. classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="classifications") ) # URLs found in the text, as `{url, source}` objects with `source` = `text`. Independent of the action; omitted when none were found. detected_urls: "Optional[List[DetectedURLResponse]]" = dc_field( default=None, metadata=dc_config(field_name="detected_urls") ) @dataclass class AppChannelCountParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class AppCountInfo(DataClassJsonMixin): # The app-wide count condition that fired: `app_channel_count` or `app_message_count`. condition_type: str = dc_field(metadata=dc_config(field_name="condition_type")) # Channels created or messages sent in the app within the window when the rule fired, the triggering event included. count: int = dc_field(metadata=dc_config(field_name="count")) # The configured threshold. The rule fires when the count reaches it. threshold: int = dc_field(metadata=dc_config(field_name="threshold")) # The configured time window, e.g. `5m`. time_window: str = dc_field(metadata=dc_config(field_name="time_window")) @dataclass class AppDefaults(DataClassJsonMixin): # Defaults applied by the get-or-create channel endpoint. get_or_create_channel: "GetOrCreateChannelDefaults" = dc_field( metadata=dc_config(field_name="get_or_create_channel") ) # Defaults applied by the query channels endpoint. query_channels: "QueryChannelsDefaults" = dc_field( metadata=dc_config(field_name="query_channels") ) @dataclass class AppMessageCountParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class AppResponseFields(DataClassJsonMixin): allow_multi_user_devices: bool = dc_field( metadata=dc_config(field_name="allow_multi_user_devices") ) # A boolean value determining if async url enrichment is enabled. async_url_enrich_enabled: bool = dc_field( metadata=dc_config(field_name="async_url_enrich_enabled") ) # A boolean value determining if auto translation is enabled. auto_translation_enabled: bool = dc_field( metadata=dc_config(field_name="auto_translation_enabled") ) before_message_send_hook_system_messages: bool = dc_field( metadata=dc_config(field_name="before_message_send_hook_system_messages") ) campaign_enabled: bool = dc_field(metadata=dc_config(field_name="campaign_enabled")) cdn_expiration_seconds: int = dc_field( metadata=dc_config(field_name="cdn_expiration_seconds") ) custom_action_handler_url: str = dc_field( metadata=dc_config(field_name="custom_action_handler_url") ) disable_auth_checks: bool = dc_field( metadata=dc_config(field_name="disable_auth_checks") ) disable_permissions_checks: bool = dc_field( metadata=dc_config(field_name="disable_permissions_checks") ) enforce_unique_usernames: str = dc_field( metadata=dc_config(field_name="enforce_unique_usernames") ) feed_audit_logs_enabled: bool = dc_field( metadata=dc_config(field_name="feed_audit_logs_enabled") ) guest_user_creation_disabled: bool = dc_field( metadata=dc_config(field_name="guest_user_creation_disabled") ) id: int = dc_field(metadata=dc_config(field_name="id")) image_moderation_enabled: bool = dc_field( metadata=dc_config(field_name="image_moderation_enabled") ) max_aggregated_activities_length: int = dc_field( metadata=dc_config(field_name="max_aggregated_activities_length") ) member_custom_on_mentioned_users_enabled: bool = dc_field( metadata=dc_config(field_name="member_custom_on_mentioned_users_enabled") ) member_custom_on_messages_enabled: bool = dc_field( metadata=dc_config(field_name="member_custom_on_messages_enabled") ) member_custom_on_typing_events_enabled: bool = dc_field( metadata=dc_config(field_name="member_custom_on_typing_events_enabled") ) moderation_audio_call_moderation_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_audio_call_moderation_enabled") ) moderation_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_enabled") ) moderation_keyframe_video_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_keyframe_video_enabled") ) moderation_llm_configurability_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_llm_configurability_enabled") ) moderation_multitenant_blocklist_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_multitenant_blocklist_enabled") ) moderation_video_call_moderation_enabled: bool = dc_field( metadata=dc_config(field_name="moderation_video_call_moderation_enabled") ) moderation_webhook_url: str = dc_field( metadata=dc_config(field_name="moderation_webhook_url") ) multi_tenant_enabled: bool = dc_field( metadata=dc_config(field_name="multi_tenant_enabled") ) # The name of the app. name: str = dc_field(metadata=dc_config(field_name="name")) organization: str = dc_field(metadata=dc_config(field_name="organization")) permission_version: str = dc_field( metadata=dc_config(field_name="permission_version") ) placement: str = dc_field(metadata=dc_config(field_name="placement")) reminders_interval: int = dc_field( metadata=dc_config(field_name="reminders_interval") ) sns_key: str = dc_field(metadata=dc_config(field_name="sns_key")) sns_secret: str = dc_field(metadata=dc_config(field_name="sns_secret")) sns_topic_arn: str = dc_field(metadata=dc_config(field_name="sns_topic_arn")) sqs_key: str = dc_field(metadata=dc_config(field_name="sqs_key")) sqs_secret: str = dc_field(metadata=dc_config(field_name="sqs_secret")) sqs_url: str = dc_field(metadata=dc_config(field_name="sqs_url")) suspended: bool = dc_field(metadata=dc_config(field_name="suspended")) suspended_explanation: str = dc_field( metadata=dc_config(field_name="suspended_explanation") ) two_way_block_effect_enabled: bool = dc_field( metadata=dc_config(field_name="two_way_block_effect_enabled") ) use_hook_v2: bool = dc_field(metadata=dc_config(field_name="use_hook_v2")) user_response_time_enabled: bool = dc_field( metadata=dc_config(field_name="user_response_time_enabled") ) webhook_url: str = dc_field(metadata=dc_config(field_name="webhook_url")) event_hooks: "List[EventHook]" = dc_field( metadata=dc_config(field_name="event_hooks") ) user_search_disallowed_roles: List[str] = dc_field( metadata=dc_config(field_name="user_search_disallowed_roles") ) webhook_events: List[str] = dc_field( metadata=dc_config(field_name="webhook_events") ) call_types: "Dict[str, Optional[CallType]]" = dc_field( metadata=dc_config(field_name="call_types") ) channel_configs: "Dict[str, Optional[ChannelConfig]]" = dc_field( metadata=dc_config(field_name="channel_configs") ) # Request limit defaults applied by the server when the corresponding field is omitted. defaults: "AppDefaults" = dc_field(metadata=dc_config(field_name="defaults")) file_upload_config: "FileUploadConfig" = dc_field( metadata=dc_config(field_name="file_upload_config") ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) image_upload_config: "FileUploadConfig" = dc_field( metadata=dc_config(field_name="image_upload_config") ) policies: "Dict[str, List[Policy]]" = dc_field( metadata=dc_config(field_name="policies") ) push_notifications: "PushNotificationFields" = dc_field( metadata=dc_config(field_name="push_notifications") ) before_message_send_hook_attempt_timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="before_message_send_hook_attempt_timeout_ms"), ) before_message_send_hook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="before_message_send_hook_url") ) chat_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_primary_use_case") ) moderation_onboarding_complete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_onboarding_complete") ) moderation_s3_image_access_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_s3_image_access_role_arn"), ) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) video_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="video_primary_use_case") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) geofences: "Optional[List[GeofenceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="geofences") ) image_moderation_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_labels") ) activity_metrics_config: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="activity_metrics_config") ) datadog_info: "Optional[DataDogInfo]" = dc_field( default=None, metadata=dc_config(field_name="datadog_info") ) moderation_dashboard_preferences: "Optional[ModerationDashboardPreferences]" = ( dc_field( default=None, metadata=dc_config(field_name="moderation_dashboard_preferences"), ) ) @dataclass class AppealAcceptedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="appeal.accepted", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @dataclass class AppealCreatedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="appeal.created", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @dataclass class AppealItemResponse(DataClassJsonMixin): # Reason Text of the Appeal Item appeal_reason: str = dc_field(metadata=dc_config(field_name="appeal_reason")) # When the flag was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the entity entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) id: str = dc_field(metadata=dc_config(field_name="id")) # Status of the Appeal Item status: str = dc_field(metadata=dc_config(field_name="status")) # When the flag was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Text severity level assigned by the AI provider ai_text_severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ai_text_severity") ) # Detected language of the appeal_reason text itself appeal_reason_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="appeal_reason_language") ) # CID of the channel the entity belongs to (content appeals), or of the channel ban being appealed (stream:user appeals). Empty for a global ban appeal. channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Moderation policy key that was applied config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Decision Reason of the Appeal Item decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) # Action recommended by the automated moderation system (e.g. flag, remove, shadow) recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recommended_action") ) # ID of the review queue item linked to this appeal, if the appeal was submitted with one review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Overall content severity score (1–100) severity: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="severity") ) # Full chronological history of all moderation actions on the review queue item actions: "Optional[List[ActionLogResponse]]" = dc_field( default=None, metadata=dc_config(field_name="actions") ) # Attachments(e.g. Images) of the Appeal Item attachments: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Classification labels from automated and manual review flag_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="flag_labels") ) # Types of flags applied to the entity (e.g. user_report, bodyguard) flag_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="flag_types") ) # Per-provider flag records explaining why the action was taken flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) # Detected languages in the content languages: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="languages") ) entity_content: "Optional[ModerationPayload]" = dc_field( default=None, metadata=dc_config(field_name="entity_content") ) moderation_action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) original_moderation_action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="original_moderation_action") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AppealRejectedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="appeal.rejected", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @dataclass class AppealRequest(DataClassJsonMixin): # Explanation for why the content is being appealed appeal_reason: str = dc_field(metadata=dc_config(field_name="appeal_reason")) # Unique identifier of the entity being appealed entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity being appealed (e.g., message, user) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # CID of the channel ban being appealed. Only used when entity_type is stream:user; omit to appeal the global ban. channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # ID of the review queue item (flagged message) that triggered the ban. Applicable only for user ban appeals. review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of Attachment URLs(e.g., images) attachments: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class AppealResponse(DataClassJsonMixin): # Unique identifier of the created Appeal item appeal_id: str = dc_field(metadata=dc_config(field_name="appeal_id")) duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class ArrangeConfig(DataClassJsonMixin): # Activity field that defines a source. One of: type, user_id key: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="key")) # Arrangement mode. Currently only 'blend' is supported; 'diversify' and 'slot' are reserved mode: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mode")) # Activities scoring strictly below this value are moved to the end of the feed, in score order, before the mode runs. 0 is a valid value. Must be greater than exclude_below when both are set tail_below: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="tail_below") ) blend: "Optional[BlendArrangeConfig]" = dc_field( default=None, metadata=dc_config(field_name="blend") ) @dataclass class AsyncBulkImageModerationEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.bulk_image_moderation.success", metadata=dc_config(field_name="type"), ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportChannelsEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.channels.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportErrorEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) error: str = dc_field(metadata=dc_config(field_name="error")) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="feeds.export.error", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportFeedsSuccessEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) manifest_path: str = dc_field(metadata=dc_config(field_name="manifest_path")) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="feeds.export.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportLabelResultsEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.label_results.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportModerationLogsEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.moderation_logs.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportReviewQueueEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.review_queue.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncExportUsersEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) url: str = dc_field(metadata=dc_config(field_name="url")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="export.users.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncImportErrorEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) error: str = dc_field(metadata=dc_config(field_name="error")) error_code: str = dc_field(metadata=dc_config(field_name="error_code")) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) product: str = dc_field(metadata=dc_config(field_name="product")) state: str = dc_field(metadata=dc_config(field_name="state")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field(default="import.error", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncImportSuccessEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) product: str = dc_field(metadata=dc_config(field_name="product")) state: str = dc_field(metadata=dc_config(field_name="state")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="import.success", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class AsyncModerationCallbackConfig(DataClassJsonMixin): mode: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mode")) server_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="server_url") ) @dataclass class AsyncModerationConfiguration(DataClassJsonMixin): timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout_ms") ) callback: "Optional[AsyncModerationCallbackConfig]" = dc_field( default=None, metadata=dc_config(field_name="callback") ) @dataclass class Attachment(DataClassJsonMixin): custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) asset_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="asset_url") ) author_icon: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_icon") ) author_link: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_link") ) author_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_name") ) color: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="color") ) fallback: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="fallback") ) footer: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="footer") ) footer_icon: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="footer_icon") ) image_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image_url") ) og_scrape_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="og_scrape_url") ) original_height: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_height") ) original_width: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_width") ) pretext: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pretext") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) title: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="title") ) title_link: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="title_link") ) # Attachment type (e.g. image, video, url) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) actions: "Optional[List[Action]]" = dc_field( default=None, metadata=dc_config(field_name="actions") ) fields: "Optional[List[Field]]" = dc_field( default=None, metadata=dc_config(field_name="fields") ) giphy: "Optional[Images]" = dc_field( default=None, metadata=dc_config(field_name="giphy") ) @dataclass class Audience(DataClassJsonMixin): avg_concurrent_viewers: int = dc_field( metadata=dc_config(field_name="avg_concurrent_viewers") ) hours_watched: float = dc_field(metadata=dc_config(field_name="hours_watched")) peak_concurrent_viewers: int = dc_field( metadata=dc_config(field_name="peak_concurrent_viewers") ) unique_viewers: int = dc_field(metadata=dc_config(field_name="unique_viewers")) viewer_connections: int = dc_field( metadata=dc_config(field_name="viewer_connections") ) concurrency_by_minute: "List[ConcurrencyMinute]" = dc_field( metadata=dc_config(field_name="concurrency_by_minute") ) peak_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="peak_at") ) ramp_up_min_to_90pct_peak: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="ramp_up_min_to_90pct_peak") ) retention_at_90pct_mark: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="retention_at_90pct_mark") ) retention_at_midpoint: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="retention_at_midpoint") ) shape: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="shape") ) AudioDefaultDeviceType = NewType("AudioDefaultDeviceType", str) class AudioDefaultDevice: EARPIECE: Final[AudioDefaultDeviceType] = "earpiece" SPEAKER: Final[AudioDefaultDeviceType] = "speaker" @dataclass class AudioSettings(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) # The device a call routes audio to by default. default_device: "AudioDefaultDevice" = dc_field( metadata=dc_config(field_name="default_device") ) hifi_audio_enabled: bool = dc_field( metadata=dc_config(field_name="hifi_audio_enabled") ) mic_default_on: bool = dc_field(metadata=dc_config(field_name="mic_default_on")) opus_dtx_enabled: bool = dc_field(metadata=dc_config(field_name="opus_dtx_enabled")) redundant_coding_enabled: bool = dc_field( metadata=dc_config(field_name="redundant_coding_enabled") ) speaker_default_on: bool = dc_field( metadata=dc_config(field_name="speaker_default_on") ) noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @dataclass class AudioSettingsRequest(DataClassJsonMixin): # The device a call routes audio to by default. default_device: "AudioDefaultDevice" = dc_field( metadata=dc_config(field_name="default_device") ) access_request_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="access_request_enabled") ) hifi_audio_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hifi_audio_enabled") ) mic_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mic_default_on") ) opus_dtx_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="opus_dtx_enabled") ) redundant_coding_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="redundant_coding_enabled") ) speaker_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="speaker_default_on") ) noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @dataclass class AudioSettingsResponse(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) # The device a call routes audio to by default. default_device: "AudioDefaultDevice" = dc_field( metadata=dc_config(field_name="default_device") ) hifi_audio_enabled: bool = dc_field( metadata=dc_config(field_name="hifi_audio_enabled") ) mic_default_on: bool = dc_field(metadata=dc_config(field_name="mic_default_on")) opus_dtx_enabled: bool = dc_field(metadata=dc_config(field_name="opus_dtx_enabled")) redundant_coding_enabled: bool = dc_field( metadata=dc_config(field_name="redundant_coding_enabled") ) speaker_default_on: bool = dc_field( metadata=dc_config(field_name="speaker_default_on") ) noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @dataclass class AutomodDetailsResponse(DataClassJsonMixin): action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) original_message_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="original_message_type") ) image_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) message_details: "Optional[FlagMessageDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="message_details") ) # Result of the message moderation result: "Optional[MessageModerationResult]" = dc_field( default=None, metadata=dc_config(field_name="result") ) AutomodModeType = NewType("AutomodModeType", str) class AutomodMode: AI: Final[AutomodModeType] = "AI" DISABLED: Final[AutomodModeType] = "disabled" SIMPLE: Final[AutomodModeType] = "simple" @dataclass class AutomodPlatformCircumventionConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) rules: "Optional[List[AutomodRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AutomodRule(DataClassJsonMixin): # What a moderation rule does when it matches. action: "ModerationAction" = dc_field(metadata=dc_config(field_name="action")) label: str = dc_field(metadata=dc_config(field_name="label")) threshold: float = dc_field(metadata=dc_config(field_name="threshold")) @dataclass class AutomodSemanticFiltersConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) rules: "Optional[List[AutomodSemanticFiltersRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AutomodSemanticFiltersRule(DataClassJsonMixin): # What a moderation rule does when it matches. action: "ModerationAction" = dc_field(metadata=dc_config(field_name="action")) name: str = dc_field(metadata=dc_config(field_name="name")) threshold: float = dc_field(metadata=dc_config(field_name="threshold")) @dataclass class AutomodToxicityConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) rules: "Optional[List[AutomodRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AzureRequest(DataClassJsonMixin): # The account name abs_account_name: str = dc_field(metadata=dc_config(field_name="abs_account_name")) # The client id abs_client_id: str = dc_field(metadata=dc_config(field_name="abs_client_id")) # The client secret abs_client_secret: str = dc_field( metadata=dc_config(field_name="abs_client_secret") ) # The tenant id abs_tenant_id: str = dc_field(metadata=dc_config(field_name="abs_tenant_id")) @dataclass class BackstageSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @dataclass class BackstageSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @dataclass class BackstageSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @dataclass class BanActionRequestPayload(DataClassJsonMixin): # Also ban user from all channels this moderator creates in the future ban_from_future_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ban_from_future_channels") ) # Ban only from specific channel channel_ban_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="channel_ban_only") ) channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Message deletion mode: soft, pruning, or hard delete_messages: "Optional[DeleteMessages]" = dc_field( default=None, metadata=dc_config(field_name="delete_messages") ) # Whether to ban by IP address ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) # Reason for the ban reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # Whether this is a shadow ban shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # Optional: ban user directly without review item target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) # Duration of ban in minutes timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) @dataclass class BanInfoResponse(DataClassJsonMixin): # When the ban was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The channel this ban applies to. Empty if this is an app-wide (global) ban rather than a per-channel ban. channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # When the ban expires expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Reason for the ban reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # Whether this is a shadow ban shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) channel: "Optional[ChannelMetadata]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BanOptions(DataClassJsonMixin): # How a ban or user deletion treats the user's messages. delete_messages: "Optional[DeleteMessages]" = dc_field( default=None, metadata=dc_config(field_name="delete_messages") ) duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="duration") ) ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) shadow_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow_ban") ) @dataclass class BanRequest(DataClassJsonMixin): # ID of the user to ban target_user_id: str = dc_field(metadata=dc_config(field_name="target_user_id")) # Whether to also ban the user from future channels created by the banner ban_from_future_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ban_from_future_channels") ) # ID of the user performing the ban banned_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="banned_by_id") ) # Channel where the ban applies channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # How a ban or user deletion treats the user's messages. delete_messages: "Optional[DeleteMessages]" = dc_field( default=None, metadata=dc_config(field_name="delete_messages") ) # Whether to delete reactions by the banned user on other users' messages delete_reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_reactions") ) # Whether to ban the user's IP address ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) # Optional explanation for the ban reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # Whether this is a shadow ban shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # Duration of the ban in minutes timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) # User request object banned_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) @dataclass class BanResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # User response object banned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BatchQueryActivityReactionsRequest(DataClassJsonMixin): # Activity IDs to fetch the user's reactions for (max 100) activity_ids: List[str] = dc_field(metadata=dc_config(field_name="activity_ids")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Server-side only. The user whose reactions to fetch; defaults to the authenticated user for client-side requests user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Optional filter on reaction_type or created_at filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BatchQueryActivityReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class BatchQueryCommentReactionsRequest(DataClassJsonMixin): # Comment IDs to fetch the user's reactions for (max 100) comment_ids: List[str] = dc_field(metadata=dc_config(field_name="comment_ids")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Server-side only. The user whose reactions to fetch; defaults to the authenticated user for client-side requests user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Optional filter on reaction_type or created_at filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BatchQueryCommentReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class BlendArrangeConfig(DataClassJsonMixin): # Minimum gap, 0 to 50, for every source without a min_gap entry default_min_gap: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="default_min_gap") ) # Minimum number of slots between two items of a source, per key value, 0 to 50. The key '*' requires weights['*']. Combinations of weights and gaps that cannot be satisfied are rejected min_gap: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="min_gap") ) # Relative weight per key value, greater than 0, at most 8 entries. Weights are normalized, so 80/20 equals 4/1. The key '*' is the catch-all source for key values without their own weight; unweighted values are otherwise placed after the blended section weights: "Optional[Dict[str, float]]" = dc_field( default=None, metadata=dc_config(field_name="weights") ) @dataclass class BlockActionRequestPayload(DataClassJsonMixin): # Reason for blocking reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class BlockListConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) explicit_urls_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="explicit_urls_only") ) match_substring: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="match_substring") ) rules: "Optional[List[BlockListRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class BlockListOptions(DataClassJsonMixin): # Blocklist behavior. One of: flag, block, shadow_block behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="behavior") ) # Blocklist name blocklist: str = dc_field(metadata=dc_config(field_name="blocklist")) @dataclass class BlockListResponse(DataClassJsonMixin): is_confusable_folding_enabled: bool = dc_field( metadata=dc_config(field_name="is_confusable_folding_enabled") ) is_leet_check_enabled: bool = dc_field( metadata=dc_config(field_name="is_leet_check_enabled") ) is_plural_check_enabled: bool = dc_field( metadata=dc_config(field_name="is_plural_check_enabled") ) is_substring_matching_enabled: bool = dc_field( metadata=dc_config(field_name="is_substring_matching_enabled") ) # Block list name name: str = dc_field(metadata=dc_config(field_name="name")) # Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist type: str = dc_field(metadata=dc_config(field_name="type")) # List of words to block words: List[str] = dc_field(metadata=dc_config(field_name="words")) # Date/time of creation created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) owner_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="owner_user_id") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Date/time of the last update updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class BlockListRule(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) @dataclass class BlockUserRequest(DataClassJsonMixin): # the user to block user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class BlockUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class BlockUsersRequest(DataClassJsonMixin): # User id to block blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BlockUsersResponse(DataClassJsonMixin): # User id who blocked another user blocked_by_user_id: str = dc_field( metadata=dc_config(field_name="blocked_by_user_id") ) # User id who got blocked blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) # Timestamp when the user was blocked created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class BlockedUserEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.blocked_user" in this case type: str = dc_field( default="call.blocked_user", metadata=dc_config(field_name="type") ) # User response object blocked_by_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocked_by_user") ) @dataclass class BlockedUserResponse(DataClassJsonMixin): # ID of the user who got blocked blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the user who blocked another user user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # User response object blocked_user: "UserResponse" = dc_field( metadata=dc_config(field_name="blocked_user") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) BlocklistBehaviorType = NewType("BlocklistBehaviorType", str) class BlocklistBehavior: BLOCK: Final[BlocklistBehaviorType] = "block" FLAG: Final[BlocklistBehaviorType] = "flag" @dataclass class BodyguardImageAnalysisConfig(DataClassJsonMixin): rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class BodyguardProfileSummary(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) display_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="display_name") ) text_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="text_type") ) @dataclass class BodyguardRule(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) severity_rules: "Optional[List[BodyguardSeverityRule]]" = dc_field( default=None, metadata=dc_config(field_name="severity_rules") ) @dataclass class BodyguardSeverityRule(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) severity: str = dc_field(metadata=dc_config(field_name="severity")) @dataclass class BookmarkAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.bookmark.added" in this case type: str = dc_field( default="feeds.bookmark.added", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BookmarkDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.bookmark.deleted" in this case type: str = dc_field( default="feeds.bookmark.deleted", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BookmarkFolderDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) bookmark_folder: "BookmarkFolderResponse" = dc_field( metadata=dc_config(field_name="bookmark_folder") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.bookmark_folder.deleted" in this case type: str = dc_field( default="feeds.bookmark_folder.deleted", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BookmarkFolderResponse(DataClassJsonMixin): # When the folder was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for the folder id: str = dc_field(metadata=dc_config(field_name="id")) # Name of the folder name: str = dc_field(metadata=dc_config(field_name="name")) # When the folder was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Custom data for the folder custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class BookmarkFolderUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) bookmark_folder: "BookmarkFolderResponse" = dc_field( metadata=dc_config(field_name="bookmark_folder") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.bookmark_folder.updated" in this case type: str = dc_field( default="feeds.bookmark_folder.updated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BookmarkResponse(DataClassJsonMixin): # When the bookmark was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the bookmarked object object_id: str = dc_field(metadata=dc_config(field_name="object_id")) # Type of the bookmarked object (activity or comment) object_type: str = dc_field(metadata=dc_config(field_name="object_type")) # When the bookmark was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) comment: "Optional[CommentResponse]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data for the bookmark custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) folder: "Optional[BookmarkFolderResponse]" = dc_field( default=None, metadata=dc_config(field_name="folder") ) @dataclass class BookmarkUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.bookmark.updated" in this case type: str = dc_field( default="feeds.bookmark.updated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class Bound(DataClassJsonMixin): inclusive: bool = dc_field(metadata=dc_config(field_name="inclusive")) value: float = dc_field(metadata=dc_config(field_name="value")) @dataclass class BroadcastDailyRollup(DataClassJsonMixin): broadcasts: int = dc_field(metadata=dc_config(field_name="broadcasts")) day: str = dc_field(metadata=dc_config(field_name="day")) dead_air_s: int = dc_field(metadata=dc_config(field_name="dead_air_s")) hours_watched: float = dc_field(metadata=dc_config(field_name="hours_watched")) incident_windows: int = dc_field(metadata=dc_config(field_name="incident_windows")) max_peak_concurrent_viewers: int = dc_field( metadata=dc_config(field_name="max_peak_concurrent_viewers") ) note: str = dc_field(metadata=dc_config(field_name="note")) schema_version: str = dc_field(metadata=dc_config(field_name="schema_version")) source_drops: int = dc_field(metadata=dc_config(field_name="source_drops")) unique_viewers_sum: int = dc_field( metadata=dc_config(field_name="unique_viewers_sum") ) top_broadcasts: "List[TopBroadcast]" = dc_field( metadata=dc_config(field_name="top_broadcasts") ) poor_viewers_by_cause: "PoorByCause" = dc_field( metadata=dc_config(field_name="poor_viewers_by_cause") ) @dataclass class BroadcastDigest(DataClassJsonMixin): schema_version: str = dc_field(metadata=dc_config(field_name="schema_version")) audience: "Audience" = dc_field(metadata=dc_config(field_name="audience")) broadcast: "BroadcastInfo" = dc_field(metadata=dc_config(field_name="broadcast")) coverage: "Coverage" = dc_field(metadata=dc_config(field_name="coverage")) joins: "Joins" = dc_field(metadata=dc_config(field_name="joins")) poor_tail: "PoorTail" = dc_field(metadata=dc_config(field_name="poor_tail")) quality: "Quality" = dc_field(metadata=dc_config(field_name="quality")) segments: "Segments" = dc_field(metadata=dc_config(field_name="segments")) source: "SourceHealth" = dc_field(metadata=dc_config(field_name="source")) viewers: "ViewerBehavior" = dc_field(metadata=dc_config(field_name="viewers")) @dataclass class BroadcastInfo(DataClassJsonMixin): app_id: int = dc_field(metadata=dc_config(field_name="app_id")) call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) duration_min: float = dc_field(metadata=dc_config(field_name="duration_min")) ended_at: str = dc_field(metadata=dc_config(field_name="ended_at")) started_at: str = dc_field(metadata=dc_config(field_name="started_at")) creators: List[str] = dc_field(metadata=dc_config(field_name="creators")) source_mode: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="source_mode") ) @dataclass class BroadcastSegment(DataClassJsonMixin): key: str = dc_field(metadata=dc_config(field_name="key")) sessions: int = dc_field(metadata=dc_config(field_name="sessions")) avg_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_quality_score") ) p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="share_pct") ) watch_share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="watch_share_pct") ) @dataclass class BroadcastSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) hls: "Optional[HLSSettings]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) rtmp: "Optional[RTMPSettings]" = dc_field( default=None, metadata=dc_config(field_name="rtmp") ) @dataclass class BroadcastSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) hls: "Optional[HLSSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) rtmp: "Optional[RTMPSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="rtmp") ) @dataclass class BroadcastSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) # HLSSettings is the payload for HLS settings hls: "HLSSettingsResponse" = dc_field(metadata=dc_config(field_name="hls")) # RTMPSettingsResponse is the payload for RTMP settings rtmp: "RTMPSettingsResponse" = dc_field(metadata=dc_config(field_name="rtmp")) @dataclass class BrowserDataResponse(DataClassJsonMixin): name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @dataclass class BulkActionAppealsRequest(DataClassJsonMixin): # Action to apply: unban, restore, unblock, mark_reviewed, or reject_appeal action_type: str = dc_field(metadata=dc_config(field_name="action_type")) # List of appeal UUIDs to process appeal_ids: List[str] = dc_field(metadata=dc_config(field_name="appeal_ids")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Configuration for mark reviewed action mark_reviewed: "Optional[MarkReviewedRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="mark_reviewed") ) # Configuration for rejecting an appeal reject_appeal: "Optional[RejectAppealRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="reject_appeal") ) # Configuration for restore action. State-aware: reverses whichever of a delete, a block, or a shadow block currently applies to the content (including both a delete and a block/shadow block at once). restore: "Optional[RestoreActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="restore") ) # Configuration for unban moderation action unban: "Optional[UnbanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unban") ) # Deprecated: Use restore instead, which now also reverses a block or shadow block. Configuration for unblock action. # Deprecated unblock: "Optional[UnblockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unblock") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BulkActionAppealsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Appeals that could not be processed, with per-item error messages errors: "List[BulkAppealError]" = dc_field(metadata=dc_config(field_name="errors")) # Successfully processed appeals results: "List[BulkAppealResult]" = dc_field( metadata=dc_config(field_name="results") ) @dataclass class BulkAppealError(DataClassJsonMixin): appeal_id: str = dc_field(metadata=dc_config(field_name="appeal_id")) error: str = dc_field(metadata=dc_config(field_name="error")) @dataclass class BulkAppealResult(DataClassJsonMixin): appeal_id: str = dc_field(metadata=dc_config(field_name="appeal_id")) appeal_item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal_item") ) @dataclass class BulkDeleteActionConfigRequest(DataClassJsonMixin): # UUIDs of the action configs to delete ids: List[str] = dc_field(metadata=dc_config(field_name="ids")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BulkDeleteActionConfigResponse(DataClassJsonMixin): # Number of action configs deleted deleted: int = dc_field(metadata=dc_config(field_name="deleted")) duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class BulkImageModerationRequest(DataClassJsonMixin): # URL to CSV file containing image URLs to moderate csv_file: str = dc_field(metadata=dc_config(field_name="csv_file")) @dataclass class BulkImageModerationResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # ID of the task for processing the bulk image moderation task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class BulkUpsertActionConfigRequest(DataClassJsonMixin): # List of action configs to create or update action_configs: "List[UpsertActionConfigItem]" = dc_field( metadata=dc_config(field_name="action_configs") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BulkUpsertActionConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The created or updated action configs in the same order as the request action_configs: "List[ModerationActionConfigResponse]" = dc_field( metadata=dc_config(field_name="action_configs") ) @dataclass class BypassActionRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @dataclass class BypassRequest(DataClassJsonMixin): # Whether to enable moderation bypass for this user enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) # ID of the user to update target_user_id: str = dc_field(metadata=dc_config(field_name="target_user_id")) @dataclass class BypassResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class CallAcceptedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.accepted" in this case type: str = dc_field(default="call.accepted", metadata=dc_config(field_name="type")) @dataclass class CallActionOptions(DataClassJsonMixin): duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="duration") ) flag_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="flag_reason") ) kick_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="kick_reason") ) mute_audio: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mute_audio") ) mute_video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mute_video") ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) warning_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="warning_text") ) @dataclass class CallClosedCaption(DataClassJsonMixin): end_time: datetime = dc_field( metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) language: str = dc_field(metadata=dc_config(field_name="language")) speaker_id: str = dc_field(metadata=dc_config(field_name="speaker_id")) start_time: datetime = dc_field( metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) text: str = dc_field(metadata=dc_config(field_name="text")) translated: bool = dc_field(metadata=dc_config(field_name="translated")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) service: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="service") ) @dataclass class CallClosedCaptionsFailedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of event: "call.closed_captions_failed" in this case type: str = dc_field( default="call.closed_captions_failed", metadata=dc_config(field_name="type") ) @dataclass class CallClosedCaptionsStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of event: "call.closed_captions_started" in this case type: str = dc_field( default="call.closed_captions_started", metadata=dc_config(field_name="type") ) @dataclass class CallClosedCaptionsStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of event: "call.transcription_stopped" in this case type: str = dc_field( default="call.closed_captions_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallCreatedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the members added to this call members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.created" in this case type: str = dc_field(default="call.created", metadata=dc_config(field_name="type")) @dataclass class CallCustomPropertyParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @dataclass class CallDTMFEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The DTMF digit (0-9, *, #, A-D) digit: str = dc_field(metadata=dc_config(field_name="digit")) # Duration of the digit press in milliseconds duration_ms: int = dc_field(metadata=dc_config(field_name="duration_ms")) # Monotonically increasing sequence number for ordering DTMF events within a session seq_number: int = dc_field(metadata=dc_config(field_name="seq_number")) # When the digit press ended and was detected timestamp: datetime = dc_field( metadata=dc_config( field_name="timestamp", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.dtmf" in this case type: str = dc_field(default="call.dtmf", metadata=dc_config(field_name="type")) @dataclass class CallDeletedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.deleted" in this case type: str = dc_field(default="call.deleted", metadata=dc_config(field_name="type")) @dataclass class CallDurationReport(DataClassJsonMixin): histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class CallDurationReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateCallDurationReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class CallEndedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.ended" in this case type: str = dc_field(default="call.ended", metadata=dc_config(field_name="type")) # The reason why the call ended, if available reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # The list of members in the call members: "Optional[List[MemberResponse]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CallFrameRecordingFailedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.frame_recording_failed" in this case type: str = dc_field( default="call.frame_recording_failed", metadata=dc_config(field_name="type") ) @dataclass class CallFrameRecordingFrameReadyEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) # The time the frame was captured captured_at: datetime = dc_field( metadata=dc_config( field_name="captured_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # The type of the track frame was captured from (TRACK_TYPE_VIDEO|TRACK_TYPE_SCREEN_SHARE) track_type: str = dc_field(metadata=dc_config(field_name="track_type")) # The URL of the frame url: str = dc_field(metadata=dc_config(field_name="url")) # The users in the frame users: "Dict[str, UserResponse]" = dc_field(metadata=dc_config(field_name="users")) # The type of event: "call.frame_recording_ready" in this case type: str = dc_field( default="call.frame_recording_ready", metadata=dc_config(field_name="type") ) @dataclass class CallFrameRecordingStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.frame_recording_started" in this case type: str = dc_field( default="call.frame_recording_started", metadata=dc_config(field_name="type") ) @dataclass class CallFrameRecordingStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.frame_recording_stopped" in this case type: str = dc_field( default="call.frame_recording_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallHLSBroadcastingFailedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of event: "call.hls_broadcasting_failed" in this case type: str = dc_field( default="call.hls_broadcasting_failed", metadata=dc_config(field_name="type") ) @dataclass class CallHLSBroadcastingStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) hls_playlist_url: str = dc_field(metadata=dc_config(field_name="hls_playlist_url")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.hls_broadcasting_started" in this case type: str = dc_field( default="call.hls_broadcasting_started", metadata=dc_config(field_name="type") ) @dataclass class CallHLSBroadcastingStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of event: "call.hls_broadcasting_stopped" in this case type: str = dc_field( default="call.hls_broadcasting_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallIngressResponse(DataClassJsonMixin): # RTMP input settings rtmp: "RTMPIngress" = dc_field(metadata=dc_config(field_name="rtmp")) srt: "SRTIngress" = dc_field(metadata=dc_config(field_name="srt")) whip: "WHIPIngress" = dc_field(metadata=dc_config(field_name="whip")) @dataclass class CallLevelEventPayload(DataClassJsonMixin): event_type: str = dc_field(metadata=dc_config(field_name="event_type")) timestamp: int = dc_field(metadata=dc_config(field_name="timestamp")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) payload: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="payload") ) CallLifecycleModeType = NewType("CallLifecycleModeType", str) class CallLifecycleMode: REUSABLE: Final[CallLifecycleModeType] = "reusable" SINGLE_USE: Final[CallLifecycleModeType] = "single_use" @dataclass class CallLiveStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.live_started" in this case type: str = dc_field( default="call.live_started", metadata=dc_config(field_name="type") ) @dataclass class CallMemberAddedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the members added to this call members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.member_added" in this case type: str = dc_field( default="call.member_added", metadata=dc_config(field_name="type") ) @dataclass class CallMemberRemovedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the list of member IDs removed from the call members: List[str] = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.member_removed" in this case type: str = dc_field( default="call.member_removed", metadata=dc_config(field_name="type") ) @dataclass class CallMemberUpdatedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The list of members that were updated members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.member_updated" in this case type: str = dc_field( default="call.member_updated", metadata=dc_config(field_name="type") ) @dataclass class CallMemberUpdatedPermissionEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The list of members that were updated members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The capabilities by role for this call capabilities_by_role: "Dict[str, List[str]]" = dc_field( metadata=dc_config(field_name="capabilities_by_role") ) # The type of event: "call.member_added" in this case type: str = dc_field( default="call.member_updated_permission", metadata=dc_config(field_name="type") ) @dataclass class CallMissedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) notify_user: bool = dc_field(metadata=dc_config(field_name="notify_user")) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # List of members who missed the call members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.notification" in this case type: str = dc_field(default="call.missed", metadata=dc_config(field_name="type")) @dataclass class CallModerationBlurEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The user ID whose video stream is being blurred user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Custom data associated with the moderation action custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "call.moderation_blur" in this case type: str = dc_field( default="call.moderation_blur", metadata=dc_config(field_name="type") ) @dataclass class CallModerationWarningEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The warning message message: str = dc_field(metadata=dc_config(field_name="message")) # The user ID who is receiving the warning user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Custom data associated with the moderation action custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "call.moderation_warning" in this case type: str = dc_field( default="call.moderation_warning", metadata=dc_config(field_name="type") ) @dataclass class CallNotificationEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # Call members members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.notification" in this case type: str = dc_field( default="call.notification", metadata=dc_config(field_name="type") ) @dataclass class CallParticipantCountReport(DataClassJsonMixin): histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class CallParticipantCountReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateCallParticipantCountReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class CallParticipantResponse(DataClassJsonMixin): joined_at: datetime = dc_field( metadata=dc_config( field_name="joined_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) role: str = dc_field(metadata=dc_config(field_name="role")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class CallParticipantTimeline(DataClassJsonMixin): severity: str = dc_field(metadata=dc_config(field_name="severity")) timestamp: datetime = dc_field( metadata=dc_config( field_name="timestamp", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field(metadata=dc_config(field_name="type")) data: Dict[str, object] = dc_field(metadata=dc_config(field_name="data")) @dataclass class CallReactionEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) reaction: "VideoReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of event: "call.reaction_new" in this case type: str = dc_field( default="call.reaction_new", metadata=dc_config(field_name="type") ) @dataclass class CallRecording(DataClassJsonMixin): end_time: datetime = dc_field( metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) filename: str = dc_field(metadata=dc_config(field_name="filename")) # The layout a call recording is produced in. recording_type: "RecordingType" = dc_field( metadata=dc_config(field_name="recording_type") ) session_id: str = dc_field(metadata=dc_config(field_name="session_id")) start_time: datetime = dc_field( metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) url: str = dc_field(metadata=dc_config(field_name="url")) @dataclass class CallRecordingFailedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording recording_type: "RecordingType" = dc_field( metadata=dc_config(field_name="recording_type") ) # The type of event: "call.recording_failed" in this case type: str = dc_field( default="call.recording_failed", metadata=dc_config(field_name="type") ) @dataclass class CallRecordingReadyEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording recording_type: "RecordingType" = dc_field( metadata=dc_config(field_name="recording_type") ) # CallRecording represents a recording of a call. call_recording: "CallRecording" = dc_field( metadata=dc_config(field_name="call_recording") ) # The type of event: "call.recording_ready" in this case type: str = dc_field( default="call.recording_ready", metadata=dc_config(field_name="type") ) @dataclass class CallRecordingStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording recording_type: "RecordingType" = dc_field( metadata=dc_config(field_name="recording_type") ) # The type of event: "call.recording_started" in this case type: str = dc_field( default="call.recording_started", metadata=dc_config(field_name="type") ) @dataclass class CallRecordingStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording recording_type: "RecordingType" = dc_field( metadata=dc_config(field_name="recording_type") ) # The type of event: "call.recording_stopped" in this case type: str = dc_field( default="call.recording_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallRejectedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.rejected" in this case type: str = dc_field(default="call.rejected", metadata=dc_config(field_name="type")) # Provides information about why the call was rejected. You can provide any value, but the Stream API and SDKs use these default values: rejected, cancel, timeout and busy reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class CallReportResponse(DataClassJsonMixin): score: float = dc_field(metadata=dc_config(field_name="score")) ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CallRequest(DataClassJsonMixin): channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="video") ) members: "Optional[List[MemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # User request object created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) settings_override: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings_override") ) @dataclass class CallResponse(DataClassJsonMixin): backstage: bool = dc_field(metadata=dc_config(field_name="backstage")) captioning: bool = dc_field(metadata=dc_config(field_name="captioning")) # The unique identifier for a call (:) cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) current_session_id: str = dc_field( metadata=dc_config(field_name="current_session_id") ) # Call ID id: str = dc_field(metadata=dc_config(field_name="id")) recording: bool = dc_field(metadata=dc_config(field_name="recording")) transcribing: bool = dc_field(metadata=dc_config(field_name="transcribing")) translating: bool = dc_field(metadata=dc_config(field_name="translating")) # The type of call type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) egress: "EgressResponse" = dc_field(metadata=dc_config(field_name="egress")) # CallIngressResponse is the payload for ingress settings ingress: "CallIngressResponse" = dc_field(metadata=dc_config(field_name="ingress")) settings: "CallSettingsResponse" = dc_field( metadata=dc_config(field_name="settings") ) channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Date/time when the call ended ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) # 10-digit routing number for SIP routing routing_number: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="routing_number") ) # Date/time when the call will start starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) session: "Optional[CallSessionResponse]" = dc_field( default=None, metadata=dc_config(field_name="session") ) thumbnails: "Optional[ThumbnailResponse]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) @dataclass class CallRingEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) video: bool = dc_field(metadata=dc_config(field_name="video")) # Call members members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.notification" in this case type: str = dc_field(default="call.ring", metadata=dc_config(field_name="type")) # Identifies this ring of the call session ring_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ring_id") ) @dataclass class CallRingSettledEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the user who rang initiated_by: str = dc_field(metadata=dc_config(field_name="initiated_by")) # Final outcome of the ring: answered_all, answered_some, rejected_all, missed_all, cancelled or mixed outcome: str = dc_field(metadata=dc_config(field_name="outcome")) # When the ring was sent rang_at: datetime = dc_field( metadata=dc_config( field_name="rang_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Identifies this ring of the call session, as carried on call.ring ring_id: str = dc_field(metadata=dc_config(field_name="ring_id")) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # Why the ring closed: answered, rejected, cancel, timeout, ended or auto_end settle_reason: str = dc_field(metadata=dc_config(field_name="settle_reason")) # When the outcome left ringing settled_at: datetime = dc_field( metadata=dc_config( field_name="settled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the user whose action closed the ring, or 'server' for the missed-call deadline and automatic ends settled_by: str = dc_field(metadata=dc_config(field_name="settled_by")) # Final state of every rung user, keyed by user ID targets: "Dict[str, RingSettledTarget]" = dc_field( metadata=dc_config(field_name="targets") ) # The type of event: "call.ring_settled" in this case type: str = dc_field( default="call.ring_settled", metadata=dc_config(field_name="type") ) @dataclass class CallRtmpBroadcastFailedEvent(DataClassJsonMixin): # The unique identifier for a call (:) call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Name of the given RTMP broadcast name: str = dc_field(metadata=dc_config(field_name="name")) # The type of event: "call.rtmp_broadcast_failed" in this case type: str = dc_field( default="call.rtmp_broadcast_failed", metadata=dc_config(field_name="type") ) @dataclass class CallRtmpBroadcastStartedEvent(DataClassJsonMixin): # The unique identifier for a call (:) call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Name of the given RTMP broadcast name: str = dc_field(metadata=dc_config(field_name="name")) # The type of event: "call.rtmp_broadcast_started" in this case type: str = dc_field( default="call.rtmp_broadcast_started", metadata=dc_config(field_name="type") ) @dataclass class CallRtmpBroadcastStoppedEvent(DataClassJsonMixin): # The unique identifier for a call (:) call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Name of the given RTMP broadcast name: str = dc_field(metadata=dc_config(field_name="name")) # The type of event: "call.rtmp_broadcast_stopped" in this case type: str = dc_field( default="call.rtmp_broadcast_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallRuleActionSequence(DataClassJsonMixin): violation_number: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="violation_number") ) actions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="actions") ) call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) @dataclass class CallSessionEndedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.session_ended" in this case type: str = dc_field( default="call.session_ended", metadata=dc_config(field_name="type") ) @dataclass class CallSessionParticipantCountsUpdatedEvent(DataClassJsonMixin): anonymous_participant_count: int = dc_field( metadata=dc_config(field_name="anonymous_participant_count") ) call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) participants_count_by_role: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="participants_count_by_role") ) # The type of event: "call.session_participant_count_updated" in this case type: str = dc_field( default="call.session_participant_count_updated", metadata=dc_config(field_name="type"), ) @dataclass class CallSessionParticipantJoinedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) participant: "CallParticipantResponse" = dc_field( metadata=dc_config(field_name="participant") ) # The type of event: "call.session_participant_joined" in this case type: str = dc_field( default="call.session_participant_joined", metadata=dc_config(field_name="type") ) @dataclass class CallSessionParticipantLeftEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The duration participant was in the session in seconds duration_seconds: int = dc_field(metadata=dc_config(field_name="duration_seconds")) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) participant: "CallParticipantResponse" = dc_field( metadata=dc_config(field_name="participant") ) # The type of event: "call.session_participant_left" in this case type: str = dc_field( default="call.session_participant_left", metadata=dc_config(field_name="type") ) # The reason why the participant left the session reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class CallSessionResponse(DataClassJsonMixin): anonymous_participant_count: int = dc_field( metadata=dc_config(field_name="anonymous_participant_count") ) id: str = dc_field(metadata=dc_config(field_name="id")) participants: "List[CallParticipantResponse]" = dc_field( metadata=dc_config(field_name="participants") ) accepted_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="accepted_by", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) missed_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="missed_by", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) participants_count_by_role: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="participants_count_by_role") ) rejected_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="rejected_by", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) live_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="live_ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) live_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="live_started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) timer_ends_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="timer_ends_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CallSessionStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The type of event: "call.session_started" in this case type: str = dc_field( default="call.session_started", metadata=dc_config(field_name="type") ) @dataclass class CallSettings(DataClassJsonMixin): audio: "Optional[AudioSettings]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) backstage: "Optional[BackstageSettings]" = dc_field( default=None, metadata=dc_config(field_name="backstage") ) broadcasting: "Optional[BroadcastSettings]" = dc_field( default=None, metadata=dc_config(field_name="broadcasting") ) frame_recording: "Optional[FrameRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) geofencing: "Optional[GeofenceSettings]" = dc_field( default=None, metadata=dc_config(field_name="geofencing") ) individual_recording: "Optional[IndividualRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) ingress: "Optional[IngressSettings]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) limits: "Optional[LimitsSettings]" = dc_field( default=None, metadata=dc_config(field_name="limits") ) raw_recording: "Optional[RawRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) recording: "Optional[RecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="recording") ) ring: "Optional[RingSettings]" = dc_field( default=None, metadata=dc_config(field_name="ring") ) screensharing: "Optional[ScreensharingSettings]" = dc_field( default=None, metadata=dc_config(field_name="screensharing") ) session: "Optional[SessionSettings]" = dc_field( default=None, metadata=dc_config(field_name="session") ) thumbnails: "Optional[ThumbnailsSettings]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) transcription: "Optional[TranscriptionSettings]" = dc_field( default=None, metadata=dc_config(field_name="transcription") ) video: "Optional[VideoSettings]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class CallSettingsRequest(DataClassJsonMixin): audio: "Optional[AudioSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) backstage: "Optional[BackstageSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="backstage") ) broadcasting: "Optional[BroadcastSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="broadcasting") ) encryption: "Optional[EncryptionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="encryption") ) frame_recording: "Optional[FrameRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) geofencing: "Optional[GeofenceSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="geofencing") ) individual_recording: "Optional[IndividualRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) ingress: "Optional[IngressSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) lifecycle: "Optional[LifecycleSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="lifecycle") ) limits: "Optional[LimitsSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="limits") ) raw_recording: "Optional[RawRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) recording: "Optional[RecordSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="recording") ) ring: "Optional[RingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="ring") ) screensharing: "Optional[ScreensharingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="screensharing") ) session: "Optional[SessionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="session") ) thumbnails: "Optional[ThumbnailsSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) transcription: "Optional[TranscriptionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="transcription") ) video: "Optional[VideoSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class CallSettingsResponse(DataClassJsonMixin): audio: "AudioSettingsResponse" = dc_field(metadata=dc_config(field_name="audio")) backstage: "BackstageSettingsResponse" = dc_field( metadata=dc_config(field_name="backstage") ) # BroadcastSettingsResponse is the payload for broadcasting settings broadcasting: "BroadcastSettingsResponse" = dc_field( metadata=dc_config(field_name="broadcasting") ) # EncryptionSettings is the payload for end-to-end encryption settings encryption: "EncryptionSettingsResponse" = dc_field( metadata=dc_config(field_name="encryption") ) frame_recording: "FrameRecordingSettingsResponse" = dc_field( metadata=dc_config(field_name="frame_recording") ) geofencing: "GeofenceSettingsResponse" = dc_field( metadata=dc_config(field_name="geofencing") ) individual_recording: "IndividualRecordingSettingsResponse" = dc_field( metadata=dc_config(field_name="individual_recording") ) # LifecycleSettings is the payload for call lifecycle settings lifecycle: "LifecycleSettingsResponse" = dc_field( metadata=dc_config(field_name="lifecycle") ) limits: "LimitsSettingsResponse" = dc_field(metadata=dc_config(field_name="limits")) raw_recording: "RawRecordingSettingsResponse" = dc_field( metadata=dc_config(field_name="raw_recording") ) # RecordSettings is the payload for recording settings recording: "RecordSettingsResponse" = dc_field( metadata=dc_config(field_name="recording") ) ring: "RingSettingsResponse" = dc_field(metadata=dc_config(field_name="ring")) screensharing: "ScreensharingSettingsResponse" = dc_field( metadata=dc_config(field_name="screensharing") ) session: "SessionSettingsResponse" = dc_field( metadata=dc_config(field_name="session") ) thumbnails: "ThumbnailsSettingsResponse" = dc_field( metadata=dc_config(field_name="thumbnails") ) transcription: "TranscriptionSettingsResponse" = dc_field( metadata=dc_config(field_name="transcription") ) video: "VideoSettingsResponse" = dc_field(metadata=dc_config(field_name="video")) ingress: "Optional[IngressSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) @dataclass class CallStateResponseFields(DataClassJsonMixin): # List of call members members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class CallStatsLocation(DataClassJsonMixin): accuracy_radius_meters: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="accuracy_radius_meters") ) city: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="city")) continent: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="continent") ) country: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country") ) country_iso_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_iso_code") ) latitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latitude") ) longitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="longitude") ) subdivision: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="subdivision") ) @dataclass class CallStatsMapLocation(DataClassJsonMixin): count: int = dc_field(metadata=dc_config(field_name="count")) live_count: int = dc_field(metadata=dc_config(field_name="live_count")) location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class CallStatsMapPublisher(DataClassJsonMixin): is_live: bool = dc_field(metadata=dc_config(field_name="is_live")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) published_tracks: "PublishedTrackFlags" = dc_field( metadata=dc_config(field_name="published_tracks") ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) publisher_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_type") ) location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class CallStatsMapPublishers(DataClassJsonMixin): publishers: "List[CallStatsMapPublisher]" = dc_field( metadata=dc_config(field_name="publishers") ) @dataclass class CallStatsMapSFUs(DataClassJsonMixin): locations: "List[SFULocationResponse]" = dc_field( metadata=dc_config(field_name="locations") ) @dataclass class CallStatsMapSubscriber(DataClassJsonMixin): is_live: bool = dc_field(metadata=dc_config(field_name="is_live")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class CallStatsMapSubscribers(DataClassJsonMixin): locations: "List[CallStatsMapLocation]" = dc_field( metadata=dc_config(field_name="locations") ) participants: "Optional[List[CallStatsMapSubscriber]]" = dc_field( default=None, metadata=dc_config(field_name="participants") ) @dataclass class CallStatsParticipant(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) sessions: "List[CallStatsParticipantSession]" = dc_field( metadata=dc_config(field_name="sessions") ) latest_activity_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="latest_activity_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="roles") ) @dataclass class CallStatsParticipantCounts(DataClassJsonMixin): live_sessions: int = dc_field(metadata=dc_config(field_name="live_sessions")) participants: int = dc_field(metadata=dc_config(field_name="participants")) peak_concurrent_sessions: int = dc_field( metadata=dc_config(field_name="peak_concurrent_sessions") ) peak_concurrent_users: int = dc_field( metadata=dc_config(field_name="peak_concurrent_users") ) publishers: int = dc_field(metadata=dc_config(field_name="publishers")) sessions: int = dc_field(metadata=dc_config(field_name="sessions")) sfus_used: int = dc_field(metadata=dc_config(field_name="sfus_used")) average_jitter_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="average_jitter_ms") ) average_latency_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="average_latency_ms") ) avg_user_rating: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_user_rating") ) call_event_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="call_event_count") ) cq_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cq_score") ) max_freezes_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_freezes_duration_ms") ) min_user_rating: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_user_rating") ) total_participant_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_participant_duration") ) @dataclass class CallStatsParticipantSession(DataClassJsonMixin): is_live: bool = dc_field(metadata=dc_config(field_name="is_live")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) published_tracks: "PublishedTrackFlags" = dc_field( metadata=dc_config(field_name="published_tracks") ) browser: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser") ) browser_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser_version") ) cq_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cq_score") ) current_ip: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_ip") ) current_sfu: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_sfu") ) distance_to_sfu_kilometers: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="distance_to_sfu_kilometers") ) ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) freezes_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="freezes_duration_ms") ) ingress: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ingress") ) jitter_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) latency_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="latency_ms") ) os: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="os")) publisher_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_type") ) sdk: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="sdk")) sdk_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sdk_version") ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) unified_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="unified_session_id") ) webrtc_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webrtc_version") ) location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class CallStatsReportReadyEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) # The type of event, "call.report_ready" in this case type: str = dc_field( default="call.stats_report_ready", metadata=dc_config(field_name="type") ) # Whether participants_overview is truncated by the server-side limit is_trimmed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_trimmed") ) # Top participant sessions overview participants_overview: "Optional[List[CallStatsParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="participants_overview") ) @dataclass class CallStatsReportSummaryResponse(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) call_duration_seconds: int = dc_field( metadata=dc_config(field_name="call_duration_seconds") ) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_status: str = dc_field(metadata=dc_config(field_name="call_status")) first_stats_time: datetime = dc_field( metadata=dc_config( field_name="first_stats_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) min_user_rating: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_user_rating") ) quality_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="quality_score") ) @dataclass class CallStatsSessionResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) generated_at: datetime = dc_field( metadata=dc_config( field_name="generated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CallTranscription(DataClassJsonMixin): end_time: datetime = dc_field( metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) filename: str = dc_field(metadata=dc_config(field_name="filename")) session_id: str = dc_field(metadata=dc_config(field_name="session_id")) start_time: datetime = dc_field( metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) url: str = dc_field(metadata=dc_config(field_name="url")) language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) translated: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="translated") ) @dataclass class CallTranscriptionFailedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of event: "call.transcription_failed" in this case type: str = dc_field( default="call.transcription_failed", metadata=dc_config(field_name="type") ) # The error message detailing why transcription failed. error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) @dataclass class CallTranscriptionReadyEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # CallTranscription represents a transcription of a call. call_transcription: "CallTranscription" = dc_field( metadata=dc_config(field_name="call_transcription") ) # The type of event: "call.transcription_ready" in this case type: str = dc_field( default="call.transcription_ready", metadata=dc_config(field_name="type") ) @dataclass class CallTranscriptionStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of event: "call.transcription_started" in this case type: str = dc_field( default="call.transcription_started", metadata=dc_config(field_name="type") ) @dataclass class CallTranscriptionStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of event: "call.transcription_stopped" in this case type: str = dc_field( default="call.transcription_stopped", metadata=dc_config(field_name="type") ) @dataclass class CallType(DataClassJsonMixin): app: int = dc_field(metadata=dc_config(field_name="app")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: int = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) recording_external_storage: str = dc_field( metadata=dc_config(field_name="recording_external_storage") ) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) notification_settings: "Optional[NotificationSettings]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) settings: "Optional[CallSettings]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @dataclass class CallTypeResponse(DataClassJsonMixin): # the time the call type was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the name of the call type name: str = dc_field(metadata=dc_config(field_name="name")) # the time the call type was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the permissions granted to each role grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) notification_settings: "NotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="notification_settings") ) settings: "CallSettingsResponse" = dc_field( metadata=dc_config(field_name="settings") ) # the external storage for the call type external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @dataclass class CallTypeRuleParameters(DataClassJsonMixin): call_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_type") ) @dataclass class CallUpdatedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) # The capabilities by role for this call capabilities_by_role: "Dict[str, List[str]]" = dc_field( metadata=dc_config(field_name="capabilities_by_role") ) # The type of event: "call.updated" in this case type: str = dc_field(default="call.updated", metadata=dc_config(field_name="type")) @dataclass class CallUserFeedbackSubmittedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The rating given by the user (1-5) rating: int = dc_field(metadata=dc_config(field_name="rating")) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event, "call.user_feedback" in this case type: str = dc_field( default="call.user_feedback_submitted", metadata=dc_config(field_name="type") ) # The reason provided by the user for the rating reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) sdk: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="sdk")) sdk_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sdk_version") ) # Custom data provided by the user custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CallUserMutedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) from_user_id: str = dc_field(metadata=dc_config(field_name="from_user_id")) reason: str = dc_field(metadata=dc_config(field_name="reason")) muted_user_ids: List[str] = dc_field( metadata=dc_config(field_name="muted_user_ids") ) # The type of event: "call.user_muted" in this case type: str = dc_field( default="call.user_muted", metadata=dc_config(field_name="type") ) @dataclass class CallViolationCountParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class CallsPerDayReport(DataClassJsonMixin): count: int = dc_field(metadata=dc_config(field_name="count")) @dataclass class CallsPerDayReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateCallsPerDayReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) CameraFacingType = NewType("CameraFacingType", str) class CameraFacing: BACK: Final[CameraFacingType] = "back" EXTERNAL: Final[CameraFacingType] = "external" FRONT: Final[CameraFacingType] = "front" @dataclass class CampaignChannelMember(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CampaignChannelTemplate(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) members: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="members") ) members_template: "Optional[List[CampaignChannelMember]]" = dc_field( default=None, metadata=dc_config(field_name="members_template") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CampaignCompletedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="campaign.completed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) @dataclass class CampaignMessageTemplate(DataClassJsonMixin): text: str = dc_field(metadata=dc_config(field_name="text")) poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) searchable: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="searchable") ) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CampaignResponse(DataClassJsonMixin): create_channels: bool = dc_field(metadata=dc_config(field_name="create_channels")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) description: str = dc_field(metadata=dc_config(field_name="description")) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) sender_id: str = dc_field(metadata=dc_config(field_name="sender_id")) show_channels: bool = dc_field(metadata=dc_config(field_name="show_channels")) skip_push: bool = dc_field(metadata=dc_config(field_name="skip_push")) skip_webhook: bool = dc_field(metadata=dc_config(field_name="skip_webhook")) status: str = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) segment_ids: List[str] = dc_field(metadata=dc_config(field_name="segment_ids")) segments: "List[Segment]" = dc_field(metadata=dc_config(field_name="segments")) user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) users: "List[UserResponse]" = dc_field(metadata=dc_config(field_name="users")) stats: "CampaignStatsResponse" = dc_field(metadata=dc_config(field_name="stats")) scheduled_for: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_for", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether a campaign includes or excludes its sender. sender_mode: "Optional[CampaignSenderMode]" = dc_field( default=None, metadata=dc_config(field_name="sender_mode") ) # How a campaign appears to its sender. sender_visibility: "Optional[CampaignSenderVisibility]" = dc_field( default=None, metadata=dc_config(field_name="sender_visibility") ) stop_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="stop_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) channel_template: "Optional[CampaignChannelTemplate]" = dc_field( default=None, metadata=dc_config(field_name="channel_template") ) message_template: "Optional[CampaignMessageTemplate]" = dc_field( default=None, metadata=dc_config(field_name="message_template") ) # User response object sender: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="sender") ) CampaignSenderModeType = NewType("CampaignSenderModeType", str) class CampaignSenderMode: EXCLUDE: Final[CampaignSenderModeType] = "exclude" INCLUDE: Final[CampaignSenderModeType] = "include" CampaignSenderVisibilityType = NewType("CampaignSenderVisibilityType", str) class CampaignSenderVisibility: ARCHIVED: Final[CampaignSenderVisibilityType] = "archived" HIDDEN: Final[CampaignSenderVisibilityType] = "hidden" @dataclass class CampaignStartedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="campaign.started", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) @dataclass class CampaignStatsResponse(DataClassJsonMixin): progress: float = dc_field(metadata=dc_config(field_name="progress")) stats_channels_created: int = dc_field( metadata=dc_config(field_name="stats_channels_created") ) stats_completed_at: datetime = dc_field( metadata=dc_config( field_name="stats_completed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) stats_messages_sent: int = dc_field( metadata=dc_config(field_name="stats_messages_sent") ) stats_started_at: datetime = dc_field( metadata=dc_config( field_name="stats_started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) stats_users_read: int = dc_field(metadata=dc_config(field_name="stats_users_read")) stats_users_sent: int = dc_field(metadata=dc_config(field_name="stats_users_sent")) @dataclass class CancelExportFeedsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class CancelImportV2TaskResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class CastPollVoteRequest(DataClassJsonMixin): # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) vote: "Optional[VoteData]" = dc_field( default=None, metadata=dc_config(field_name="vote") ) @dataclass class ChangeFeedVisibilityRequest(DataClassJsonMixin): # Feed visibility level: public, visible, followers, members, or private visibility: "FeedVisibility" = dc_field(metadata=dc_config(field_name="visibility")) # What to do with existing pending follows when loosening visibility from 'followers': auto_approve (default) or reject pending_follows_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pending_follows_action") ) @dataclass class ChangeFeedVisibilityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) @dataclass class ChannelBanResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) scopes: List[str] = dc_field(metadata=dc_config(field_name="scopes")) channel_ban: "Optional[ChannelBanScopeResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel_ban") ) future_channel_ban: "Optional[ChannelBanScopeResponse]" = dc_field( default=None, metadata=dc_config(field_name="future_channel_ban") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelBanScopeResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) shadow: bool = dc_field(metadata=dc_config(field_name="shadow")) expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # User response object banned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) @dataclass class ChannelBansScopeTotals(DataClassJsonMixin): channel: int = dc_field(metadata=dc_config(field_name="channel")) future_channel: int = dc_field(metadata=dc_config(field_name="future_channel")) @dataclass class ChannelBatchCompletedEvent(DataClassJsonMixin): batch_created_at: datetime = dc_field( metadata=dc_config( field_name="batch_created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) operation: str = dc_field(metadata=dc_config(field_name="operation")) status: str = dc_field(metadata=dc_config(field_name="status")) success_channels_count: int = dc_field( metadata=dc_config(field_name="success_channels_count") ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) failed_channels: "List[FailedChannelUpdates]" = dc_field( metadata=dc_config(field_name="failed_channels") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="channel_batch_update.completed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ChannelBatchMemberRequest(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) @dataclass class ChannelBatchStartedEvent(DataClassJsonMixin): batch_created_at: datetime = dc_field( metadata=dc_config( field_name="batch_created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) finished_at: datetime = dc_field( metadata=dc_config( field_name="finished_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) operation: str = dc_field(metadata=dc_config(field_name="operation")) status: str = dc_field(metadata=dc_config(field_name="status")) success_channels_count: int = dc_field( metadata=dc_config(field_name="success_channels_count") ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) failed_channels: "List[FailedChannelUpdates]" = dc_field( metadata=dc_config(field_name="failed_channels") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="channel_batch_update.started", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ChannelBatchUpdateRequest(DataClassJsonMixin): operation: str = dc_field(metadata=dc_config(field_name="operation")) # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # Required with the `addMembersHideHistory` operation, and rejected with every other operation including `addMembers`. Hides each matched channel's history before this time from the members the operation adds. Members that already belong to a matched channel are never affected. Must be in RFC3339 format (e.g., "2024-01-01T10:00:00Z") and in the past. hide_history_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_history_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # For updateData and hide only. Requires a root cids $eq or $in filter with at most 100 CIDs and no root $or/$and. A synchronous hide also requires 1 to 10 distinct member user IDs. Split larger selections into requests of at most 100 CIDs. A success_channels_count response means the database update completed; a task_id response means it was queued and must be polled, including on older API nodes. synchronous: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="synchronous") ) # `updateData` only. Deletes these keys from each channel's existing custom object, leaving every other custom key untouched. Keys are dot-paths; deleting a key that does not exist is a no-op. Cannot be combined with `data.custom` custom_unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="custom_unset") ) members: "Optional[List[ChannelBatchMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # `updateData` only. Merges these keys into each channel's existing custom object, leaving every other custom key untouched. Keys are dot-paths, so `a.b` sets key `b` inside object `a` (the parent object must already exist). Cannot be combined with `data.custom` custom_set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_set") ) data: "Optional[ChannelDataUpdate]" = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class ChannelBatchUpdateResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Count of channels selected for a completed synchronous database update, not an affected-row count. Concurrent deletion may reduce the rows written. Omitted when the count is 0, which happens for a synchronous hide where none of the member users exist. task_id is absent. success_channels_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="success_channels_count") ) # Present for asynchronous updates. Poll this task even if synchronous was requested: an older API node may have queued the update. task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) @dataclass class ChannelConfig(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) # List of commands that channel supports commands: List[str] = dc_field(metadata=dc_config(field_name="commands")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class ChannelConfigOverrides(DataClassJsonMixin): blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What a blocklist does when it matches. shadow_block is not accepted on a channel override. blocklist_behavior: "Optional[BlocklistBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) # Enable/disable message counting count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Overrides max message length max_message_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_message_length") ) # Overrides the push notification level for this channel push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # Enables message quotes quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) # Enables or disables reactions reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Enables message replies (threads) replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Enable/disable shared locations shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) # Enables or disables typing events typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Enables or disables file uploads uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # Enables or disables URL enrichment url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) # Enable/disable user message reminders user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # List of commands that channel supports commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class ChannelConfigWithInfo(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) commands: "List[Command]" = dc_field(metadata=dc_config(field_name="commands")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # How far ahead, in seconds, a message can be scheduled. Present only when scheduled messages are enabled for the app. A later scheduled_at returns error code 116 (scheduled_at_too_far), whose max_lead_time_seconds carries the same value scheduled_messages_max_lead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages_max_lead_time_seconds"), ) # Maximum number of scheduled messages (scheduled or sending) a user can have in this channel. Present only when scheduled messages are enabled for the app. Scheduling more returns error code 117 (scheduled_limit_channel) scheduled_messages_max_per_channel: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages_max_per_channel"), ) # Maximum number of scheduled messages (scheduled or sending) a user can have across all channels. Present only when scheduled messages are enabled for the app. Scheduling more returns error code 118 (scheduled_limit_user) scheduled_messages_max_per_user: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages_max_per_user") ) # Minimum time ahead, in seconds, a message is scheduled for. Present only when scheduled messages are enabled for the app. A future scheduled_at closer than this is moved later, to the first whole minute at least this far ahead; it is never rejected scheduled_messages_min_lead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages_min_lead_time_seconds"), ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class ChannelContextResponse(DataClassJsonMixin): # Channel CID (:) cid: str = dc_field(metadata=dc_config(field_name="cid")) # Channel ID id: str = dc_field(metadata=dc_config(field_name="id")) # Channel type type: str = dc_field(metadata=dc_config(field_name="type")) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class ChannelCreatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.created" in this case type: str = dc_field( default="channel.created", metadata=dc_config(field_name="type") ) # The ID of the channel which was created channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was created channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was created cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelDataUpdate(DataClassJsonMixin): auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) frozen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="frozen") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Channel configuration overrides config_overrides: "Optional[ChannelConfigOverrides]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ChannelDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.deleted" in this case type: str = dc_field( default="channel.deleted", metadata=dc_config(field_name="type") ) # The ID of the channel which was deleted channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was deleted channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was deleted cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelExport(DataClassJsonMixin): cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Channel ID id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Date to export messages since messages_since: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="messages_since", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date to export messages until messages_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="messages_until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Channel type type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) @dataclass class ChannelForkResponse(DataClassJsonMixin): # CID of the fork channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Number of messages copied into the fork, once completed. On a failed fork, the number of messages of its history, newest first, copied before the copy failed; the fork can hold a few more copied_message_count: int = dc_field( metadata=dc_config(field_name="copied_message_count") ) # Date/time of the fork created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # CID of the channel the fork was copied from source_channel_cid: str = dc_field( metadata=dc_config(field_name="source_channel_cid") ) # ID of the message of the source channel the fork was made at source_message_id: str = dc_field( metadata=dc_config(field_name="source_message_id") ) # `completed` once every message is copied. `backfilling` while a background task copies the history older than the newest page; the fork is usable meanwhile, and the newest messages, which an agent reads, are normally already there. The request reads at most 1,000 source messages: when those are mostly deleted, shadowed or replies shown in the channel, it copies fewer, at least the message the fork is made at, and the task copies the rest. `failed` when the copy failed for good (see `failed_reason`): nothing more is copied, the fork keeps what it holds and is usable, and it no longer counts toward the source's fork limit status: str = dc_field(metadata=dc_config(field_name="status")) # Maps the ID of each message the request copied, the newest page, to its ID in the fork; short when the request copied less than a page (see `status`). A fork message ID is a UUIDv5 of the fork CID and the source message ID; the fork message IDs endpoint maps any others message_id_map: "Dict[str, str]" = dc_field( metadata=dc_config(field_name="message_id_map") ) # Why the copy of a failed fork failed: `fork_message_id_taken` (the ID a message is copied under is held by another message; fork into another channel ID) or `message_too_large` (a source message is over a size limit of agent channels: its text, custom data or attachments) failed_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="failed_reason") ) # ID, in the source channel, of the oldest message a truncated fork copied. The fork holds no older source message; replies of the oldest copied messages may also have been left out oldest_source_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="oldest_source_message_id") ) # ID of the task copying the older history of a backfilling fork task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) # True, once completed, when the source held more than 10,000 messages up to the fork point: the fork holds the newest 10,000 of them truncated: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="truncated") ) @dataclass class ChannelForkSummary(DataClassJsonMixin): # CID of the fork channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Number of messages copied into the fork, once completed. On a failed fork, the number of messages of its history, newest first, copied before the copy failed; the fork can hold a few more copied_message_count: int = dc_field( metadata=dc_config(field_name="copied_message_count") ) # Date/time of the fork created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # CID of the channel the fork was copied from source_channel_cid: str = dc_field( metadata=dc_config(field_name="source_channel_cid") ) # ID of the message of the source channel the fork was made at source_message_id: str = dc_field( metadata=dc_config(field_name="source_message_id") ) # `completed` once every message is copied. `backfilling` while a background task copies the history older than the newest page; the fork is usable meanwhile, and the newest messages, which an agent reads, are normally already there. The request reads at most 1,000 source messages: when those are mostly deleted, shadowed or replies shown in the channel, it copies fewer, at least the message the fork is made at, and the task copies the rest. `failed` when the copy failed for good (see `failed_reason`): nothing more is copied, the fork keeps what it holds and is usable, and it no longer counts toward the source's fork limit status: str = dc_field(metadata=dc_config(field_name="status")) # Why the copy of a failed fork failed: `fork_message_id_taken` (the ID a message is copied under is held by another message; fork into another channel ID) or `message_too_large` (a source message is over a size limit of agent channels: its text, custom data or attachments) failed_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="failed_reason") ) # ID, in the source channel, of the oldest message a truncated fork copied. The fork holds no older source message; replies of the oldest copied messages may also have been left out oldest_source_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="oldest_source_message_id") ) # ID of the task copying the older history of a backfilling fork task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) # True, once completed, when the source held more than 10,000 messages up to the fork point: the fork holds the newest 10,000 of them truncated: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="truncated") ) @dataclass class ChannelForkedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # A fork of an agent channel fork: "ChannelForkSummary" = dc_field(metadata=dc_config(field_name="fork")) # The type of event: "channel.forked" in this case type: str = dc_field( default="channel.forked", metadata=dc_config(field_name="type") ) # The ID of the channel the event is sent on channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel the event is sent on channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel the event is sent on: the source, or the fork cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelFrozenEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.frozen" in this case type: str = dc_field( default="channel.frozen", metadata=dc_config(field_name="type") ) # The ID of the channel which was frozen channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The type of the channel which was frozen channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was frozen cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ChannelGetOrCreateRequest(DataClassJsonMixin): # Whether this channel will be hidden for the user who created the channel or not hide_for_creator: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hide_for_creator") ) # Adds scheduled_messages to the response: the acting user's own scheduled, sending and failed messages in this channel (server-side requests name the user with data.created_by_id or data.created_by; without one the field is omitted). Absent from the response when there are more than 100 or they could not be loaded; use the scheduled messages query then include_scheduled_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_scheduled_messages") ) # Refresh channel state state: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="state") ) thread_unread_counts: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="thread_unread_counts") ) # Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each) member_custom_include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_custom_include") ) data: "Optional[ChannelInput]" = dc_field( default=None, metadata=dc_config(field_name="data") ) members: "Optional[PaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="members") ) messages: "Optional[MessagePaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="messages") ) watchers: "Optional[PaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) @dataclass class ChannelHiddenEvent(DataClassJsonMixin): # Whether the history was cleared clear_history: bool = dc_field(metadata=dc_config(field_name="clear_history")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.hidden" in this case type: str = dc_field( default="channel.hidden", metadata=dc_config(field_name="type") ) # The ID of the channel which was hidden channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was hidden channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was hidden cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelInput(DataClassJsonMixin): # Enable or disable auto translation auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) # Language (or comma-separated list of languages) to translate to when auto translation is active auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) # Freeze or unfreeze the channel frozen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="frozen") ) # Team the channel belongs to (if multi-tenant mode is enabled) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) truncated_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="truncated_by_id") ) filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) invites: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="invites") ) members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Channel configuration overrides config_overrides: "Optional[ChannelConfigOverrides]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) # User request object created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ChannelInputRequest(DataClassJsonMixin): auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) frozen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="frozen") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) invites: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="invites") ) members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Channel configuration overrides config_overrides: "Optional[ConfigOverridesRequest]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) # User request object created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ChannelMemberPartialResponse(DataClassJsonMixin): # Role of the member in the channel channel_role: str = dc_field(metadata=dc_config(field_name="channel_role")) # Whether the user muted notifications for this channel notifications_muted: bool = dc_field( metadata=dc_config(field_name="notifications_muted") ) # Channel-member custom fields projected via `member_custom_include` custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ChannelMemberRequest(DataClassJsonMixin): # Role of the member in the channel channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) user: "Optional[MemberUserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelMemberResponse(DataClassJsonMixin): # Whether member is banned this channel or not banned: bool = dc_field(metadata=dc_config(field_name="banned")) # Role of the member in the channel channel_role: str = dc_field(metadata=dc_config(field_name="channel_role")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) notifications_muted: bool = dc_field( metadata=dc_config(field_name="notifications_muted") ) # Whether member is shadow banned in this channel or not shadow_banned: bool = dc_field(metadata=dc_config(field_name="shadow_banned")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) archived_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="archived_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Expiration date of the ban ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether the member's ban also applies to channels the channel's creator will create in the future (an active future channel ban by the creator targets this member) ban_from_future_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ban_from_future_channels") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Expiration date of the future channel ban; absent when the future channel ban is permanent future_channel_ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="future_channel_ban_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date when invite was accepted invite_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_accepted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date when invite was rejected invite_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_rejected_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether member was invited or not invited: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invited") ) # Whether member is channel moderator or not is_moderator: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_moderator") ) pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Permission level of the member in the channel (DEPRECATED: use channel_role instead). One of: member, moderator, admin, owner role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) status: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="status") ) deleted_messages: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="deleted_messages") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelMessageCountRuleParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) @dataclass class ChannelMessagesResponse(DataClassJsonMixin): # List of messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) @dataclass class ChannelMetadata(DataClassJsonMixin): cid: str = dc_field(metadata=dc_config(field_name="cid")) id: str = dc_field(metadata=dc_config(field_name="id")) type: str = dc_field(metadata=dc_config(field_name="type")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_count") ) message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="message_count") ) # How much a channel notifies its members. push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) ChannelModerationBehaviorType = NewType("ChannelModerationBehaviorType", str) class ChannelModerationBehavior: BLOCK: Final[ChannelModerationBehaviorType] = "block" FLAG: Final[ChannelModerationBehaviorType] = "flag" SHADOW_BLOCK: Final[ChannelModerationBehaviorType] = "shadow_block" @dataclass class ChannelMute(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Date/time of mute expiration expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelMutedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.muted" in this case type: str = dc_field(default="channel.muted", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The mute objects mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="mutes") ) mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="mute") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) ChannelOwnCapabilityType = NewType("ChannelOwnCapabilityType", str) class ChannelOwnCapability: BAN_CHANNEL_MEMBERS: Final[ChannelOwnCapabilityType] = "ban-channel-members" CAST_POLL_VOTE: Final[ChannelOwnCapabilityType] = "cast-poll-vote" CONNECT_EVENTS: Final[ChannelOwnCapabilityType] = "connect-events" CREATE_ATTACHMENT: Final[ChannelOwnCapabilityType] = "create-attachment" CREATE_MENTION: Final[ChannelOwnCapabilityType] = "create-mention" DELETE_ANY_MESSAGE: Final[ChannelOwnCapabilityType] = "delete-any-message" DELETE_CHANNEL: Final[ChannelOwnCapabilityType] = "delete-channel" DELETE_OWN_MESSAGE: Final[ChannelOwnCapabilityType] = "delete-own-message" DELIVERY_EVENTS: Final[ChannelOwnCapabilityType] = "delivery-events" FLAG_MESSAGE: Final[ChannelOwnCapabilityType] = "flag-message" FREEZE_CHANNEL: Final[ChannelOwnCapabilityType] = "freeze-channel" JOIN_CHANNEL: Final[ChannelOwnCapabilityType] = "join-channel" LEAVE_CHANNEL: Final[ChannelOwnCapabilityType] = "leave-channel" MUTE_CHANNEL: Final[ChannelOwnCapabilityType] = "mute-channel" NOTIFY_CHANNEL: Final[ChannelOwnCapabilityType] = "notify-channel" NOTIFY_GROUP: Final[ChannelOwnCapabilityType] = "notify-group" NOTIFY_HERE: Final[ChannelOwnCapabilityType] = "notify-here" NOTIFY_ROLE: Final[ChannelOwnCapabilityType] = "notify-role" PIN_MESSAGE: Final[ChannelOwnCapabilityType] = "pin-message" QUERY_POLL_VOTES: Final[ChannelOwnCapabilityType] = "query-poll-votes" QUOTE_MESSAGE: Final[ChannelOwnCapabilityType] = "quote-message" READ_EVENTS: Final[ChannelOwnCapabilityType] = "read-events" SCHEDULE_MESSAGE: Final[ChannelOwnCapabilityType] = "schedule-message" SEARCH_MESSAGES: Final[ChannelOwnCapabilityType] = "search-messages" SEND_CUSTOM_EVENTS: Final[ChannelOwnCapabilityType] = "send-custom-events" SEND_LINKS: Final[ChannelOwnCapabilityType] = "send-links" SEND_MESSAGE: Final[ChannelOwnCapabilityType] = "send-message" SEND_POLL: Final[ChannelOwnCapabilityType] = "send-poll" SEND_REACTION: Final[ChannelOwnCapabilityType] = "send-reaction" SEND_REPLY: Final[ChannelOwnCapabilityType] = "send-reply" SEND_RESTRICTED_VISIBILITY_MESSAGE: Final[ChannelOwnCapabilityType] = ( "send-restricted-visibility-message" ) SEND_TYPING_EVENTS: Final[ChannelOwnCapabilityType] = "send-typing-events" SET_CHANNEL_COOLDOWN: Final[ChannelOwnCapabilityType] = "set-channel-cooldown" SHARE_LOCATION: Final[ChannelOwnCapabilityType] = "share-location" SKIP_SLOW_MODE: Final[ChannelOwnCapabilityType] = "skip-slow-mode" SLOW_MODE: Final[ChannelOwnCapabilityType] = "slow-mode" TYPING_EVENTS: Final[ChannelOwnCapabilityType] = "typing-events" UPDATE_ANY_MESSAGE: Final[ChannelOwnCapabilityType] = "update-any-message" UPDATE_CHANNEL: Final[ChannelOwnCapabilityType] = "update-channel" UPDATE_CHANNEL_MEMBERS: Final[ChannelOwnCapabilityType] = "update-channel-members" UPDATE_OWN_MESSAGE: Final[ChannelOwnCapabilityType] = "update-own-message" UPDATE_THREAD: Final[ChannelOwnCapabilityType] = "update-thread" UPLOAD_FILE: Final[ChannelOwnCapabilityType] = "upload-file" @dataclass class ChannelPushPreferencesResponse(DataClassJsonMixin): # The scope level of the push notifications. chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) # If provided the notifications will be disabled until the set date. disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) chat_preferences: "Optional[ChatPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class ChannelResponse(DataClassJsonMixin): # Channel CID (:) cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) disabled: bool = dc_field(metadata=dc_config(field_name="disabled")) # Whether channel is frozen or not frozen: bool = dc_field(metadata=dc_config(field_name="frozen")) # Channel unique ID id: str = dc_field(metadata=dc_config(field_name="id")) # Type of the channel type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Number of members who are not deactivated or deleted active_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="active_member_count") ) # Whether auto translation is enabled or not auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) # Language (or comma-separated list of languages) to translate to when auto translation is active auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) # Whether this channel is blocked by current user or not blocked: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="blocked") ) # Cooldown period after sending each message cooldown: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown") ) # Date/time of deletion deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether this channel is hidden by current user or not hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hidden") ) # Date since when the message history is accessible hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date of the last message sent last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Number of members in the channel member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_count") ) # Number of messages in the channel message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="message_count") ) # Date of mute expiration mute_expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="mute_expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether this channel is muted or not muted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="muted") ) # Team the channel belongs to (multi-tenant only) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Date of the latest truncation of the channel truncated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="truncated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # List of filter tags associated with the channel filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # List of channel members (max 100) members: "Optional[List[ChannelMemberResponse]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # List of channel capabilities of authenticated user own_capabilities: "Optional[List[ChannelOwnCapability]]" = dc_field( default=None, metadata=dc_config(field_name="own_capabilities") ) config: "Optional[ChannelConfigWithInfo]" = dc_field( default=None, metadata=dc_config(field_name="config") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) # A fork of an agent channel fork: "Optional[ChannelForkSummary]" = dc_field( default=None, metadata=dc_config(field_name="fork") ) # User response object truncated_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="truncated_by") ) @dataclass class ChannelRewindResponse(DataClassJsonMixin): # Date/time of the rewind created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of messages the rewind hid that were not hidden already hidden_count_at_rewind: int = dc_field( metadata=dc_config(field_name="hidden_count_at_rewind") ) # ID of the rewind id: str = dc_field(metadata=dc_config(field_name="id")) # Whether `message_id` was hidden too inclusive: bool = dc_field(metadata=dc_config(field_name="inclusive")) # ID of the message the channel was rewound to message_id: str = dc_field(metadata=dc_config(field_name="message_id")) @dataclass class ChannelRewoundEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # A rewind of an agent channel rewind: "ChannelRewindResponse" = dc_field(metadata=dc_config(field_name="rewind")) # The type of event: "channel.rewound" in this case type: str = dc_field( default="channel.rewound", metadata=dc_config(field_name="type") ) # The ID of the channel which was rewound channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was rewound channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was rewound cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelStateResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of channel members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # List of channel messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # List of pinned messages in the channel pinned_messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="pinned_messages") ) threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) # Milliseconds until the current user's slow mode cool down period ends. Only set on client-side get or create channel and get channel requests while the user is under cool down cooldown_remaining_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_remaining_ms") ) # Whether this channel is hidden or not hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hidden") ) # Messages before this date are hidden from the user hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Number of channel watchers watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) # Active live locations in the channel active_live_locations: "Optional[List[SharedLocationResponseData]]" = dc_field( default=None, metadata=dc_config(field_name="active_live_locations") ) # Pending messages that this user has sent pending_messages: "Optional[List[PendingMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="pending_messages") ) # List of read states read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) # The caller's own scheduled, sending and failed messages in this channel. Set only by a client-side GetOrCreateChannel or QueryChannels with include_scheduled_messages; absent when not requested or not known, in which case use the scheduled messages query scheduled_messages: "Optional[List[ScheduledMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages") ) # List of user who is watching the channel watchers: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) membership: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership") ) # The push preference details. push_preferences: "Optional[ChannelPushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) @dataclass class ChannelStateResponseFields(DataClassJsonMixin): # List of channel members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # List of channel messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # List of pinned messages in the channel pinned_messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="pinned_messages") ) threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) # Milliseconds until the current user's slow mode cool down period ends. Only set on client-side get or create channel and get channel requests while the user is under cool down cooldown_remaining_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_remaining_ms") ) # Whether this channel is hidden or not hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hidden") ) # Messages before this date are hidden from the user hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Number of channel watchers watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) # Active live locations in the channel active_live_locations: "Optional[List[SharedLocationResponseData]]" = dc_field( default=None, metadata=dc_config(field_name="active_live_locations") ) # Pending messages that this user has sent pending_messages: "Optional[List[PendingMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="pending_messages") ) # List of read states read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) # The caller's own scheduled, sending and failed messages in this channel. Set only by a client-side GetOrCreateChannel or QueryChannels with include_scheduled_messages; absent when not requested or not known, in which case use the scheduled messages query scheduled_messages: "Optional[List[ScheduledMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages") ) # List of user who is watching the channel watchers: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) membership: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership") ) # The push preference details. push_preferences: "Optional[ChannelPushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) @dataclass class ChannelTruncatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.truncated" in this case type: str = dc_field( default="channel.truncated", metadata=dc_config(field_name="type") ) # The ID of the channel which was truncated channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was truncated channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was truncated cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelTypeConfig(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) commands: "List[Command]" = dc_field(metadata=dc_config(field_name="commands")) permissions: "List[PolicyRequest]" = dc_field( metadata=dc_config(field_name="permissions") ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class ChannelTypeRuleResponse(DataClassJsonMixin): channel_type: str = dc_field(metadata=dc_config(field_name="channel_type")) enabled_at: datetime = dc_field( metadata=dc_config( field_name="enabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) max_age_hours: int = dc_field(metadata=dc_config(field_name="max_age_hours")) @dataclass class ChannelUnFrozenEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.unfrozen" in this case type: str = dc_field( default="channel.unfrozen", metadata=dc_config(field_name="type") ) # The ID of the channel which was unfrozen channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The type of the channel which was unfrozen channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was unfrozen cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ChannelUnmutedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.unmuted" in this case type: str = dc_field( default="channel.unmuted", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The mute objects mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="mutes") ) mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="mute") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.updated" in this case type: str = dc_field( default="channel.updated", metadata=dc_config(field_name="type") ) # The ID of the channel which was updated channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was updated channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was updated cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelVisibleEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "channel.visible" in this case type: str = dc_field( default="channel.visible", metadata=dc_config(field_name="type") ) # The ID of the channel which was shown channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was shown channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was shown cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChatActivityStatsResponse(DataClassJsonMixin): messages: "Optional[MessageStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="Messages") ) @dataclass class ChatDraftPayloadResponse(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) text: str = dc_field(metadata=dc_config(field_name="text")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) mentioned_users: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) @dataclass class ChatDraftResponse(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message: "ChatDraftPayloadResponse" = dc_field( metadata=dc_config(field_name="message") ) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) parent_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) quoted_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) @dataclass class ChatMessageResponse(DataClassJsonMixin): cid: str = dc_field(metadata=dc_config(field_name="cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_reply_count: int = dc_field( metadata=dc_config(field_name="deleted_reply_count") ) html: str = dc_field(metadata=dc_config(field_name="html")) id: str = dc_field(metadata=dc_config(field_name="id")) mentioned_channel: bool = dc_field( metadata=dc_config(field_name="mentioned_channel") ) mentioned_here: bool = dc_field(metadata=dc_config(field_name="mentioned_here")) pinned: bool = dc_field(metadata=dc_config(field_name="pinned")) reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) shadowed: bool = dc_field(metadata=dc_config(field_name="shadowed")) silent: bool = dc_field(metadata=dc_config(field_name="silent")) text: str = dc_field(metadata=dc_config(field_name="text")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) latest_reactions: "List[ChatReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) own_reactions: "List[ChatReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) restricted_visibility: List[str] = dc_field( metadata=dc_config(field_name="restricted_visibility") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction_counts: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_counts") ) reaction_scores: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_scores") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) draft: "Optional[ChatDraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) moderation: "Optional[ChatModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) quoted_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) reaction_groups: "Optional[Dict[str, Optional[ChatReactionGroupResponse]]]" = ( dc_field(default=None, metadata=dc_config(field_name="reaction_groups")) ) reminder: "Optional[ChatReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) shared_location: "Optional[ChatSharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class ChatModerationV2Response(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) original_text: str = dc_field(metadata=dc_config(field_name="original_text")) blocklist_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_matched") ) platform_circumvented: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="platform_circumvented") ) semantic_filter_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_matched") ) blocklists_matched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklists_matched") ) image_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_harms") ) text_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_harms") ) @dataclass class ChatPreferences(DataClassJsonMixin): channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) distinct_channel_messages: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="distinct_channel_messages") ) group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @dataclass class ChatPreferencesInput(DataClassJsonMixin): channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @dataclass class ChatPreferencesResponse(DataClassJsonMixin): channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @dataclass class ChatReactionGroupResponse(DataClassJsonMixin): count: int = dc_field(metadata=dc_config(field_name="count")) first_reaction_at: datetime = dc_field( metadata=dc_config( field_name="first_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) last_reaction_at: datetime = dc_field( metadata=dc_config( field_name="last_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) sum_scores: int = dc_field(metadata=dc_config(field_name="sum_scores")) latest_reactions_by: "List[ChatReactionGroupUserResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions_by") ) @dataclass class ChatReactionGroupUserResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChatReactionResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) score: int = dc_field(metadata=dc_config(field_name="score")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class ChatReminderResponseData(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) remind_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="remind_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChatSharedLocationResponseData(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by_device_id: str = dc_field( metadata=dc_config(field_name="created_by_device_id") ) latitude: float = dc_field(metadata=dc_config(field_name="latitude")) longitude: float = dc_field(metadata=dc_config(field_name="longitude")) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class CheckExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) file_url: str = dc_field(metadata=dc_config(field_name="file_url")) @dataclass class CheckGCPPubSubRequest(DataClassJsonMixin): # Publish the test message with an ordering key through the regional endpoint, as a hook with ordering enabled would; requires gcp_pubsub_region gcp_pubsub_event_based_ordering_key_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_event_based_ordering_key_enabled"), ) # GCP region used for the regional Pub/Sub endpoint when ordering is enabled gcp_pubsub_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_region") ) # Fully qualified GCP Pub/Sub topic name (projects/{project}/topics/{topic}) gcp_pubsub_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_topic") ) @dataclass class CheckGCPPubSubResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Validation result. One of: ok, error status: str = dc_field(metadata=dc_config(field_name="status")) # Error text error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) # Error data data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class CheckPushRequest(DataClassJsonMixin): # Push message template for APN apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_template") ) # Type of event for push templates (default: message.new). One of: message.new, message.updated, reaction.new, reaction.updated, notification.reminder_due, feeds.activity.added, feeds.comment.added, feeds.activity.reaction.added, feeds.comment.reaction.added, feeds.follow.created, feeds.notification_feed.updated event_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="event_type") ) # Push message data template for Firebase firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) # Push message template for Firebase firebase_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_template") ) # Message ID to send push notification for message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) # Name of push provider push_provider_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="push_provider_name") ) # Push provider type. One of: firebase, apn, huawei, xiaomi push_provider_type: "Optional[PushProviderName]" = dc_field( default=None, metadata=dc_config(field_name="push_provider_type") ) # Don't require existing devices to render templates skip_devices: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_devices") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CheckPushResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The event type that was tested event_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="event_type") ) rendered_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="rendered_apn_template") ) rendered_firebase_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="rendered_firebase_template") ) # Don't require existing devices to render templates skip_devices: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_devices") ) # List of general errors general_errors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="general_errors") ) # Object with device errors device_errors: "Optional[Dict[str, DeviceErrorInfo]]" = dc_field( default=None, metadata=dc_config(field_name="device_errors") ) rendered_message: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="rendered_message") ) @dataclass class CheckRequest(DataClassJsonMixin): # ID of the user who created the entity entity_creator_id: str = dc_field( metadata=dc_config(field_name="entity_creator_id") ) # Unique identifier of the entity to moderate entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity to moderate entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # Key of the moderation configuration to use config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) # Original timestamp when the content was produced (for correlating flagged content with source video timeline) content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ISO 3166-1 alpha-2 country the content is aimed at (e.g. US, DE). Ignored when country_codes is set, but an invalid value is still rejected with 400. # Deprecated country_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_code") ) # Whether to run moderation in test mode test_mode: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="test_mode") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # ISO 3166-1 alpha-2 countries the content is aimed at (e.g. US, DE), up to 300. The first is the primary country. Every country is sent to the AI text and image harm detection engines as country context. Takes precedence over country_code. country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) config: "Optional[ModerationConfig]" = dc_field( default=None, metadata=dc_config(field_name="config") ) moderation_payload: "Optional[ModerationPayload]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # Additional moderation configuration options options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CheckResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Suggested action based on moderation results recommended_action: str = dc_field( metadata=dc_config(field_name="recommended_action") ) # Status of the moderation check (completed or pending) status: str = dc_field(metadata=dc_config(field_name="status")) # ID of the LLM model that produced the verdict (e.g. gpt-4o-mini). Omitted when no LLM ran synchronously (e.g. Bodyguard-only checks or async moderation) llm_model: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="llm_model") ) # reasoning_effort sent with the LLM request that produced the verdict. Omitted when the request did not send one llm_reasoning_effort: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="llm_reasoning_effort") ) # ID of the running moderation task task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) # Score (0-100) of each policy intent topic against this request's text, in policy order (test mode only; omitted when the policy has no topics or scoring failed) intent_scores: "Optional[List[IntentScoreResponse]]" = dc_field( default=None, metadata=dc_config(field_name="intent_scores") ) # All moderation rules triggered by this check (content, user, and call rules), with their resolved actions triggered_rules: "Optional[List[TriggeredRuleResponse]]" = dc_field( default=None, metadata=dc_config(field_name="triggered_rules") ) item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) # Deprecated triggered_rule: "Optional[TriggeredRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="triggered_rule") ) @dataclass class CheckS3AccessRequest(DataClassJsonMixin): # Optional stream+s3:// reference to test access against s3_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_url") ) @dataclass class CheckS3AccessResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Whether the S3 access check succeeded success: bool = dc_field(metadata=dc_config(field_name="success")) # Descriptive message about the check result message: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class CheckSNSRequest(DataClassJsonMixin): # AWS SNS access key sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) # AWS SNS key secret sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) # AWS SNS topic ARN sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) @dataclass class CheckSNSResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Validation result. One of: ok, error status: str = dc_field(metadata=dc_config(field_name="status")) # Error text error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) # Error data data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class CheckSQSRequest(DataClassJsonMixin): # AWS SQS access key sqs_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_key") ) # AWS SQS key secret sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) # AWS SQS endpoint URL sqs_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_url") ) @dataclass class CheckSQSResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Validation result. One of: ok, error status: str = dc_field(metadata=dc_config(field_name="status")) # Error text error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) # Error data data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class ClaimGuestUserRequest(DataClassJsonMixin): # ID of the guest user to claim guest_user_id: str = dc_field(metadata=dc_config(field_name="guest_user_id")) # ID of the regular user that claims the guest and receives its channels, messages and reactions user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class ClaimGuestUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # ID of the task that moves the guest's channels, messages and reactions to the claiming user task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class Classification(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) matched_contributors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="matched_contributors") ) subclassifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="subclassifications") ) @dataclass class ClientEvent(DataClassJsonMixin): # Call session ID associated with the attempt. Required on every event except CoordinatorJoin initiation and CoordinatorJoin failure (where the call session is not yet established); optional on MediaDevicePermission. call_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_session_id") ) # Camera permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event. camera_permission_status: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="camera_permission_status") ) # UUID generated by the client and shared across every event of the same coordinator connection. Required on every event except JoinInitiated, which is reported before a coordinator connection exists. coordinator_connect_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="coordinator_connect_id") ) # Milliseconds elapsed between the stage attempt's initiation and this event. elapsed_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="elapsed_time") ) # Whether the event marks the start (initiated) or resolution (completed) of a stage attempt, or another event-specific value event_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="event_type") ) # Terminal state of the peer connection. Required on PeerConnectionConnect failure. ice_state: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ice_state") ) # Call ID associated with the event. Required on every stage except CoordinatorWS, where it is optional. id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # UUID generated by the client and shared across JoinInitiated and the join-lifecycle events (CoordinatorJoin, WSJoin, PeerConnectionConnect) of the same overall join attempt. Required on every join event except CoordinatorWS, which is reported before a join attempt is established. join_attempt_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="join_attempt_id") ) # Reason the client initiated the join. Optional on CoordinatorJoin events; empty when not provided. join_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="join_reason") ) # Source of the leave that aborted a join: user, app, callkit, remote_event, sdk_error, or unknown. Not validated against this set, so SDKs may report new values. Optional; sent on failure events. Maximum 32 characters. leave_initiator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="leave_initiator") ) # Internal reason or triggering event for the leave that aborted a join. Optional; sent on failure events. Maximum 200 characters. leave_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="leave_reason") ) # Microphone permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Required on every MediaDevicePermission event. microphone_permission_status: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="microphone_permission_status") ) # Resolution of a completed event: success or failure. Required on completed join events; forbidden on initiated join events. outcome: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="outcome") ) # Which peer connection a PeerConnectionConnect event reports on: publish or subscribe. Required on every PeerConnectionConnect event. peer_connection: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="peer_connection") ) # UTC timestamp at which the ICE connection was established earlier in the session, when applicable previously_connected_timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="previously_connected_timestamp", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Total in-stage retries the client made before resolving (0–1000). Required on completed join events. retry_count_attempt: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="retry_count_attempt") ) # Failure code string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure. retry_failure_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="retry_failure_code") ) # Failure reason string. Required on CoordinatorJoin, CoordinatorWS, WSJoin, and PeerConnectionConnect failure. retry_failure_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="retry_failure_reason") ) # Screen-share permission status: INITIATED, FAILED, GRANTED, or NOT_INITIATED. Optional on MediaDevicePermission events. screen_share_status: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="screen_share_status") ) # Version of the client SDK sdk_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sdk_version") ) # Identifier of the SFU the client was attempting to connect to. Required on WSJoin and PeerConnectionConnect failure, and on FirstAudioFrame and FirstVideoFrame. sfu_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sfu_id") ) # Source of the coordinator join. Optional on CoordinatorJoin events; omitted when not provided. source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="source") ) # Discriminator identifying the event kind. JoinInitiated marks the start of a join attempt; join-lifecycle events use CoordinatorJoin, CoordinatorWS, WSJoin, or PeerConnectionConnect; media-readiness events use FirstAudioFrame or FirstVideoFrame; MediaDevicePermission reports device permission results; other values denote generic client events. stage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stage") ) # UUID generated by the client at initiation. Identical on the matching completion event. Absent on JoinInitiated. stage_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stage_id") ) # UTC timestamp at which the event was recorded timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="timestamp", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Identifier of the media track the frame belongs to. Required on FirstVideoFrame; optional on FirstAudioFrame. track_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="track_id") ) # Call type associated with the event. Required on every stage except CoordinatorWS, where it is optional. type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # User agent string of the client SDK user_agent: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_agent") ) # ID of the user the event was recorded for user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Whether the ICE connection had been established earlier in the same session. Required on every PeerConnectionConnect event so reconnects can be distinguished from fresh connects. was_previously_connected: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="was_previously_connected") ) @dataclass class ClientOSDataResponse(DataClassJsonMixin): architecture: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="architecture") ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @dataclass class ClosedCaptionEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # CallClosedCaption represents a closed caption of a call. closed_caption: "CallClosedCaption" = dc_field( metadata=dc_config(field_name="closed_caption") ) # The type of event: "call.closed_caption" in this case type: str = dc_field( default="call.closed_caption", metadata=dc_config(field_name="type") ) @dataclass class ClosedCaptionRuleParameters(DataClassJsonMixin): severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) llm_harm_labels: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="llm_harm_labels") ) @dataclass class CollectUserFeedbackRequest(DataClassJsonMixin): rating: int = dc_field(metadata=dc_config(field_name="rating")) sdk: str = dc_field(metadata=dc_config(field_name="sdk")) sdk_version: str = dc_field(metadata=dc_config(field_name="sdk_version")) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) user_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_session_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CollectUserFeedbackResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class CollectionRequest(DataClassJsonMixin): # Name/type of the collection name: str = dc_field(metadata=dc_config(field_name="name")) # Custom data for the collection (required, must contain at least one key) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Unique identifier for the collection within its name (optional, will be auto-generated if not provided) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of the user who owns this collection user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @dataclass class CollectionResponse(DataClassJsonMixin): # Unique identifier for the collection within its name id: str = dc_field(metadata=dc_config(field_name="id")) # Name/type of the collection name: str = dc_field(metadata=dc_config(field_name="name")) # When the collection was created created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the collection was last updated updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ID of the user who owns this collection user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the collection custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) CollectionStatusType = NewType("CollectionStatusType", str) class CollectionStatus: NOTFOUND: Final[CollectionStatusType] = "notfound" OK: Final[CollectionStatusType] = "ok" @dataclass class Command(DataClassJsonMixin): # Arguments help text, shown in commands auto-completion args: str = dc_field(metadata=dc_config(field_name="args")) # Description, shown in commands auto-completion description: str = dc_field(metadata=dc_config(field_name="description")) # Unique command name name: str = dc_field(metadata=dc_config(field_name="name")) # Set name used for grouping commands set: str = dc_field(metadata=dc_config(field_name="set")) # Date/time of creation created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date/time of the last update updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CommentAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.comment.added" in this case type: str = dc_field( default="feeds.comment.added", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.comment.deleted" in this case type: str = dc_field( default="feeds.comment.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentFeedbackEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) comment_feedback: "CommentFeedbackEventPayload" = dc_field( metadata=dc_config(field_name="comment_feedback") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.comment.feedback" in this case type: str = dc_field( default="feeds.comment.feedback", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentFeedbackEventPayload(DataClassJsonMixin): # The comment that received feedback comment_id: str = dc_field(metadata=dc_config(field_name="comment_id")) # When the feedback was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Whether the comment is hidden for the user hide: bool = dc_field(metadata=dc_config(field_name="hide")) # When the feedback was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class CommentFeedbackRequest(DataClassJsonMixin): # Whether to hide this comment for the user hide: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="hide")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentFeedbackResponse(DataClassJsonMixin): # The ID of the comment that received feedback comment_id: str = dc_field(metadata=dc_config(field_name="comment_id")) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Whether the comment is hidden for the user hide: bool = dc_field(metadata=dc_config(field_name="hide")) @dataclass class CommentReactionAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of event: "feeds.comment.reaction.added" in this case type: str = dc_field( default="feeds.comment.reaction.added", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentReactionDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of reaction that was removed type: str = dc_field( default="feeds.comment.reaction.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CommentReactionUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) # The type of event: "feeds.comment.reaction.updated" in this case type: str = dc_field( default="feeds.comment.reaction.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CommentResponse(DataClassJsonMixin): bookmark_count: int = dc_field(metadata=dc_config(field_name="bookmark_count")) # Confidence score of the comment confidence_score: float = dc_field( metadata=dc_config(field_name="confidence_score") ) # When the comment was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of downvotes for this comment downvote_count: int = dc_field(metadata=dc_config(field_name="downvote_count")) # Only true in QueryComments results filtered with hidden: true hidden: bool = dc_field(metadata=dc_config(field_name="hidden")) # Unique identifier for the comment id: str = dc_field(metadata=dc_config(field_name="id")) # ID of the object this comment is associated with object_id: str = dc_field(metadata=dc_config(field_name="object_id")) # Type of the object this comment is associated with object_type: str = dc_field(metadata=dc_config(field_name="object_type")) # Number of reactions to this comment reaction_count: int = dc_field(metadata=dc_config(field_name="reaction_count")) # Number of replies to this comment reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) # Score of the comment based on reactions score: int = dc_field(metadata=dc_config(field_name="score")) # Status of the comment. One of: active, deleted, removed, hidden status: "CommentStatus" = dc_field(metadata=dc_config(field_name="status")) # When the comment was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of upvotes for this comment upvote_count: int = dc_field(metadata=dc_config(field_name="upvote_count")) # Users mentioned in the comment mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) # Current user's reactions to this activity own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Controversy score of the comment controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) # When the comment was deleted deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the comment was last edited edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ID of parent comment for nested replies parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Text content of the comment text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Attachments associated with the comment attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Recent reactions to the comment latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) # Custom data for the comment custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # Grouped reactions by type reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @dataclass class CommentRestoredEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.comment.restored" in this case type: str = dc_field( default="feeds.comment.restored", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) CommentStatusType = NewType("CommentStatusType", str) class CommentStatus: ACTIVE: Final[CommentStatusType] = "active" DELETED: Final[CommentStatusType] = "deleted" HIDDEN: Final[CommentStatusType] = "hidden" REMOVED: Final[CommentStatusType] = "removed" SHADOW_BLOCKED: Final[CommentStatusType] = "shadow_blocked" @dataclass class CommentUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.comment.updated" in this case type: str = dc_field( default="feeds.comment.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CompositeRecordingResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) @dataclass class ConcurrencyMinute(DataClassJsonMixin): joins: int = dc_field(metadata=dc_config(field_name="joins")) leaves: int = dc_field(metadata=dc_config(field_name="leaves")) max: int = dc_field(metadata=dc_config(field_name="max")) min: int = dc_field(metadata=dc_config(field_name="min")) minute: str = dc_field(metadata=dc_config(field_name="minute")) @dataclass class ConfigOverridesRequest(DataClassJsonMixin): # Blocklist name blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # Blocklist behavior. One of: flag, block blocklist_behavior: "Optional[BlocklistBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) # Enable/disable message counting count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Maximum message length max_message_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_message_length") ) # Overrides the push notification level for this channel push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # Enable/disable quotes quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) # Enable/disable reactions reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Enable/disable replies replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Enable/disable shared locations shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) # Enable/disable typing events typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Enable/disable uploads uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # Enable/disable URL enrichment url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) # Enable/disable user message reminders user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # List of available commands commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) # Permission grants modifiers grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class ConfigResponse(DataClassJsonMixin): # Whether moderation should be performed asynchronously _async: bool = dc_field(metadata=dc_config(field_name="async")) # When the configuration was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for the moderation configuration key: str = dc_field(metadata=dc_config(field_name="key")) # Team associated with the configuration team: str = dc_field(metadata=dc_config(field_name="team")) # When the configuration was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) supported_video_call_harm_types: List[str] = dc_field( metadata=dc_config(field_name="supported_video_call_harm_types") ) # Configurable image moderation label definitions for dashboard rendering ai_image_label_definitions: "Optional[List[AIImageLabelDefinition]]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_label_definitions") ) # Names of Bodyguard credential profiles registered on this app. The dashboard uses this list to render the profile picker on the AI Text section. available_bodyguard_profiles: "Optional[List[BodyguardProfileSummary]]" = dc_field( default=None, metadata=dc_config(field_name="available_bodyguard_profiles") ) ai_audio_config: "Optional[AIAudioConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="ai_audio_config") ) ai_image_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_config") ) # Available L2 subclassifications per L1 image moderation label, based on the active provider ai_image_subclassifications: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_subclassifications") ) ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) ai_video_config: "Optional[AIVideoConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( dc_field( default=None, metadata=dc_config(field_name="automod_semantic_filters_config"), ) ) automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) engine: "Optional[ModerationEngineConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="engine") ) flood_config: "Optional[FloodConfig]" = dc_field( default=None, metadata=dc_config(field_name="flood_config") ) intent_config: "Optional[IntentConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="intent_config") ) llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @dataclass class ContentCountRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class ContentCountryCodeParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) @dataclass class ContentCustomPropertyCountParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class ContentCustomPropertyParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @dataclass class CoordinatesResponse(DataClassJsonMixin): # Latitude coordinate latitude: float = dc_field(metadata=dc_config(field_name="latitude")) # Longitude coordinate longitude: float = dc_field(metadata=dc_config(field_name="longitude")) @dataclass class CountByMinuteResponse(DataClassJsonMixin): count: int = dc_field(metadata=dc_config(field_name="count")) start_ts: datetime = dc_field( metadata=dc_config( field_name="start_ts", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) @dataclass class Coverage(DataClassJsonMixin): publisher_encoding_profiles: int = dc_field( metadata=dc_config(field_name="publisher_encoding_profiles") ) absent: "List[AbsentMetric]" = dc_field(metadata=dc_config(field_name="absent")) metrics_pct: "MetricsPct" = dc_field(metadata=dc_config(field_name="metrics_pct")) @dataclass class CreateBlockListRequest(DataClassJsonMixin): # Block list name name: str = dc_field(metadata=dc_config(field_name="name")) # List of words to block words: List[str] = dc_field(metadata=dc_config(field_name="words")) is_confusable_folding_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_confusable_folding_enabled") ) is_leet_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_leet_check_enabled") ) is_plural_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_plural_check_enabled") ) is_substring_matching_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_substring_matching_enabled") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word, word_allowlist type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateBlockListResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Block list contains restricted words blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @dataclass class CreateCallTypeRequest(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) # the external storage for the call type external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) # the permissions granted to each role grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) notification_settings: "Optional[NotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) settings: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @dataclass class CreateCallTypeResponse(DataClassJsonMixin): # the time the call type was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # the name of the call type name: str = dc_field(metadata=dc_config(field_name="name")) # the time the call type was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the permissions granted to each role grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) notification_settings: "NotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="notification_settings") ) settings: "CallSettingsResponse" = dc_field( metadata=dc_config(field_name="settings") ) # the external storage for the call type external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @dataclass class CreateCampaignRequest(DataClassJsonMixin): # The user ID of the sender sender_id: str = dc_field(metadata=dc_config(field_name="sender_id")) message_template: "CampaignMessageTemplate" = dc_field( metadata=dc_config(field_name="message_template") ) # Whether to create channels for the campaign, if they don't exist create_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_channels") ) # The description of the campaign description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # The name of the campaign name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # The sender mode of the campaign sender_mode: "Optional[CampaignSenderMode]" = dc_field( default=None, metadata=dc_config(field_name="sender_mode") ) # The visibility of the created channels for the sender sender_visibility: "Optional[CampaignSenderVisibility]" = dc_field( default=None, metadata=dc_config(field_name="sender_visibility") ) # Whether the campaign should show channels, if they are hidden show_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_channels") ) # Whether to skip push notifications skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Whether to skip webhooks skip_webhook: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_webhook") ) # The IDs of the segments to send the campaign to. Duplicate user IDs are removed. Use either user_ids or segment_ids, not both segment_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="segment_ids") ) # The userIDs to send the campaign to. Use either segment ids or user ids not both user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_ids") ) channel_template: "Optional[CampaignChannelTemplate]" = dc_field( default=None, metadata=dc_config(field_name="channel_template") ) @dataclass class CreateCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @dataclass class CreateChannelTypeRequest(DataClassJsonMixin): # Automod. One of: disabled, simple, AI automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # Automod behavior. One of: flag, block automod_behavior: "BlocklistBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) # Max message length max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) # Channel type name name: str = dc_field(metadata=dc_config(field_name="name")) # Blocklist blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # Blocklist behavior. One of: flag, block, shadow_block blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) # Connect events connect_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="connect_events") ) # Count messages in channel. count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Custom events custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_events") ) delivery_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delivery_events") ) # Mark messages pending mark_messages_pending: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_pending") ) # Message retention. One of: infinite, numeric message_retention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_retention") ) # Mutes mutes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mutes") ) # Partition size partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) # Partition TTL partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Polls polls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="polls") ) # Default push notification level for the channel type. One of: all, all_mentions, mentions, direct_mentions, none push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # Push notifications push_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) # Enables message quotes quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) # Reactions reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Read events read_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="read_events") ) # Enables message reminders reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reminders") ) # Replies replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Search search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="search") ) # Enables shared location messages shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) skip_last_msg_update_for_system_msgs: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs"), ) # Typing events typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Uploads uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # URL enrichment url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # Blocklists blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # List of commands that channel supports commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) # List of permissions for the channel type permissions: "Optional[List[PolicyRequest]]" = dc_field( default=None, metadata=dc_config(field_name="permissions") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) # List of grants for the channel type grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class CreateChannelTypeResponse(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) commands: List[str] = dc_field(metadata=dc_config(field_name="commands")) permissions: "List[PolicyRequest]" = dc_field( metadata=dc_config(field_name="permissions") ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class CreateCollectionsRequest(DataClassJsonMixin): # List of collections to create collections: "List[CollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of created collections collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @dataclass class CreateCommandRequest(DataClassJsonMixin): # Description, shown in commands auto-completion description: str = dc_field(metadata=dc_config(field_name="description")) # Unique command name name: str = dc_field(metadata=dc_config(field_name="name")) # Arguments help text, shown in commands auto-completion args: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="args")) # Set name used for grouping commands set: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="set")) @dataclass class CreateCommandResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents custom chat command command: "Optional[Command]" = dc_field( default=None, metadata=dc_config(field_name="command") ) @dataclass class CreateDeviceRequest(DataClassJsonMixin): # Device ID id: str = dc_field(metadata=dc_config(field_name="id")) # Push provider push_provider: "PushProviderName" = dc_field( metadata=dc_config(field_name="push_provider") ) # Stable physical device identifier used to deduplicate pushes across push providers (e.g. APNs VoIP and Firebase on the same iOS device). Distinct from 'id', which is the push token. hardware_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="hardware_id") ) # Push provider name push_provider_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="push_provider_name") ) # **Server-side only**. User ID which server acts upon user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # When true the token is for Apple VoIP push notifications voip_token: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="voip_token") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateExternalStorageRequest(DataClassJsonMixin): # The name of the bucket on the service provider bucket: str = dc_field(metadata=dc_config(field_name="bucket")) # The name of the provider, this must be unique name: str = dc_field(metadata=dc_config(field_name="name")) # The type of storage to use storage_type: str = dc_field(metadata=dc_config(field_name="storage_type")) gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) # The path prefix to use for storing files path: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="path")) # Config for creating Amazon S3 storage. aws_s3: "Optional[S3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) # Config for creating Azure Blob Storage storage azure_blob: "Optional[AzureRequest]" = dc_field( default=None, metadata=dc_config(field_name="azure_blob") ) @dataclass class CreateExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class CreateFeedGroupRequest(DataClassJsonMixin): # Unique identifier for the feed group id: str = dc_field(metadata=dc_config(field_name="id")) # Role new followers of feeds in this group are given. Either a built-in (feed_follower, feed_member_viewer) or any role your app has defined. Empty means feed_follower. Applied when the follow is accepted, so a follow that starts pending picks it up on approval default_follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_follower_role") ) # Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @dataclass class CreateFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_group: "FeedGroupResponse" = dc_field( metadata=dc_config(field_name="feed_group") ) @dataclass class CreateFeedViewRequest(DataClassJsonMixin): # Unique identifier for the feed view id: str = dc_field(metadata=dc_config(field_name="id")) # Configuration for selecting activities activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @dataclass class CreateFeedViewResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_view: "FeedViewResponse" = dc_field(metadata=dc_config(field_name="feed_view")) @dataclass class CreateFeedsBatchRequest(DataClassJsonMixin): # List of feeds to create feeds: "List[FeedRequest]" = dc_field(metadata=dc_config(field_name="feeds")) # Server-side only. If true, auto-creates users referenced by feeds[].created_by_id that don't already exist. Default: false. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # If true, enriches the created feeds with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @dataclass class CreateFeedsBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of created feeds feeds: "List[FeedResponse]" = dc_field(metadata=dc_config(field_name="feeds")) @dataclass class CreateGuestRequest(DataClassJsonMixin): # User request object user: "UserRequest" = dc_field(metadata=dc_config(field_name="user")) @dataclass class CreateGuestResponse(DataClassJsonMixin): # the access token to authenticate the user access_token: str = dc_field(metadata=dc_config(field_name="access_token")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class CreateImportRequest(DataClassJsonMixin): mode: str = dc_field(metadata=dc_config(field_name="mode")) path: str = dc_field(metadata=dc_config(field_name="path")) merge_custom: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="merge_custom") ) @dataclass class CreateImportResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) import_task: "Optional[ImportTask]" = dc_field( default=None, metadata=dc_config(field_name="import_task") ) @dataclass class CreateImportURLRequest(DataClassJsonMixin): filename: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="filename") ) @dataclass class CreateImportURLResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) path: str = dc_field(metadata=dc_config(field_name="path")) upload_url: str = dc_field(metadata=dc_config(field_name="upload_url")) @dataclass class CreateImportV2TaskRequest(DataClassJsonMixin): product: str = dc_field(metadata=dc_config(field_name="product")) settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateImportV2TaskResponse(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) id: str = dc_field(metadata=dc_config(field_name="id")) product: str = dc_field(metadata=dc_config(field_name="product")) state: int = dc_field(metadata=dc_config(field_name="state")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) @dataclass class CreateMembershipLevelRequest(DataClassJsonMixin): # Unique identifier for the membership level id: str = dc_field(metadata=dc_config(field_name="id")) # Display name for the membership level name: str = dc_field(metadata=dc_config(field_name="name")) # Optional description of the membership level description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Priority level (higher numbers = higher priority) priority: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Activity tags this membership level gives access to tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="tags") ) # Custom data for the membership level custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CreateMembershipLevelResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) membership_level: "MembershipLevelResponse" = dc_field( metadata=dc_config(field_name="membership_level") ) @dataclass class CreatePermissionRequest(DataClassJsonMixin): # Action name this permission is for (e.g. SendMessage) action: str = dc_field(metadata=dc_config(field_name="action")) # Unique permission ID id: str = dc_field(metadata=dc_config(field_name="id")) # Name of the permission name: str = dc_field(metadata=dc_config(field_name="name")) # MongoDB style condition which decides whether or not the permission is granted condition: Dict[str, object] = dc_field(metadata=dc_config(field_name="condition")) # Description of the permission description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether this permission applies to resource owner or not owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="owner") ) # Whether this permission applies to teammates (multi-tenancy mode only) same_team: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="same_team") ) @dataclass class CreatePolicyTestSetRequest(DataClassJsonMixin): # Display name; unique within an app name: str = dc_field(metadata=dc_config(field_name="name")) # Moderation config key (default: app default) config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Execution target: 'check' or 'labels'. Optional — defaults to 'labels' when the org has the labels API enabled, 'check' otherwise mode: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mode")) # Team scope for the config (optional) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Messages to test; capped at 1000. Mutually exclusive with seed rows: "Optional[List[PolicyTestRow]]" = dc_field( default=None, metadata=dc_config(field_name="rows") ) seed: "Optional[PolicyTestSeedSpec]" = dc_field( default=None, metadata=dc_config(field_name="seed") ) @dataclass class CreatePollOptionRequest(DataClassJsonMixin): # Option text text: str = dc_field(metadata=dc_config(field_name="text")) # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreatePollRequest(DataClassJsonMixin): # The name of the poll name: str = dc_field(metadata=dc_config(field_name="name")) # Indicates whether users can suggest user defined answers allow_answers: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_answers") ) allow_user_suggested_options: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_user_suggested_options") ) # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) # A description of the poll description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Indicates whether users can cast multiple votes enforce_unique_vote: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_vote") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Indicates whether the poll is open for voting is_closed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_closed") ) # Indicates the maximum amount of votes a user can cast max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Represents the visibility of votes in a poll. voting_visibility: "Optional[VotingVisibility]" = dc_field( default=None, metadata=dc_config(field_name="voting_visibility") ) options: "Optional[List[PollOptionInput]]" = dc_field( default=None, metadata=dc_config(field_name="options") ) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreatePredefinedFilterRequest(DataClassJsonMixin): # The unique name of the predefined filter (alphanumeric, _, - only) name: str = dc_field(metadata=dc_config(field_name="name")) # The operation this filter is for (e.g., QueryChannels) operation: str = dc_field(metadata=dc_config(field_name="operation")) # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # The description of the predefined filter description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class CreatePredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class CreateQueueRequest(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) filters: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filters") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateReminderRequest(DataClassJsonMixin): expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) remind_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="remind_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateReminderResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @dataclass class CreateRoleRequest(DataClassJsonMixin): # Role name name: str = dc_field(metadata=dc_config(field_name="name")) @dataclass class CreateRoleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) role: "Role" = dc_field(metadata=dc_config(field_name="role")) @dataclass class CreateSIPTrunkRequest(DataClassJsonMixin): # Name of the SIP trunk name: str = dc_field(metadata=dc_config(field_name="name")) # Phone numbers associated with this SIP trunk numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) # Optional password for SIP trunk authentication password: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="password") ) # Optional list of allowed IPv4/IPv6 addresses or CIDR blocks allowed_ips: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_ips") ) @dataclass class CreateSIPTrunkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP trunk information sip_trunk: "Optional[SIPTrunkResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_trunk") ) @dataclass class CreateSegmentRequest(DataClassJsonMixin): # The type of the segment type: str = dc_field(metadata=dc_config(field_name="type")) # If true, all sender channels are included in the segment all_sender_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="all_sender_channels") ) # If true, all users are included in the segment all_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="all_users") ) # The description of the segment (max 256 characters) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The ID of the segment id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # The name of the segment (max 128 characters) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class CreateSegmentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) segment: "Optional[SegmentResponse]" = dc_field( default=None, metadata=dc_config(field_name="segment") ) @dataclass class CreateUserGroupRequest(DataClassJsonMixin): # The user friendly name of the user group name: str = dc_field(metadata=dc_config(field_name="name")) # An optional description for the group description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Optional user group ID. If not provided, a UUID v7 will be generated id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Optional team ID to scope the group to a team team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) # Optional initial list of user IDs to add as members member_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_ids") ) @dataclass class CreateUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class CustomActionRequestPayload(DataClassJsonMixin): # Custom action identifier id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Custom action options options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @dataclass class CustomCheckFlag(DataClassJsonMixin): # Type of check (custom_check_text, custom_check_image, custom_check_video) type: str = dc_field(metadata=dc_config(field_name="type")) # Optional explanation for the flag reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # Labels from various moderation sources labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) # Additional metadata for the flag custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class CustomCheckRequest(DataClassJsonMixin): # Unique identifier of the entity entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity to perform custom check on entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # List of custom check flags (1-10 flags required) flags: "List[CustomCheckFlag]" = dc_field(metadata=dc_config(field_name="flags")) # ID of the user who created the entity (required for non-message entities) entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Content payload for moderation moderation_payload: "Optional[ModerationPayloadRequest]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CustomCheckResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Unique identifier of the custom check id: str = dc_field(metadata=dc_config(field_name="id")) # Status of the custom check status: str = dc_field(metadata=dc_config(field_name="status")) item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @dataclass class CustomEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field(default="*", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class CustomVideoEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event, "custom" in this case type: str = dc_field(default="custom", metadata=dc_config(field_name="type")) @dataclass class DailyAggregateCallDurationReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "CallDurationReport" = dc_field(metadata=dc_config(field_name="report")) @dataclass class DailyAggregateCallParticipantCountReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "CallParticipantCountReport" = dc_field( metadata=dc_config(field_name="report") ) @dataclass class DailyAggregateCallsPerDayReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "CallsPerDayReport" = dc_field(metadata=dc_config(field_name="report")) @dataclass class DailyAggregateQualityScoreReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "QualityScoreReport" = dc_field(metadata=dc_config(field_name="report")) @dataclass class DailyAggregateSDKUsageReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "SDKUsageReport" = dc_field(metadata=dc_config(field_name="report")) @dataclass class DailyAggregateUserFeedbackReportResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) report: "UserFeedbackReport" = dc_field(metadata=dc_config(field_name="report")) @dataclass class DailyDigestCallSessionSummary(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) has_digest: bool = dc_field(metadata=dc_config(field_name="has_digest")) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) digest_error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="digest_error") ) session_ended_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="session_ended_at") ) session_started_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="session_started_at") ) @dataclass class DailyMetricResponse(DataClassJsonMixin): # Date in YYYY-MM-DD format date: str = dc_field(metadata=dc_config(field_name="date")) # Metric value for this date value: int = dc_field(metadata=dc_config(field_name="value")) @dataclass class DailyMetricStatsResponse(DataClassJsonMixin): # Total value across all days in the date range total: int = dc_field(metadata=dc_config(field_name="total")) # Array of daily metric values daily: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class DailyValue(DataClassJsonMixin): # Date in YYYY-MM-DD format date: str = dc_field(metadata=dc_config(field_name="date")) # Metric value for this date value: int = dc_field(metadata=dc_config(field_name="value")) @dataclass class Data(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) @dataclass class DataDogInfo(DataClassJsonMixin): api_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="api_key") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) site: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="site")) @dataclass class DeactivateUserRequest(DataClassJsonMixin): # ID of the user who deactivated the user created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Makes messages appear to be deleted mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) @dataclass class DeactivateUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class DeactivateUsersRequest(DataClassJsonMixin): # User IDs to deactivate user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) # ID of the user who deactivated the users created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) mark_channels_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_channels_deleted") ) # Makes messages appear to be deleted mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) @dataclass class DeactivateUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class DecayFunctionConfig(DataClassJsonMixin): # Base value for decay function base: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="base")) # Decay rate decay: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decay") ) # Direction of decay direction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direction") ) # Offset value for decay function offset: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="offset") ) # Origin value for decay function origin: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="origin") ) # Scale factor for decay function scale: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="scale") ) @dataclass class DeleteActionConfigResponse(DataClassJsonMixin): # Number of action configs deleted (0 or 1) deleted: int = dc_field(metadata=dc_config(field_name="deleted")) duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteActivitiesRequest(DataClassJsonMixin): # List of activity IDs to delete ids: List[str] = dc_field(metadata=dc_config(field_name="ids")) # Whether to also delete any notification activities created from mentions in these activities delete_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_notification_activity") ) # Whether to permanently delete the activities hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class DeleteActivitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of activity IDs that were successfully deleted deleted_ids: List[str] = dc_field(metadata=dc_config(field_name="deleted_ids")) @dataclass class DeleteActivityReactionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @dataclass class DeleteActivityRequestPayload(DataClassJsonMixin): # ID of the activity to delete (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity (required for delete_activity to distinguish v2 vs v3) entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the activity hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteBookmarkFolderResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class DeleteCallRequest(DataClassJsonMixin): # if true the call will be hard deleted along with all related data hard: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="hard")) @dataclass class DeleteCallResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) @dataclass class DeleteCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @dataclass class DeleteChannelsRequest(DataClassJsonMixin): # All channels that should be deleted cids: List[str] = dc_field(metadata=dc_config(field_name="cids")) # Server-side only. When true, the channels and all their resources are permanently deleted instead of soft-deleted. hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Server-side only. When true, the soft delete preserves message history instead of hiding it, so a later recreation of any of these channel IDs restores the full history. Only supported for distinct channels. Cannot be combined with hard_delete. skip_truncate: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_truncate") ) @dataclass class DeleteChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) # Map of channel IDs and their deletion results result: "Optional[Dict[str, Optional[DeleteChannelsResultResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="result") ) @dataclass class DeleteChannelsResultResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) @dataclass class DeleteCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteCommandResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Command name name: str = dc_field(metadata=dc_config(field_name="name")) @dataclass class DeleteCommentBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class DeleteCommentReactionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @dataclass class DeleteCommentRequestPayload(DataClassJsonMixin): # ID of the comment to delete (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the comment hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteCommentResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class DeleteExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteFeedGroupResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteFeedResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The ID of the async task that will handle feed cleanup and hard deletion task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class DeleteFeedUserDataRequest(DataClassJsonMixin): # Whether to perform a hard delete instead of a soft delete hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) @dataclass class DeleteFeedUserDataResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The task ID for the deletion task task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class DeleteFeedViewResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteFeedsBatchRequest(DataClassJsonMixin): # List of fully qualified feed IDs (format: group_id:feed_id) to delete feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) # Whether to permanently delete the feeds instead of soft delete hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # When hard-deleting, also fully delete activities authored by each feed's owner from every other feed those activities were fanned out to. Default false preserves existing fan-out. Requires 'hard_delete' to be true; the request is rejected otherwise. Feeds with no recorded owner (created_by_id is empty) are silently skipped for the purge step — owner-matching against an empty string is a safety guard, not a wildcard. purge_user_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="purge_user_activities") ) @dataclass class DeleteFeedsBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The ID of the async task that will handle feed cleanup and hard deletion task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class DeleteFeedsRetentionPolicyRequest(DataClassJsonMixin): policy: str = dc_field(metadata=dc_config(field_name="policy")) @dataclass class DeleteFeedsRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteHistoryWindowTeamsRequest(DataClassJsonMixin): # Teams to put back on the app's default history window, 1 to 10, each listed once. A team without full history is ignored teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) @dataclass class DeleteHistoryWindowTeamsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The teams of the request that had full history and are now back on the default window teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) @dataclass class DeleteImportV2TaskResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteMessageRequestPayload(DataClassJsonMixin): # ID of the message to delete (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the message hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) DeleteMessagesType = NewType("DeleteMessagesType", str) class DeleteMessages: HARD: Final[DeleteMessagesType] = "hard" PRUNING: Final[DeleteMessagesType] = "pruning" SOFT: Final[DeleteMessagesType] = "soft" @dataclass class DeleteModerationConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteModerationRuleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteModerationTemplateResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeletePollAnswerRequestPayload(DataClassJsonMixin): # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeletePollOptionRequestPayload(DataClassJsonMixin): # Option to delete. Required on an item for a whole poll (create or edit); defaults to the option an add_option / update_option item was raised for option_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="option_id") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeletePollRequestPayload(DataClassJsonMixin): # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteQueueRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class DeleteReactionRequestPayload(DataClassJsonMixin): # ID of the reaction to delete (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the reaction hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteReactionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) reaction: "ReactionResponse" = dc_field(metadata=dc_config(field_name="reaction")) @dataclass class DeleteRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteReminderResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteRetentionPolicyRequest(DataClassJsonMixin): # What a retention policy applies to. policy: "RetentionPolicyType" = dc_field(metadata=dc_config(field_name="policy")) channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) @dataclass class DeleteRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteSIPInboundRoutingRuleResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteSIPTrunkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteScheduledMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # A message scheduled to be sent later scheduled_message: "ScheduledMessageResponse" = dc_field( metadata=dc_config(field_name="scheduled_message") ) @dataclass class DeleteSegmentTargetsRequest(DataClassJsonMixin): # Target IDs target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) @dataclass class DeleteTranscriptionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class DeleteUserInterestsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Interest tags still set on the user interests: "List[InterestTagResponse]" = dc_field( metadata=dc_config(field_name="interests") ) @dataclass class DeleteUserMessagesRequestPayload(DataClassJsonMixin): # Message deletion mode: soft, pruning, or hard delete_messages: "DeleteMessages" = dc_field( metadata=dc_config(field_name="delete_messages") ) # Optional: scope deletion to a single channel (alternative to app-wide deletion) channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Whether to also delete the user's reactions on other users' messages delete_reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_reactions") ) # ID of the user whose messages should be deleted (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Reason for the deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteUserRequestPayload(DataClassJsonMixin): # Also delete all user conversations delete_conversation_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_conversation_channels") ) # Delete flagged feeds content delete_feeds_content: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_feeds_content") ) # ID of the user to delete (alternative to item_id) entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the user hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Also delete all user messages mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) # Reason for deletion reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class DeleteUsersRequest(DataClassJsonMixin): # IDs of users to delete user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) # Calls delete mode. # Affected calls are those that include exactly two members, one of whom is the user being deleted. # * null or empty string - doesn't delete any calls # * soft - marks user's calls and their related data as deleted (soft-delete) # * hard - deletes user's calls and their data completely (hard-delete) calls: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="calls") ) # Conversation channels delete mode. # Conversation channel is any channel which only has two members one of which is the user being deleted. # * null or empty string - doesn't delete any conversation channels, unless user is 'hard', in which case it defaults to 'hard' # * soft - marks all conversation channels as deleted (same effect as Delete Channels with 'hard' option disabled) # * hard - deletes channel and all its data completely including messages (same effect as Delete Channels with 'hard' option enabled) # * keep - doesn't delete any conversation channels. Use it with user 'hard', where null or empty string defaults to 'hard' conversations: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="conversations") ) # Delete user files. # * false or empty string - doesn't delete any files # * true - deletes all files uploaded by the user, including images and attachments. files: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="files") ) # Message delete mode. # * null or empty string - doesn't delete user messages # * soft - marks all user messages as deleted without removing any related message data # * pruning - marks all user messages as deleted, nullifies message information and removes some message data such as reactions and flags # * hard - deletes messages completely with all related information messages: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="messages") ) new_call_owner_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_call_owner_id") ) new_channel_owner_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_channel_owner_id") ) # User delete mode. # * soft - marks user as deleted and retains all user data # * pruning - marks user as deleted and nullifies user information # * hard - deletes user completely. Requires 'hard' option for messages, and 'hard' or 'keep' option for conversations user: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="user")) @dataclass class DeleteUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # ID of the task to delete users task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class DeliveredMessagePayload(DataClassJsonMixin): cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) @dataclass class DeliveryReceiptsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) @dataclass class DeliveryZoneSegment(DataClassJsonMixin): key: str = dc_field(metadata=dc_config(field_name="key")) outlier: bool = dc_field(metadata=dc_config(field_name="outlier")) sessions: int = dc_field(metadata=dc_config(field_name="sessions")) avg_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_quality_score") ) p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="share_pct") ) watch_share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="watch_share_pct") ) @dataclass class DetectedURLResponse(DataClassJsonMixin): # The URL as found. url: str = dc_field(metadata=dc_config(field_name="url")) # Where it was found: `qr` (decoded from a QR code in an image), `ocr` (in text visible in an image) or `text` (in a moderated text). source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="source") ) @dataclass class DeviceDataResponse(DataClassJsonMixin): name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @dataclass class DeviceErrorInfo(DataClassJsonMixin): error_message: str = dc_field(metadata=dc_config(field_name="error_message")) provider: str = dc_field(metadata=dc_config(field_name="provider")) provider_name: str = dc_field(metadata=dc_config(field_name="provider_name")) @dataclass class DeviceResponse(DataClassJsonMixin): # The date when the device was created. created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The device identifier. id: str = dc_field(metadata=dc_config(field_name="id")) # Push provider push_provider: "PushProviderName" = dc_field( metadata=dc_config(field_name="push_provider") ) # User ID user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Whether device is disabled or not disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) # Reason explaining why device had been disabled disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) # Stable physical device identifier used to deduplicate pushes across push providers hardware_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="hardware_id") ) # Push provider name push_provider_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="push_provider_name") ) # When true the token is for Apple VoIP push notifications voip: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="voip")) @dataclass class DraftPayloadResponse(DataClassJsonMixin): # Message ID is unique string identifier of the message id: str = dc_field(metadata=dc_config(field_name="id")) # Text of the message text: str = dc_field(metadata=dc_config(field_name="text")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Contains HTML markup of the message html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) # MML content of the message mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Identifier of the poll to include in the message poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) # Whether thread reply should be shown in the channel as well show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # Whether message is silent or not silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) # Contains type of the message. One of: regular, system type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # Array of message attachments attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of mentioned users mentioned_users: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) @dataclass class DraftResponse(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Contains the draft message content message: "DraftPayloadResponse" = dc_field(metadata=dc_config(field_name="message")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) # Represents any chat message quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) @dataclass class EMAUStatsResponse(DataClassJsonMixin): # Per-day unique engaged user counts daily: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="daily") ) # Rolling 30-day engaged user count snapshots last_30_days: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="last_30_days") ) # Calendar month-to-date engaged user count snapshots month_to_date: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="month_to_date") ) @dataclass class EdgeResponse(DataClassJsonMixin): continent_code: str = dc_field(metadata=dc_config(field_name="continent_code")) country_iso_code: str = dc_field(metadata=dc_config(field_name="country_iso_code")) green: int = dc_field(metadata=dc_config(field_name="green")) id: str = dc_field(metadata=dc_config(field_name="id")) latency_test_url: str = dc_field(metadata=dc_config(field_name="latency_test_url")) latitude: float = dc_field(metadata=dc_config(field_name="latitude")) longitude: float = dc_field(metadata=dc_config(field_name="longitude")) red: int = dc_field(metadata=dc_config(field_name="red")) subdivision_iso_code: str = dc_field( metadata=dc_config(field_name="subdivision_iso_code") ) yellow: int = dc_field(metadata=dc_config(field_name="yellow")) @dataclass class EgressHLSResponse(DataClassJsonMixin): playlist_url: str = dc_field(metadata=dc_config(field_name="playlist_url")) status: str = dc_field(metadata=dc_config(field_name="status")) @dataclass class EgressRTMPResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) started_at: datetime = dc_field( metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) stream_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_key") ) stream_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_url") ) @dataclass class EgressResponse(DataClassJsonMixin): broadcasting: bool = dc_field(metadata=dc_config(field_name="broadcasting")) rtmps: "List[EgressRTMPResponse]" = dc_field(metadata=dc_config(field_name="rtmps")) composite_recording: "Optional[CompositeRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="composite_recording") ) frame_recording: "Optional[FrameRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) hls: "Optional[EgressHLSResponse]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) individual_recording: "Optional[IndividualRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) raw_recording: "Optional[RawRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) @dataclass class EncodingProfile(DataClassJsonMixin): getstats_snapshots: int = dc_field( metadata=dc_config(field_name="getstats_snapshots") ) source_file: str = dc_field(metadata=dc_config(field_name="source_file")) svc_modes: List[str] = dc_field(metadata=dc_config(field_name="svc_modes")) quality_limitation_durations_s: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="quality_limitation_durations_s") ) quality_limitation_samples: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="quality_limitation_samples") ) avg_send_kbps: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_send_kbps") ) codec: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="codec") ) encoder_impl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="encoder_impl") ) fps_p10: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fps_p10") ) fps_p50: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fps_p50") ) hardware_encode: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hardware_encode") ) ladder_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ladder_type") ) power_efficient: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="power_efficient") ) resolution: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="resolution") ) simulcast_layers: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="simulcast_layers") ) @dataclass class EncryptionSettingsRequest(DataClassJsonMixin): # Encryption mode. One of: available, disabled, auto-on mode: "Optional[FeatureActivationMode]" = dc_field( default=None, metadata=dc_config(field_name="mode") ) @dataclass class EncryptionSettingsResponse(DataClassJsonMixin): # the resolved encryption mode for the call mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) @dataclass class EndCallResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class EnrichedActivity(DataClassJsonMixin): foreign_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="foreign_id") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="score") ) time: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="time")) verb: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="verb")) to: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="to") ) actor: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="actor") ) latest_reactions: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) object: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="object") ) origin: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="origin") ) own_reactions: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_reactions") ) reaction_counts: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_counts") ) target: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="target") ) @dataclass class EnrichedCollectionResponse(DataClassJsonMixin): # Unique identifier for the collection within its name id: str = dc_field(metadata=dc_config(field_name="id")) # Name/type of the collection name: str = dc_field(metadata=dc_config(field_name="name")) # Enrichment status of the collection. One of: ok, notfound status: "CollectionStatus" = dc_field(metadata=dc_config(field_name="status")) # When the collection was created created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the collection was last updated updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ID of the user who owns this collection user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the collection custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class EnrichedReaction(DataClassJsonMixin): activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) kind: str = dc_field(metadata=dc_config(field_name="kind")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) created_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_at") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) parent: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent") ) updated_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="updated_at") ) target_feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds") ) children_counts: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="children_counts") ) data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) latest_children: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_children") ) own_children: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_children") ) user: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class EnrichmentOptions(DataClassJsonMixin): # Default: false. When true, includes fetching and enriching own_followings (follows where activity author's feeds follow current user's feeds). enrich_own_followings: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_followings") ) # Controls the top-level flat 'activities' array for aggregated feeds. For new apps, defaults to false (excluded); set to true to include. For older apps, defaults to true (included) for backward compatibility; set to false to exclude. include_flat_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_flat_activities") ) # Default: false. Server-side only. When true, the response includes ranking_config: the ranking configuration (from the feed view, or the feed group as fallback) used to rank this read. include_ranking_config: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_ranking_config") ) # Default: false. When true, For You activities include reasons: codes for why each was shown. Ignored with skip_all. include_reasons: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_reasons") ) # Default: false. When true, includes score_vars in activity responses containing variable values used at ranking time. include_score_vars: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_score_vars") ) # Default: false. When true, skips all activity enrichments. skip_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity") ) # Default: false. When true, skips enriching collections on activities. skip_activity_collections: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_collections") ) # Default: false. When true, skips enriching comments on activities. skip_activity_comments: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_comments") ) # Default: false. When true, skips enriching current_feed on activities. Note: CurrentFeed is still computed for permission checks, but enrichment is skipped. skip_activity_current_feed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_current_feed") ) # Default: false. When true, skips enriching mentioned users on activities. skip_activity_mentioned_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_mentioned_users") ) # Default: false. When true, skips enriching own bookmarks on activities. skip_activity_own_bookmarks: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_own_bookmarks") ) # Default: false. When true, skips enriching parent activities. skip_activity_parents: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_parents") ) # Default: false. When true, skips enriching poll data on activities. skip_activity_poll: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_poll") ) # Default: false. When true, skips fetching and enriching latest and own reactions on activities. Note: If reactions are already denormalized in the database, they will still be included. skip_activity_reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_reactions") ) # Default: false. When true, skips refreshing image URLs on activities. skip_activity_refresh_image_urls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_activity_refresh_image_urls") ) # Default: false. When true, skips all enrichments. skip_all: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_all") ) # Default: false. When true, skips enriching user data on feed members. skip_feed_member_user: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_feed_member_user") ) # Default: false. When true, skips fetching and enriching followers. Note: If followers_pagination is explicitly provided, followers will be fetched regardless of this setting. skip_followers: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_followers") ) # Default: false. When true, skips fetching and enriching following. Note: If following_pagination is explicitly provided, following will be fetched regardless of this setting. skip_following: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_following") ) # Default: false. When true, skips computing and including capabilities for feeds. skip_own_capabilities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_own_capabilities") ) # Default: false. When true, skips fetching and enriching own_follows (follows where user's feeds follow target feeds). skip_own_follows: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_own_follows") ) # Default: false. When true, skips enriching pinned activities. skip_pins: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_pins") ) @dataclass class EntityCreatorResponse(DataClassJsonMixin): # Number of minor actions performed on the user ban_count: int = dc_field(metadata=dc_config(field_name="ban_count")) banned: bool = dc_field(metadata=dc_config(field_name="banned")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of major actions performed on the user deleted_content_count: int = dc_field( metadata=dc_config(field_name="deleted_content_count") ) # Number of flag actions performed on the user flagged_count: int = dc_field(metadata=dc_config(field_name="flagged_count")) id: str = dc_field(metadata=dc_config(field_name="id")) invisible: bool = dc_field(metadata=dc_config(field_name="invisible")) language: str = dc_field(metadata=dc_config(field_name="language")) online: bool = dc_field(metadata=dc_config(field_name="online")) role: str = dc_field(metadata=dc_config(field_name="role")) shadow_banned: bool = dc_field(metadata=dc_config(field_name="shadow_banned")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) bypass_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="bypass_moderation") ) deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) devices: "Optional[List[DeviceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="devices") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) push_notifications: "Optional[PushNotificationSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class ErrorResult(DataClassJsonMixin): description: str = dc_field(metadata=dc_config(field_name="description")) type: str = dc_field(metadata=dc_config(field_name="type")) stacktrace: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stacktrace") ) version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @dataclass class EscalatePayload(DataClassJsonMixin): # Additional context for the reviewer notes: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notes") ) # Priority of the escalation (low, medium, high) priority: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Reason for the escalation (from configured escalation_reasons) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class EscalationMetadata(DataClassJsonMixin): notes: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notes") ) priority: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="priority") ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class EventHook(DataClassJsonMixin): created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) gcp_pubsub_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_auth_type") ) gcp_pubsub_event_based_ordering_key_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_event_based_ordering_key_enabled"), ) gcp_pubsub_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_region") ) gcp_pubsub_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcp_pubsub_topic") ) hook_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="hook_type") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) product: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="product") ) should_send_custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="should_send_custom_events") ) sns_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_auth_type") ) sns_event_based_message_group_id_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="sns_event_based_message_group_id_enabled"), ) sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) sns_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_region") ) sns_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_role_arn") ) sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) sqs_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_auth_type") ) sqs_event_based_message_group_id_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="sqs_event_based_message_group_id_enabled"), ) sqs_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_key") ) sqs_queue_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_queue_url") ) sqs_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_region") ) sqs_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_role_arn") ) sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout_ms") ) updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webhook_url") ) event_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="event_types") ) callback: "Optional[AsyncModerationCallbackConfig]" = dc_field( default=None, metadata=dc_config(field_name="callback") ) failover_config: "Optional[WebhookFailoverConfig]" = dc_field( default=None, metadata=dc_config(field_name="failover_config") ) @dataclass class EventNotificationSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) apns: "APNS" = dc_field(metadata=dc_config(field_name="apns")) fcm: "FCM" = dc_field(metadata=dc_config(field_name="fcm")) @dataclass class EventNotificationSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) apns: "Optional[APNSPayload]" = dc_field( default=None, metadata=dc_config(field_name="apns") ) fcm: "Optional[FCMPayload]" = dc_field( default=None, metadata=dc_config(field_name="fcm") ) @dataclass class EventNotificationSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) apns: "APNSPayload" = dc_field(metadata=dc_config(field_name="apns")) fcm: "FCMPayload" = dc_field(metadata=dc_config(field_name="fcm")) @dataclass class EventRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class EventResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents an BaseEvent that happened in Stream Chat event: "WSEvent" = dc_field(metadata=dc_config(field_name="event")) @dataclass class ExportChannelsRequest(DataClassJsonMixin): # Export options for channels channels: "List[ChannelExport]" = dc_field( metadata=dc_config(field_name="channels") ) # Set if deleted message text should be cleared clear_deleted_message_text: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="clear_deleted_message_text") ) export_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="export_users") ) # Output format: 'json' (default) or 'csv'. csv requires version=v2 and is incompatible with export_users format: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="format") ) # Set if you want to include deleted channels include_soft_deleted_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_soft_deleted_channels") ) # Set if you want to include truncated messages include_truncated_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_truncated_messages") ) # Export version version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) # For csv format: subset of message columns to include (defaults to a standard set) include_fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="include_fields") ) @dataclass class ExportChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # ID of the task to export channels task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ExportFeedUserDataResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The task ID for the export task task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ExportFeedsAppRequest(DataClassJsonMixin): # Whether soft-deleted activities and comments are exported. Defaults to true include_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_deleted") ) # Only export these item types, e.g. activity or comment; each one of the export layout item types, without duplicates. poll and poll_vote require activity. Empty exports everything types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="types") ) @dataclass class ExportFeedsByTypeRequest(DataClassJsonMixin): # Only export rows created at or after this time. On reactions it requires user_id or activity_ids, on follows user_id; on comments without activity_ids soft-deleted rows are left out created_at_from: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_from", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Only export rows created before this time. On reactions it requires user_id or activity_ids, on follows user_id; on comments without activity_ids soft-deleted rows are left out created_at_to: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_to", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether soft-deleted activities and comments are exported. Defaults to false; true cannot be combined with user_id on activities or comments include_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_deleted") ) # Only export rows of this user: activities, comments and reactions by the user; follows where the user created the source or the target feed. With user_id, soft-deleted activities and comments are left out user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Only export comments or reactions of these activities; not allowed on other types. At most 100 unique, non-empty IDs activity_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="activity_ids") ) @dataclass class ExportFeedsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The task ID for the export task task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ExportUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of exported messages messages: "Optional[List[MessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="messages") ) # List of exported reactions reactions: "Optional[List[ReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ExportUsersRequest(DataClassJsonMixin): user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) @dataclass class ExportUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ExternalStorageResponse(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) name: str = dc_field(metadata=dc_config(field_name="name")) path: str = dc_field(metadata=dc_config(field_name="path")) type: str = dc_field(metadata=dc_config(field_name="type")) @dataclass class FCM(DataClassJsonMixin): data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class FCMPayload(DataClassJsonMixin): data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class FailedChannelUpdates(DataClassJsonMixin): reason: str = dc_field(metadata=dc_config(field_name="reason")) cids: List[str] = dc_field(metadata=dc_config(field_name="cids")) FeatureActivationModeType = NewType("FeatureActivationModeType", str) class FeatureActivationMode: AUTO_ON: Final[FeatureActivationModeType] = "auto-on" AVAILABLE: Final[FeatureActivationModeType] = "available" DISABLED: Final[FeatureActivationModeType] = "disabled" @dataclass class FeedCreatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "feeds.feed.created" in this case type: str = dc_field( default="feeds.feed.created", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class FeedDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.feed.deleted" in this case type: str = dc_field( default="feeds.feed.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FeedGroup(DataClassJsonMixin): aggregation_version: int = dc_field( metadata=dc_config(field_name="aggregation_version") ) app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) default_follower_role: str = dc_field( metadata=dc_config(field_name="default_follower_role") ) # Who can see and follow a feed. default_visibility: "FeedVisibility" = dc_field( metadata=dc_config(field_name="default_visibility") ) group_id: str = dc_field(metadata=dc_config(field_name="group_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) activity_processors: "List[ActivityProcessorConfig]" = dc_field( metadata=dc_config(field_name="activity_processors") ) activity_selectors: "List[ActivitySelectorConfig]" = dc_field( metadata=dc_config(field_name="activity_selectors") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) last_feed_get_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_feed_get_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @dataclass class FeedGroupChangedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.feed_group.changed" in this case type: str = dc_field( default="feeds.feed_group.changed", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) feed_group: "Optional[FeedGroup]" = dc_field( default=None, metadata=dc_config(field_name="feed_group") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FeedGroupDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) # The ID of the feed group that was deleted group_id: str = dc_field(metadata=dc_config(field_name="group_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.feed_group.deleted" in this case type: str = dc_field( default="feeds.feed_group.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class FeedGroupResponse(DataClassJsonMixin): # When the feed group was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Identifier within the group id: str = dc_field(metadata=dc_config(field_name="id")) # When the feed group was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Role new followers of feeds in this group are given. Either a built-in (feed_follower, feed_member_viewer) or any role your app has defined. Empty means feed_follower. Applied when the follow is accepted, so a follow that starts pending picks it up on approval default_follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_follower_role") ) # Default visibility for activities. One of: public, visible, followers, members, private default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Configuration for activity processors activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors activity_selectors: "Optional[List[ActivitySelectorConfigResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @dataclass class FeedGroupRestoredEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) # The ID of the feed group that was restored group_id: str = dc_field(metadata=dc_config(field_name="group_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.feed_group.restored" in this case type: str = dc_field( default="feeds.feed_group.restored", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class FeedGroupScope(DataClassJsonMixin): # Select activities from every feed group except these. An activity cross-posted to an excluded and a non-excluded group is still selected. Mutually exclusive with include exclude: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="exclude") ) # Select only activities that live in a feed belonging to one of these feed groups. Mutually exclusive with exclude include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="include") ) @dataclass class FeedInput(DataClassJsonMixin): description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Who can see and follow a feed. visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class FeedMemberAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) member: "FeedMemberResponse" = dc_field(metadata=dc_config(field_name="member")) # The type of event: "feeds.feed_member.added" in this case type: str = dc_field( default="feeds.feed_member.added", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FeedMemberRemovedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) member_id: str = dc_field(metadata=dc_config(field_name="member_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.feed_member.removed" in this case type: str = dc_field( default="feeds.feed_member.removed", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FeedMemberRequest(DataClassJsonMixin): # ID of the user to add as a member user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Whether this is an invite to become a member invite: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invite") ) # ID of the membership level to assign to the member membership_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="membership_level") ) # Role of the member in the feed role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # Custom data for the member custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class FeedMemberResponse(DataClassJsonMixin): # When the membership was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Role of the member in the feed role: str = dc_field(metadata=dc_config(field_name="role")) # Status of the membership. One of: member, pending, rejected status: "FeedMemberStatus" = dc_field(metadata=dc_config(field_name="status")) # When the membership was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # When the invite was accepted invite_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_accepted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the invite was rejected invite_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_rejected_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Custom data for the membership custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) membership_level: "Optional[MembershipLevelResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership_level") ) FeedMemberStatusType = NewType("FeedMemberStatusType", str) class FeedMemberStatus: MEMBER: Final[FeedMemberStatusType] = "member" PENDING: Final[FeedMemberStatusType] = "pending" REJECTED: Final[FeedMemberStatusType] = "rejected" @dataclass class FeedMemberUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) member: "FeedMemberResponse" = dc_field(metadata=dc_config(field_name="member")) # The type of event: "feeds.feed_member.updated" in this case type: str = dc_field( default="feeds.feed_member.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) FeedOwnCapabilityType = NewType("FeedOwnCapabilityType", str) class FeedOwnCapability: ADD_ACTIVITY: Final[FeedOwnCapabilityType] = "add-activity" ADD_ACTIVITY_BOOKMARK: Final[FeedOwnCapabilityType] = "add-activity-bookmark" ADD_ACTIVITY_REACTION: Final[FeedOwnCapabilityType] = "add-activity-reaction" ADD_COMMENT: Final[FeedOwnCapabilityType] = "add-comment" ADD_COMMENT_REACTION: Final[FeedOwnCapabilityType] = "add-comment-reaction" CREATE_FEED: Final[FeedOwnCapabilityType] = "create-feed" DELETE_ANY_ACTIVITY: Final[FeedOwnCapabilityType] = "delete-any-activity" DELETE_ANY_COMMENT: Final[FeedOwnCapabilityType] = "delete-any-comment" DELETE_FEED: Final[FeedOwnCapabilityType] = "delete-feed" DELETE_OWN_ACTIVITY: Final[FeedOwnCapabilityType] = "delete-own-activity" DELETE_OWN_ACTIVITY_BOOKMARK: Final[FeedOwnCapabilityType] = ( "delete-own-activity-bookmark" ) DELETE_OWN_ACTIVITY_REACTION: Final[FeedOwnCapabilityType] = ( "delete-own-activity-reaction" ) DELETE_OWN_COMMENT: Final[FeedOwnCapabilityType] = "delete-own-comment" DELETE_OWN_COMMENT_REACTION: Final[FeedOwnCapabilityType] = ( "delete-own-comment-reaction" ) FOLLOW: Final[FeedOwnCapabilityType] = "follow" PIN_ACTIVITY: Final[FeedOwnCapabilityType] = "pin-activity" QUERY_FEED_MEMBERS: Final[FeedOwnCapabilityType] = "query-feed-members" QUERY_FOLLOWS: Final[FeedOwnCapabilityType] = "query-follows" READ_ACTIVITIES: Final[FeedOwnCapabilityType] = "read-activities" READ_FEED: Final[FeedOwnCapabilityType] = "read-feed" UNFOLLOW: Final[FeedOwnCapabilityType] = "unfollow" UPDATE_ANY_ACTIVITY: Final[FeedOwnCapabilityType] = "update-any-activity" UPDATE_ANY_COMMENT: Final[FeedOwnCapabilityType] = "update-any-comment" UPDATE_FEED: Final[FeedOwnCapabilityType] = "update-feed" UPDATE_FEED_FOLLOWERS: Final[FeedOwnCapabilityType] = "update-feed-followers" UPDATE_FEED_MEMBERS: Final[FeedOwnCapabilityType] = "update-feed-members" UPDATE_OWN_ACTIVITY: Final[FeedOwnCapabilityType] = "update-own-activity" UPDATE_OWN_ACTIVITY_BOOKMARK: Final[FeedOwnCapabilityType] = ( "update-own-activity-bookmark" ) UPDATE_OWN_COMMENT: Final[FeedOwnCapabilityType] = "update-own-comment" @dataclass class FeedOwnData(DataClassJsonMixin): # Capabilities the current user has for this feed own_capabilities: "Optional[List[FeedOwnCapability]]" = dc_field( default=None, metadata=dc_config(field_name="own_capabilities") ) # Follow relationships where the feed owner's feeds are following the current user's feeds (up to 5 total) own_followings: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_followings") ) # Follow relationships where the current user's feeds are following this feed own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @dataclass class FeedRequest(DataClassJsonMixin): # ID of the feed group feed_group_id: str = dc_field(metadata=dc_config(field_name="feed_group_id")) # ID of the feed feed_id: str = dc_field(metadata=dc_config(field_name="feed_id")) # ID of the feed creator created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Description of the feed description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Name of the feed name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Visibility setting for the feed. One of: public, visible, followers, members, private visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Initial members for the feed members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Custom data for the feed custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class FeedResponse(DataClassJsonMixin): activity_count: int = dc_field(metadata=dc_config(field_name="activity_count")) # When the feed was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Description of the feed description: str = dc_field(metadata=dc_config(field_name="description")) # Fully qualified feed ID (group_id:id) feed: str = dc_field(metadata=dc_config(field_name="feed")) # Number of followers of this feed follower_count: int = dc_field(metadata=dc_config(field_name="follower_count")) # Number of feeds this feed follows following_count: int = dc_field(metadata=dc_config(field_name="following_count")) # Group this feed belongs to group_id: str = dc_field(metadata=dc_config(field_name="group_id")) # Unique identifier for the feed id: str = dc_field(metadata=dc_config(field_name="id")) # Number of members in this feed member_count: int = dc_field(metadata=dc_config(field_name="member_count")) # Name of the feed name: str = dc_field(metadata=dc_config(field_name="name")) # Number of pinned activities in this feed pin_count: int = dc_field(metadata=dc_config(field_name="pin_count")) # When the feed was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) # When the feed was deleted deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Visibility setting for the feed visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Capabilities the current user has for this feed own_capabilities: "Optional[List[FeedOwnCapability]]" = dc_field( default=None, metadata=dc_config(field_name="own_capabilities") ) # Follow relationships where the feed owner’s feeds are following the current user's feeds own_followings: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_followings") ) # Follow relationships where the current user's feeds are following this feed own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) # Custom data for the feed custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @dataclass class FeedSuggestionResponse(DataClassJsonMixin): activity_count: int = dc_field(metadata=dc_config(field_name="activity_count")) # When the feed was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Description of the feed description: str = dc_field(metadata=dc_config(field_name="description")) # Fully qualified feed ID (group_id:id) feed: str = dc_field(metadata=dc_config(field_name="feed")) # Number of followers of this feed follower_count: int = dc_field(metadata=dc_config(field_name="follower_count")) # Number of feeds this feed follows following_count: int = dc_field(metadata=dc_config(field_name="following_count")) # Group this feed belongs to group_id: str = dc_field(metadata=dc_config(field_name="group_id")) # Unique identifier for the feed id: str = dc_field(metadata=dc_config(field_name="id")) # Number of members in this feed member_count: int = dc_field(metadata=dc_config(field_name="member_count")) # Name of the feed name: str = dc_field(metadata=dc_config(field_name="name")) # Number of pinned activities in this feed pin_count: int = dc_field(metadata=dc_config(field_name="pin_count")) # When the feed was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) # When the feed was deleted deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) recommendation_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="recommendation_score") ) # Visibility setting for the feed visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Capabilities the current user has for this feed own_capabilities: "Optional[List[FeedOwnCapability]]" = dc_field( default=None, metadata=dc_config(field_name="own_capabilities") ) # Follow relationships where the feed owner’s feeds are following the current user's feeds own_followings: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_followings") ) # Follow relationships where the current user's feeds are following this feed own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) algorithm_scores: "Optional[Dict[str, float]]" = dc_field( default=None, metadata=dc_config(field_name="algorithm_scores") ) # Custom data for the feed custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @dataclass class FeedUpdatedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) # The type of event: "feeds.feed.updated" in this case type: str = dc_field( default="feeds.feed.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FeedViewResponse(DataClassJsonMixin): # Unique identifier for the custom feed view id: str = dc_field(metadata=dc_config(field_name="id")) # When the feed view was last used last_used_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_used_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Configured activity selectors activity_selectors: "Optional[List[ActivitySelectorConfigResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) FeedVisibilityType = NewType("FeedVisibilityType", str) class FeedVisibility: FOLLOWERS: Final[FeedVisibilityType] = "followers" MEMBERS: Final[FeedVisibilityType] = "members" PRIVATE: Final[FeedVisibilityType] = "private" PUBLIC: Final[FeedVisibilityType] = "public" VISIBLE: Final[FeedVisibilityType] = "visible" @dataclass class FeedVisibilityResponse(DataClassJsonMixin): # Name of the feed visibility level name: str = dc_field(metadata=dc_config(field_name="name")) # List of permission policies permissions: "List[Permission]" = dc_field( metadata=dc_config(field_name="permissions") ) # Permission grants for each role grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) @dataclass class FeedsActivityLocation(DataClassJsonMixin): lat: float = dc_field(metadata=dc_config(field_name="lat")) lng: float = dc_field(metadata=dc_config(field_name="lng")) @dataclass class FeedsBookmarkResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) object_id: str = dc_field(metadata=dc_config(field_name="object_id")) object_type: str = dc_field(metadata=dc_config(field_name="object_type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class FeedsEnrichedCollectionResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) # Enrichment status of a collection entry. status: "CollectionStatus" = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) @dataclass class FeedsFeedResponse(DataClassJsonMixin): activity_count: int = dc_field(metadata=dc_config(field_name="activity_count")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) description: str = dc_field(metadata=dc_config(field_name="description")) feed: str = dc_field(metadata=dc_config(field_name="feed")) follower_count: int = dc_field(metadata=dc_config(field_name="follower_count")) following_count: int = dc_field(metadata=dc_config(field_name="following_count")) group_id: str = dc_field(metadata=dc_config(field_name="group_id")) id: str = dc_field(metadata=dc_config(field_name="id")) member_count: int = dc_field(metadata=dc_config(field_name="member_count")) name: str = dc_field(metadata=dc_config(field_name="name")) pin_count: int = dc_field(metadata=dc_config(field_name="pin_count")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Who can see and follow a feed. visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[FeedsActivityLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class FeedsModerationTemplateConfigPayload(DataClassJsonMixin): # Map of data type names to their content types data_types: "Dict[str, str]" = dc_field(metadata=dc_config(field_name="data_types")) # Key of the moderation configuration to use config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) @dataclass class FeedsNotificationComment(DataClassJsonMixin): comment: str = dc_field(metadata=dc_config(field_name="comment")) id: str = dc_field(metadata=dc_config(field_name="id")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @dataclass class FeedsNotificationContext(DataClassJsonMixin): target: "Optional[FeedsNotificationTarget]" = dc_field( default=None, metadata=dc_config(field_name="target") ) trigger: "Optional[FeedsNotificationTrigger]" = dc_field( default=None, metadata=dc_config(field_name="trigger") ) @dataclass class FeedsNotificationParentActivity(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @dataclass class FeedsNotificationTarget(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) comment: "Optional[FeedsNotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) parent_activity: "Optional[FeedsNotificationParentActivity]" = dc_field( default=None, metadata=dc_config(field_name="parent_activity") ) @dataclass class FeedsNotificationTrigger(DataClassJsonMixin): text: str = dc_field(metadata=dc_config(field_name="text")) type: str = dc_field(metadata=dc_config(field_name="type")) comment: "Optional[FeedsNotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class FeedsPolicyConfig(DataClassJsonMixin): max_age_hours: int = dc_field(metadata=dc_config(field_name="max_age_hours")) feed_groups: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) @dataclass class FeedsPreferences(DataClassJsonMixin): # Push notification preference for comments on user's activities. One of: all, none comment: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Push notification preference for mentions in comments. One of: all, none comment_mention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_mention") ) # Push notification preference for reactions on comments. One of: all, none comment_reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reaction") ) # Push notification preference for replies to comments. One of: all, none comment_reply: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reply") ) # Push notification preference for new followers. One of: all, none follow: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follow") ) # Push notification preference for mentions in activities. One of: all, none mention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="mention") ) # Push notification preference for reactions on user's activities or comments. One of: all, none reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reaction") ) # Push notification preferences for custom activity types. Map of activity type to preference (all or none) custom_activity_types: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="custom_activity_types") ) @dataclass class FeedsPreferencesResponse(DataClassJsonMixin): comment: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment") ) comment_mention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_mention") ) comment_reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reaction") ) comment_reply: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reply") ) follow: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follow") ) mention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="mention") ) reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reaction") ) custom_activity_types: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="custom_activity_types") ) @dataclass class FeedsReactionGroupResponse(DataClassJsonMixin): count: int = dc_field(metadata=dc_config(field_name="count")) first_reaction_at: datetime = dc_field( metadata=dc_config( field_name="first_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) last_reaction_at: datetime = dc_field( metadata=dc_config( field_name="last_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) @dataclass class FeedsReactionResponse(DataClassJsonMixin): activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) comment_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class FeedsRetentionPolicy(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) enabled_at: datetime = dc_field( metadata=dc_config( field_name="enabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) policy: str = dc_field(metadata=dc_config(field_name="policy")) config: "FeedsPolicyConfig" = dc_field(metadata=dc_config(field_name="config")) @dataclass class FeedsRetentionRunResponse(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) date: str = dc_field(metadata=dc_config(field_name="date")) policy: str = dc_field(metadata=dc_config(field_name="policy")) stats: "RunStats" = dc_field(metadata=dc_config(field_name="stats")) @dataclass class FeedsShareResponse(DataClassJsonMixin): activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class FeedsV3ActivityResponse(DataClassJsonMixin): bookmark_count: int = dc_field(metadata=dc_config(field_name="bookmark_count")) comment_count: int = dc_field(metadata=dc_config(field_name="comment_count")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) hidden: bool = dc_field(metadata=dc_config(field_name="hidden")) id: str = dc_field(metadata=dc_config(field_name="id")) popularity: int = dc_field(metadata=dc_config(field_name="popularity")) preview: bool = dc_field(metadata=dc_config(field_name="preview")) reaction_count: int = dc_field(metadata=dc_config(field_name="reaction_count")) # Who is allowed to reply to an activity. restrict_replies: "RestrictReplies" = dc_field( metadata=dc_config(field_name="restrict_replies") ) score: float = dc_field(metadata=dc_config(field_name="score")) share_count: int = dc_field(metadata=dc_config(field_name="share_count")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Who can see an activity. visibility: "ActivityVisibility" = dc_field( metadata=dc_config(field_name="visibility") ) attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) comments: "List[FeedsV3CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) filter_tags: List[str] = dc_field(metadata=dc_config(field_name="filter_tags")) interest_tags: List[str] = dc_field(metadata=dc_config(field_name="interest_tags")) latest_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) own_bookmarks: "List[FeedsBookmarkResponse]" = dc_field( metadata=dc_config(field_name="own_bookmarks") ) own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) collections: "Dict[str, FeedsEnrichedCollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction_groups: "Dict[str, FeedsReactionGroupResponse]" = dc_field( metadata=dc_config(field_name="reaction_groups") ) search_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="search_data") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) friend_reaction_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="friend_reaction_count") ) is_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_read") ) is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) selector_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="selector_source") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) friend_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="friend_reactions") ) latest_shares: "Optional[List[FeedsShareResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_shares") ) current_feed: "Optional[FeedsFeedResponse]" = dc_field( default=None, metadata=dc_config(field_name="current_feed") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) location: "Optional[FeedsActivityLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) metrics: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) notification_context: "Optional[FeedsNotificationContext]" = dc_field( default=None, metadata=dc_config(field_name="notification_context") ) parent: "Optional[FeedsV3ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) score_vars: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="score_vars") ) @dataclass class FeedsV3CommentResponse(DataClassJsonMixin): bookmark_count: int = dc_field(metadata=dc_config(field_name="bookmark_count")) confidence_score: float = dc_field( metadata=dc_config(field_name="confidence_score") ) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) downvote_count: int = dc_field(metadata=dc_config(field_name="downvote_count")) hidden: bool = dc_field(metadata=dc_config(field_name="hidden")) id: str = dc_field(metadata=dc_config(field_name="id")) object_id: str = dc_field(metadata=dc_config(field_name="object_id")) object_type: str = dc_field(metadata=dc_config(field_name="object_type")) reaction_count: int = dc_field(metadata=dc_config(field_name="reaction_count")) reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) score: int = dc_field(metadata=dc_config(field_name="score")) # Moderation status of a comment. status: "CommentStatus" = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) upvote_count: int = dc_field(metadata=dc_config(field_name="upvote_count")) mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @dataclass class Field(DataClassJsonMixin): short: bool = dc_field(metadata=dc_config(field_name="short")) title: str = dc_field(metadata=dc_config(field_name="title")) value: str = dc_field(metadata=dc_config(field_name="value")) @dataclass class FileUploadConfig(DataClassJsonMixin): size_limit: int = dc_field(metadata=dc_config(field_name="size_limit")) allowed_file_extensions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_file_extensions") ) allowed_mime_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_mime_types") ) blocked_file_extensions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_file_extensions") ) blocked_mime_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_mime_types") ) @dataclass class FileUploadRequest(DataClassJsonMixin): # file field file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FileUploadResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # URL to the uploaded asset. Should be used to put to `asset_url` attachment field file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) # URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) @dataclass class FilterConfigResponse(DataClassJsonMixin): # LLM moderation labels available as filter values llm_labels: List[str] = dc_field(metadata=dc_config(field_name="llm_labels")) # AI image moderation labels available as filter values. Reflects the app's effective image taxonomy: custom Bodyguard taxonomy when enabled, otherwise the standard L1 label set. ai_image_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="ai_image_labels") ) # Labels the image OCR pipeline can flag, available as filter values on the `label` field under the ai_image category. The app's LLM labels when LLM configurability is enabled, otherwise the AI text labels. OCR and image-classification labels share the `label` field, so a name present in both matches either. ai_image_ocr_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="ai_image_ocr_labels") ) # AI text moderation labels available as filter values ai_text_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="ai_text_labels") ) # Moderation config keys present in the queue, available as filter values config_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="config_keys") ) # The moderation_payload.custom keys the app has configured as review-queue filter chips (via moderation_dashboard_preferences.filterable_custom_keys). Discovery hint for the dashboard only — the filter accepts any custom key regardless of this list. filterable_custom_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filterable_custom_keys") ) # Names of the app's moderation rules, available as filter values on the `label` field when filtering rule-flagged content. Includes disabled rules, since items flagged before a rule was turned off still carry its name; excludes deleted ones. Scoped to the caller's teams on a multi-tenant app. Capped at 30 names, ordered by name, so an app above that cap is listed partially. rule_names: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="rule_names") ) # AI image moderation labels available as filter values, as a map of L1 label to its L2 sub-labels. Reflects the app's effective image taxonomy: custom Bodyguard taxonomy when enabled, otherwise the standard catalogue of the org's enabled image providers. ai_image_taxonomy: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_taxonomy") ) @dataclass class FirebaseConfig(DataClassJsonMixin): apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_template") ) credentials_json: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="credentials_json") ) data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_template") ) disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="server_key") ) @dataclass class FirebaseConfigFields(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_template") ) credentials_json: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="credentials_json") ) data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_template") ) notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="server_key") ) @dataclass class FlagCountRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) @dataclass class FlagDetails(DataClassJsonMixin): original_text: str = dc_field(metadata=dc_config(field_name="original_text")) automod: "Optional[AutomodDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="automod") ) @dataclass class FlagDetailsResponse(DataClassJsonMixin): original_text: str = dc_field(metadata=dc_config(field_name="original_text")) automod: "Optional[AutomodDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="automod") ) extra: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="extra") ) @dataclass class FlagFeedbackResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) labels: "List[LabelResponse]" = dc_field(metadata=dc_config(field_name="labels")) @dataclass class FlagItemResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Unique identifier of the created moderation item item_id: str = dc_field(metadata=dc_config(field_name="item_id")) @dataclass class FlagMessageDetailsResponse(DataClassJsonMixin): pin_changed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pin_changed") ) should_enrich: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="should_enrich") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) updated_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="updated_by_id") ) @dataclass class FlagRequest(DataClassJsonMixin): # Unique identifier of the entity being flagged entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity being flagged (e.g., message, user) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # ID of the user who created the flagged entity entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Optional explanation for why the content is being flagged reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Additional metadata about the flag custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) moderation_payload: "Optional[ModerationPayload]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FlagResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by_automod: bool = dc_field( metadata=dc_config(field_name="created_by_automod") ) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) approved_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="approved_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="rejected_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reviewed_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reviewed_by") ) target_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_message_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) details: "Optional[FlagDetails]" = dc_field( default=None, metadata=dc_config(field_name="details") ) # Represents any chat message target_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_message") ) # User response object target_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class FlagUpdatedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field(default="flag.updated", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="CreatedBy") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="Message") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="User") ) @dataclass class FlagUserOptions(DataClassJsonMixin): reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class FloodConfig(DataClassJsonMixin): allowlist: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowlist") ) identical: "Optional[FloodIdenticalConfig]" = dc_field( default=None, metadata=dc_config(field_name="identical") ) similar: "Optional[FloodSimilarConfig]" = dc_field( default=None, metadata=dc_config(field_name="similar") ) @dataclass class FloodIdenticalConfig(DataClassJsonMixin): action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class FloodIdenticalRuleParameters(DataClassJsonMixin): min_text_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_text_length") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) track_across_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_across_users") ) allowlist: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowlist") ) @dataclass class FloodSimilarConfig(DataClassJsonMixin): action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) similarity_distance: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="similarity_distance") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class FloodSimilarRuleParameters(DataClassJsonMixin): min_text_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_text_length") ) similarity_distance: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="similarity_distance") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) allowlist: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowlist") ) @dataclass class FollowBatchRequest(DataClassJsonMixin): # List of follow relationships to create follows: "List[FollowRequest]" = dc_field(metadata=dc_config(field_name="follows")) # If true, the batch is queued as a background task, paced per app, and the response has empty follows and a task_id. Server-side only. Supported by the get-or-create endpoint (GetOrCreateFollows); FollowBatch rejects it. Async batches can apply out of order with other follow writes. When unset, server-side batches of at least 10 items run async for apps created on or after 2026-11-05; set false to opt out. _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) # If true, auto-creates users referenced by source/target FIDs in the batch when they don't already exist. Server-side only. Defaults to false. This top-level field is the only supported batch/upsert create_users control. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @dataclass class FollowBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of newly created follow relationships created: "List[FollowResponse]" = dc_field(metadata=dc_config(field_name="created")) # List of current follow relationships follows: "List[FollowResponse]" = dc_field(metadata=dc_config(field_name="follows")) # ID of the background task when the batch ran async task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) @dataclass class FollowCreatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) # The type of event: "feeds.follow.created" in this case type: str = dc_field( default="feeds.follow.created", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class FollowDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) # The type of event: "feeds.follow.deleted" in this case type: str = dc_field( default="feeds.follow.deleted", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) FollowPushPreferenceType = NewType("FollowPushPreferenceType", str) class FollowPushPreference: ALL: Final[FollowPushPreferenceType] = "all" NONE: Final[FollowPushPreferenceType] = "none" @dataclass class FollowRequest(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) # Maximum number of historical activities to copy from the target feed when the follow is first materialized. Not set = unlimited (default). 0 = copy nothing. Range: 0-1000. activity_copy_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="activity_copy_limit") ) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create a notification activity for this follow create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. Use directly on single follow endpoints (Follow, GetOrCreateFollow). On batch endpoints (FollowBatch, GetOrCreateFollows), use the top-level create_users field; per-item follows[i].create_users is rejected. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Push preference for the follow relationship push_preference: "Optional[FollowPushPreference]" = dc_field( default=None, metadata=dc_config(field_name="push_preference") ) # Whether to skip push for this follow skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Status of the follow relationship. One of: accepted, pending, rejected status: "Optional[FollowStatus]" = dc_field( default=None, metadata=dc_config(field_name="status") ) # Custom data for the follow relationship custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class FollowResponse(DataClassJsonMixin): # When the follow relationship was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Role of the follower (source user) in the follow relationship, as stored. A reserved name, or a role your app no longer defines, is reported as stored but evaluated as 'feed_follower'. follower_role: str = dc_field(metadata=dc_config(field_name="follower_role")) # Push preference for notifications. One of: all, none push_preference: "FollowPushPreference" = dc_field( metadata=dc_config(field_name="push_preference") ) # Status of the follow relationship. One of: accepted, pending, rejected status: "FollowStatus" = dc_field(metadata=dc_config(field_name="status")) # When the follow relationship was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) source_feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="source_feed")) target_feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="target_feed")) # When the follow request was accepted request_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="request_accepted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the follow request was rejected request_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="request_rejected_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Custom data for the follow relationship custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) FollowStatusType = NewType("FollowStatusType", str) class FollowStatus: ACCEPTED: Final[FollowStatusType] = "accepted" PENDING: Final[FollowStatusType] = "pending" REJECTED: Final[FollowStatusType] = "rejected" @dataclass class FollowUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) # The type of event: "feeds.follow.updated" in this case type: str = dc_field( default="feeds.follow.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ForYouConfig(DataClassJsonMixin): # Turns For You ranking on. Groups: only the non-aggregated 'foryou' group. Views: applies only when read on that group enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Name of a registered ranking preset that stands in for 'score' when score is empty. One of: for_you_v2, hot preset: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="preset") ) dwell: "Optional[ForYouDwellConfig]" = dc_field( default=None, metadata=dc_config(field_name="dwell") ) exploration: "Optional[ForYouExplorationConfig]" = dc_field( default=None, metadata=dc_config(field_name="exploration") ) @dataclass class ForYouDwellConfig(DataClassJsonMixin): # Keeps each user's long dwells. Requires for_you.enabled and a plan with activity metrics enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Minimum dwell_ms that counts as a long dwell. 1000 to 60000, defaults to 5000 threshold_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold_ms") ) @dataclass class ForYouExplorationConfig(DataClassJsonMixin): # Turns the exploration slot on. Requires for_you.enabled and a plan with activity metrics enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # 1-based position in the ranked list that receives the exploration activity. 1 to 100, defaults to 15 slot: Optional[int] = dc_field(default=None, metadata=dc_config(field_name="slot")) @dataclass class ForkChannelRequest(DataClassJsonMixin): # ID of the top-level message to fork at. The fork copies the visible messages created up to it, itself included, and their replies up to it. Fork only at a message the agent has finished writing: a message still being streamed is copied as it is at the time of the fork message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The channel a fork creates channel: "ForkChannelTarget" = dc_field(metadata=dc_config(field_name="channel")) # When true, the copied messages carry no attachments. By default attachments are copied exclude_attachments: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_attachments") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ForkChannelResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of channel members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # List of channel messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # List of pinned messages in the channel pinned_messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="pinned_messages") ) threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) # A fork of an agent channel fork: "ChannelForkResponse" = dc_field(metadata=dc_config(field_name="fork")) # Milliseconds until the current user's slow mode cool down period ends. Only set on client-side get or create channel and get channel requests while the user is under cool down cooldown_remaining_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_remaining_ms") ) # Whether this channel is hidden or not hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hidden") ) # Messages before this date are hidden from the user hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Number of channel watchers watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) # Active live locations in the channel active_live_locations: "Optional[List[SharedLocationResponseData]]" = dc_field( default=None, metadata=dc_config(field_name="active_live_locations") ) # Pending messages that this user has sent pending_messages: "Optional[List[PendingMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="pending_messages") ) # List of read states read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) # The caller's own scheduled, sending and failed messages in this channel. Set only by a client-side GetOrCreateChannel or QueryChannels with include_scheduled_messages; absent when not requested or not known, in which case use the scheduled messages query scheduled_messages: "Optional[List[ScheduledMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_messages") ) # List of user who is watching the channel watchers: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) membership: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership") ) # The push preference details. push_preferences: "Optional[ChannelPushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) @dataclass class ForkChannelTarget(DataClassJsonMixin): # ID of the new agent channel id: str = dc_field(metadata=dc_config(field_name="id")) # Members of the new channel. Defaults to the source channel's members members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) data: "Optional[ChannelInput]" = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class ForkMessageIDsRequest(DataClassJsonMixin): # IDs of messages of the source channel, up to 1000 source_message_ids: List[str] = dc_field( metadata=dc_config(field_name="source_message_ids") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ForkMessageIDsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Maps each given source message ID the fork holds a copy of to the copy's ID. IDs the fork holds no copy of are left out message_id_map: "Dict[str, str]" = dc_field( metadata=dc_config(field_name="message_id_map") ) @dataclass class FrameRecordSettings(DataClassJsonMixin): capture_interval_in_seconds: int = dc_field( metadata=dc_config(field_name="capture_interval_in_seconds") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) @dataclass class FrameRecordingResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) @dataclass class FrameRecordingSettingsRequest(DataClassJsonMixin): capture_interval_in_seconds: int = dc_field( metadata=dc_config(field_name="capture_interval_in_seconds") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) @dataclass class FrameRecordingSettingsResponse(DataClassJsonMixin): capture_interval_in_seconds: int = dc_field( metadata=dc_config(field_name="capture_interval_in_seconds") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) FriendReactionTypeType = NewType("FriendReactionTypeType", str) class FriendReactionType: FOLLOWING: Final[FriendReactionTypeType] = "following" MUTUAL: Final[FriendReactionTypeType] = "mutual" @dataclass class FriendReactionsOptions(DataClassJsonMixin): # Default: false. When true, fetches friend reactions for activities. enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Default: 3, Max: 10. The maximum number of friend reactions to return per activity. limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Default: 'following'. The type of friend relationship to use. 'following' = users you follow, 'mutual' = users with mutual follows. One of: following, mutual type: "Optional[FriendReactionType]" = dc_field( default=None, metadata=dc_config(field_name="type") ) @dataclass class FullUserResponse(DataClassJsonMixin): banned: bool = dc_field(metadata=dc_config(field_name="banned")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) invisible: bool = dc_field(metadata=dc_config(field_name="invisible")) language: str = dc_field(metadata=dc_config(field_name="language")) online: bool = dc_field(metadata=dc_config(field_name="online")) role: str = dc_field(metadata=dc_config(field_name="role")) shadow_banned: bool = dc_field(metadata=dc_config(field_name="shadow_banned")) total_unread_count: int = dc_field( metadata=dc_config(field_name="total_unread_count") ) unread_channels: int = dc_field(metadata=dc_config(field_name="unread_channels")) # Deprecated: Use total_unread_count instead. # Deprecated unread_count: int = dc_field(metadata=dc_config(field_name="unread_count")) unread_threads: int = dc_field(metadata=dc_config(field_name="unread_threads")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) channel_mutes: "List[ChannelMute]" = dc_field( metadata=dc_config(field_name="channel_mutes") ) devices: "List[DeviceResponse]" = dc_field(metadata=dc_config(field_name="devices")) mutes: "List[UserMuteResponse]" = dc_field(metadata=dc_config(field_name="mutes")) teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) bypass_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="bypass_moderation") ) deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) latest_hidden_channels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="latest_hidden_channels") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class FutureChannelBanResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # User response object banned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class GeofenceResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) @dataclass class GeofenceSettings(DataClassJsonMixin): names: List[str] = dc_field(metadata=dc_config(field_name="names")) @dataclass class GeofenceSettingsRequest(DataClassJsonMixin): names: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="names") ) @dataclass class GeofenceSettingsResponse(DataClassJsonMixin): names: List[str] = dc_field(metadata=dc_config(field_name="names")) @dataclass class GetActionConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Moderation action configs grouped by entity type, sorted by order ascending action_config: "Dict[str, List[ModerationActionConfigResponse]]" = dc_field( metadata=dc_config(field_name="action_config") ) @dataclass class GetActiveCallsStatusResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # End time of the status period end_time: datetime = dc_field( metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Start time of the status period start_time: datetime = dc_field( metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) metrics: "Optional[ActiveCallsMetrics]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) summary: "Optional[ActiveCallsSummary]" = dc_field( default=None, metadata=dc_config(field_name="summary") ) @dataclass class GetActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class GetAppealResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @dataclass class GetApplicationResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # A type representing the app settings. app: "AppResponseFields" = dc_field(metadata=dc_config(field_name="app")) @dataclass class GetBlockListResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Block list contains restricted words blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @dataclass class GetBlockedUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Array of blocked user object blocks: "List[BlockedUserResponse]" = dc_field( metadata=dc_config(field_name="blocks") ) @dataclass class GetCallParticipantSessionMetricsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) is_publisher: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_publisher") ) is_subscriber: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_subscriber") ) joined_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="joined_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) publisher_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_type") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) user_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_session_id") ) published_tracks: "Optional[List[PublishedTrackMetrics]]" = dc_field( default=None, metadata=dc_config(field_name="published_tracks") ) client: "Optional[SessionClient]" = dc_field( default=None, metadata=dc_config(field_name="client") ) @dataclass class GetCallReportResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) session_id: str = dc_field(metadata=dc_config(field_name="session_id")) report: "ReportResponse" = dc_field(metadata=dc_config(field_name="report")) video_reactions: "Optional[List[VideoReactionsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="video_reactions") ) chat_activity: "Optional[ChatActivityStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_activity") ) digest: "Optional[BroadcastDigest]" = dc_field( default=None, metadata=dc_config(field_name="digest") ) session: "Optional[CallSessionResponse]" = dc_field( default=None, metadata=dc_config(field_name="session") ) @dataclass class GetCallResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class GetCallSessionParticipantStatsDetailsResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) publisher: "Optional[ParticipantSeriesPublisherStats]" = dc_field( default=None, metadata=dc_config(field_name="publisher") ) subscriber: "Optional[ParticipantSeriesSubscriberStats]" = dc_field( default=None, metadata=dc_config(field_name="subscriber") ) timeframe: "Optional[ParticipantSeriesTimeframe]" = dc_field( default=None, metadata=dc_config(field_name="timeframe") ) user: "Optional[ParticipantSeriesUserStats]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class GetCallTypeResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) name: str = dc_field(metadata=dc_config(field_name="name")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) notification_settings: "NotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="notification_settings") ) settings: "CallSettingsResponse" = dc_field( metadata=dc_config(field_name="settings") ) external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @dataclass class GetCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @dataclass class GetChannelTypeResponse(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) commands: "List[Command]" = dc_field(metadata=dc_config(field_name="commands")) permissions: "List[PolicyRequest]" = dc_field( metadata=dc_config(field_name="permissions") ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class GetCommandResponse(DataClassJsonMixin): args: str = dc_field(metadata=dc_config(field_name="args")) description: str = dc_field(metadata=dc_config(field_name="description")) duration: str = dc_field(metadata=dc_config(field_name="duration")) name: str = dc_field(metadata=dc_config(field_name="name")) set: str = dc_field(metadata=dc_config(field_name="set")) created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class GetCommentRepliesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Sort order used for the replies (first, last, top, best, controversial) sort: str = dc_field(metadata=dc_config(field_name="sort")) # Threaded listing of replies to the comment comments: "List[ThreadedCommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class GetCommentResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class GetCommentsResponse(DataClassJsonMixin): # Total number of comments on the object, including replies at every depth comment_count: int = dc_field(metadata=dc_config(field_name="comment_count")) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Sort order used for the comments (first, last, top, best, controversial) sort: str = dc_field(metadata=dc_config(field_name="sort")) # Threaded listing for the activity comments: "List[ThreadedCommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Number of comments directly on the object, excluding replies. Independent of depth, replies_limit and id_around, and not adjusted per viewer. Only present when include_top_level_comment_count is set top_level_comment_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="top_level_comment_count") ) @dataclass class GetConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) config: "Optional[ConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @dataclass class GetCustomPermissionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) permission: "Permission" = dc_field(metadata=dc_config(field_name="permission")) @dataclass class GetDailyDigestResponse(DataClassJsonMixin): date: str = dc_field(metadata=dc_config(field_name="date")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) status: str = dc_field(metadata=dc_config(field_name="status")) generated_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="generated_at") ) retry_after: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="retry_after") ) revision: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="revision") ) schema_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="schema_version") ) broadcasts: "Optional[List[BroadcastDigest]]" = dc_field( default=None, metadata=dc_config(field_name="broadcasts") ) call_sessions: "Optional[List[DailyDigestCallSessionSummary]]" = dc_field( default=None, metadata=dc_config(field_name="call_sessions") ) digest_kinds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="digest_kinds") ) broadcast_rollup: "Optional[BroadcastDailyRollup]" = dc_field( default=None, metadata=dc_config(field_name="broadcast_rollup") ) @dataclass class GetDraftResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) draft: "DraftResponse" = dc_field(metadata=dc_config(field_name="draft")) @dataclass class GetEdgesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) edges: "List[EdgeResponse]" = dc_field(metadata=dc_config(field_name="edges")) @dataclass class GetExternalStorageAWSS3Response(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) region: str = dc_field(metadata=dc_config(field_name="region")) role_arn: str = dc_field(metadata=dc_config(field_name="role_arn")) path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @dataclass class GetExternalStorageGCSResponse(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) credentials_set: bool = dc_field(metadata=dc_config(field_name="credentials_set")) path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @dataclass class GetExternalStorageResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) aws_s3: "Optional[GetExternalStorageAWSS3Response]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) gcs: "Optional[GetExternalStorageGCSResponse]" = dc_field( default=None, metadata=dc_config(field_name="gcs") ) @dataclass class GetFeedCountsResponse(DataClassJsonMixin): # Number of activities in the feed activity_count: int = dc_field(metadata=dc_config(field_name="activity_count")) # Total number of comments on those activities, including nested replies comment_count: int = dc_field(metadata=dc_config(field_name="comment_count")) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Sum of activity_count and comment_count total_count: int = dc_field(metadata=dc_config(field_name="total_count")) @dataclass class GetFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_group: "FeedGroupResponse" = dc_field( metadata=dc_config(field_name="feed_group") ) @dataclass class GetFeedViewResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_view: "FeedViewResponse" = dc_field(metadata=dc_config(field_name="feed_view")) @dataclass class GetFeedVisibilityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_visibility: "FeedVisibilityResponse" = dc_field( metadata=dc_config(field_name="feed_visibility") ) @dataclass class GetFeedsRateLimitsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Rate limits for Android platform (endpoint name -> limit info) android: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="android") ) # Rate limits for iOS platform (endpoint name -> limit info) ios: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="ios") ) # Rate limits for server-side platform (endpoint name -> limit info) server_side: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="server_side") ) # Rate limits for Unity platform (endpoint name -> limit info) unity: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity") ) # Rate limits for Unity console platform (endpoint name -> limit info) unity_console: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity_console") ) # Rate limits for Unity desktop platform (endpoint name -> limit info) unity_desktop: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity_desktop") ) # Rate limits for Web platform (endpoint name -> limit info) web: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="web") ) @dataclass class GetFeedsRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) policies: "List[FeedsRetentionPolicy]" = dc_field( metadata=dc_config(field_name="policies") ) @dataclass class GetFeedsRetentionPolicyRunsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class GetFeedsRetentionPolicyRunsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) runs: "List[FeedsRetentionRunResponse]" = dc_field( metadata=dc_config(field_name="runs") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class GetFlagCountRequest(DataClassJsonMixin): # ID of the user whose content was flagged entity_creator_id: str = dc_field( metadata=dc_config(field_name="entity_creator_id") ) # Optional entity type filter (e.g., stream:chat:v1:message, stream:user) entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) @dataclass class GetFlagCountResponse(DataClassJsonMixin): # Total number of flags against the specified user's content count: int = dc_field(metadata=dc_config(field_name="count")) duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class GetFollowSuggestionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of suggested feeds to follow suggestions: "List[FeedSuggestionResponse]" = dc_field( metadata=dc_config(field_name="suggestions") ) algorithm_used: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="algorithm_used") ) @dataclass class GetHistoryWindowTeamsResponse(DataClassJsonMixin): # History window, in hours, of every team without full history; 0 is full history default_window_hours: int = dc_field( metadata=dc_config(field_name="default_window_hours") ) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Teams with full history teams: "List[HistoryWindowTeam]" = dc_field(metadata=dc_config(field_name="teams")) @dataclass class GetImportResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) import_task: "Optional[ImportTask]" = dc_field( default=None, metadata=dc_config(field_name="import_task") ) @dataclass class GetImportV2TaskResponse(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) id: str = dc_field(metadata=dc_config(field_name="id")) product: str = dc_field(metadata=dc_config(field_name="product")) state: int = dc_field(metadata=dc_config(field_name="state")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) result: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="result") ) @dataclass class GetManyMessagesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @dataclass class GetMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageWithChannelResponse" = dc_field( metadata=dc_config(field_name="message") ) pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @dataclass class GetModerationRuleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) rule: "Optional[ModerationRuleV2Response]" = dc_field( default=None, metadata=dc_config(field_name="rule") ) @dataclass class GetNotificationStatusResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Number of unread activities or groups unread: int = dc_field(metadata=dc_config(field_name="unread")) # Number of unseen activities or groups unseen: int = dc_field(metadata=dc_config(field_name="unseen")) # When the feed was last marked read last_read_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_read_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the feed was last marked seen last_seen_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_seen_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class GetOGResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # URL of detected video or audio asset_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="asset_url") ) author_icon: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_icon") ) # og:site author_link: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_link") ) # og:site_name author_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_name") ) color: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="color") ) fallback: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="fallback") ) footer: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="footer") ) footer_icon: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="footer_icon") ) # URL of detected image image_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image_url") ) # extracted url from the text og_scrape_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="og_scrape_url") ) original_height: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_height") ) original_width: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_width") ) pretext: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pretext") ) # og:description text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # URL of detected thumb image thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) # og:title title: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="title") ) # og:url title_link: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="title_link") ) # Attachment type, could be empty, image, audio or video type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) actions: "Optional[List[Action]]" = dc_field( default=None, metadata=dc_config(field_name="actions") ) fields: "Optional[List[Field]]" = dc_field( default=None, metadata=dc_config(field_name="fields") ) giphy: "Optional[Images]" = dc_field( default=None, metadata=dc_config(field_name="giphy") ) @dataclass class GetOrCreateCallRequest(DataClassJsonMixin): members_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="members_limit") ) # if provided it sends a notification event to the members for this call notify: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notify") ) # if provided it sends a ring event to the members for this call ring: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="ring")) video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="video") ) # CallRequest is the payload for creating a call. data: "Optional[CallRequest]" = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class GetOrCreateCallResponse(DataClassJsonMixin): created: bool = dc_field(metadata=dc_config(field_name="created")) duration: str = dc_field(metadata=dc_config(field_name="duration")) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class GetOrCreateChannelDefaults(DataClassJsonMixin): # Resolved defaults for a nested pagination object. members: "PagerDefaults" = dc_field(metadata=dc_config(field_name="members")) # Resolved defaults for a nested pagination object. messages: "PagerDefaults" = dc_field(metadata=dc_config(field_name="messages")) @dataclass class GetOrCreateFeedGroupRequest(DataClassJsonMixin): # Role new followers of feeds in this group are given. Either a built-in (feed_follower, feed_member_viewer) or any role your app has defined. Empty means feed_follower. Applied when the follow is accepted, so a follow that starts pending picks it up on approval default_follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_follower_role") ) # Default visibility for the feed group, can be 'public', 'visible', 'followers', 'members', or 'private'. Defaults to 'visible' if not provided. default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @dataclass class GetOrCreateFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Indicates whether the feed group was created (true) or already existed (false) was_created: bool = dc_field(metadata=dc_config(field_name="was_created")) feed_group: "FeedGroupResponse" = dc_field( metadata=dc_config(field_name="feed_group") ) @dataclass class GetOrCreateFeedRequest(DataClassJsonMixin): id_around: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_around") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) overwrite_interest_weights: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="overwrite_interest_weights") ) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) view: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="view")) watch: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="watch") ) # Feature-gated; not available for all apps. Request-scoped list of actor/user IDs whose activities are filtered from this GetOrCreateFeed response only. Merged (union) into the viewing user's in-memory blocked authors for this request; never persisted to blocked_users. Max: 1000. discard_actors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="discard_actors") ) data: "Optional[FeedInput]" = dc_field( default=None, metadata=dc_config(field_name="data") ) # Options to skip specific enrichments to improve performance. Default is false (enrichments are included). Setting a field to true skips that enrichment. enrichment_options: "Optional[EnrichmentOptions]" = dc_field( default=None, metadata=dc_config(field_name="enrichment_options") ) external_ranking: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="external_ranking") ) filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) followers_pagination: "Optional[PagerRequest]" = dc_field( default=None, metadata=dc_config(field_name="followers_pagination") ) following_pagination: "Optional[PagerRequest]" = dc_field( default=None, metadata=dc_config(field_name="following_pagination") ) # Options to control fetching reactions from friends (users you follow or have mutual follows with). friend_reactions_options: "Optional[FriendReactionsOptions]" = dc_field( default=None, metadata=dc_config(field_name="friend_reactions_options") ) interest_weights: "Optional[Dict[str, float]]" = dc_field( default=None, metadata=dc_config(field_name="interest_weights") ) member_pagination: "Optional[PagerRequest]" = dc_field( default=None, metadata=dc_config(field_name="member_pagination") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) viewer_location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="viewer_location") ) @dataclass class GetOrCreateFeedResponse(DataClassJsonMixin): created: bool = dc_field(metadata=dc_config(field_name="created")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) aggregated_activities: "List[AggregatedActivityResponse]" = dc_field( metadata=dc_config(field_name="aggregated_activities") ) followers: "List[FollowResponse]" = dc_field( metadata=dc_config(field_name="followers") ) following: "List[FollowResponse]" = dc_field( metadata=dc_config(field_name="following") ) members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) pinned_activities: "List[ActivityPinResponse]" = dc_field( metadata=dc_config(field_name="pinned_activities") ) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Signed token identifying this read. Pass it with activity metrics events to attribute them to this read. Only set on feed reads for paid plans with an authenticated user, when the app uses feed impressions (For You exploration, or a For You ranking that uses impressions_bucket) request_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="request_id") ) # Activity selectors dropped from this read because they exceeded their time budget (see the time_budget_ms selector setting). Their activities are missing from this page, and they stay out for the rest of this pagination session. Omitted when every selector completed degraded_selectors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="degraded_selectors") ) followers_pagination: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="followers_pagination") ) following_pagination: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="following_pagination") ) member_pagination: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="member_pagination") ) notification_status: "Optional[NotificationStatusResponse]" = dc_field( default=None, metadata=dc_config(field_name="notification_status") ) ranking_config: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking_config") ) @dataclass class GetOrCreateFeedViewRequest(DataClassJsonMixin): # Configuration for selecting activities activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @dataclass class GetOrCreateFeedViewResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Indicates whether the feed view was newly created (true) or already existed (false) was_created: bool = dc_field(metadata=dc_config(field_name="was_created")) feed_view: "FeedViewResponse" = dc_field(metadata=dc_config(field_name="feed_view")) @dataclass class GetOrCreateFollowResponse(DataClassJsonMixin): # True if the follow was newly created by this request; false if it already existed created: bool = dc_field(metadata=dc_config(field_name="created")) duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) # Whether a notification activity was successfully created (only set when the follow was newly created) notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @dataclass class GetOrCreateUnfollowRequest(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) # Whether to delete the corresponding notification activity (default: false) delete_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_notification_activity") ) # If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # When true, activities from the unfollowed feed will remain in the source feed's timeline (default: false) keep_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_history") ) @dataclass class GetOrCreateUnfollowResponse(DataClassJsonMixin): # True if a follow was found and removed by this request; false if no follow existed deleted: bool = dc_field(metadata=dc_config(field_name="deleted")) duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "Optional[FollowResponse]" = dc_field( default=None, metadata=dc_config(field_name="follow") ) @dataclass class GetPinnedMessagesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Messages messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @dataclass class GetPredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class GetPushTemplatesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) templates: "List[PushTemplateResponse]" = dc_field( metadata=dc_config(field_name="templates") ) @dataclass class GetRateLimitsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Map of endpoint rate limits for the Android platform android: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="android") ) # Map of endpoint rate limits for the iOS platform ios: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="ios") ) # Map of endpoint rate limits for the server-side platform server_side: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="server_side") ) # Map of endpoint rate limits for the Unity platform unity: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity") ) # Map of endpoint rate limits for the Unity console platform unity_console: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity_console") ) # Map of endpoint rate limits for the Unity desktop platform unity_desktop: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="unity_desktop") ) # Map of endpoint rate limits for the web platform web: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="web") ) @dataclass class GetReactionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of reactions reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) @dataclass class GetRepliesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @dataclass class GetRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) policies: "List[RetentionPolicy]" = dc_field( metadata=dc_config(field_name="policies") ) channel_type_rules: "Optional[List[ChannelTypeRuleResponse]]" = dc_field( default=None, metadata=dc_config(field_name="channel_type_rules") ) @dataclass class GetRetentionPolicyRunsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class GetRetentionPolicyRunsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) runs: "List[RetentionRunResponse]" = dc_field(metadata=dc_config(field_name="runs")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class GetReviewQueueItemResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @dataclass class GetSegmentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) segment: "Optional[SegmentResponse]" = dc_field( default=None, metadata=dc_config(field_name="segment") ) @dataclass class GetSetupSessionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) setup_session: "Optional[SetupSession]" = dc_field( default=None, metadata=dc_config(field_name="setup_session") ) @dataclass class GetTaskResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Current status of the whole operation. A task whose result reports an in-progress status of its own is returned as running until that status is terminal, so completed means the operation itself finished rather than that its first step was accepted. A result that never reaches a terminal status stops being reported as running after a fixed period and falls back to the task's own status. status: str = dc_field(metadata=dc_config(field_name="status")) # ID of task task_id: str = dc_field(metadata=dc_config(field_name="task_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) error: "Optional[ErrorResult]" = dc_field( default=None, metadata=dc_config(field_name="error") ) # Result produced by task after completion. A task that does its work in stages may carry a status of its own here, describing that work rather than the task; the top-level status already accounts for it, so use that to tell whether the operation has finished. result: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="result") ) @dataclass class GetThreadResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) thread: "ThreadStateResponse" = dc_field(metadata=dc_config(field_name="thread")) @dataclass class GetUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class GetUserInterestsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Interest tags sorted by descending weight, then manually set tags before computed ones, then descending count, then alphabetically by tag interests: "List[InterestTagResponse]" = dc_field( metadata=dc_config(field_name="interests") ) @dataclass class GoLiveRequest(DataClassJsonMixin): recording_storage_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_storage_name") ) start_closed_caption: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_closed_caption") ) start_composite_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_composite_recording") ) start_hls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_hls") ) start_individual_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_individual_recording") ) start_raw_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_raw_recording") ) start_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_recording") ) start_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_transcription") ) transcription_storage_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="transcription_storage_name") ) @dataclass class GoLiveResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class GoogleVisionConfig(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @dataclass class GroupedChannelsBucket(DataClassJsonMixin): # Channels returned for this bucket channels: "List[ChannelStateResponseFields]" = dc_field( metadata=dc_config(field_name="channels") ) # Cursor for the next page of this group next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for the previous page of this group prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Total unread channels matching this bucket and its filters, independent of page size unread_channels: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_channels") ) @dataclass class GroupedChannelsGroupRequest(DataClassJsonMixin): # Max channels for this group; values above 15 are capped at 15. Omitted or zero uses the request limit limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Cursor for the next page; only allowed when requesting one group next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for the previous page; only allowed when requesting one group prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Optional query_timestamp $gte bound for a stored group, requiring query_timestamp sort; do not repeat its group name. For all, combine group equality/$in and date bounds with $or, or use one standalone group $ne exclusion. An empty object matches a stored group; omitted or null preserves legacy grouping. filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class GroupedQueryChannelsRequest(DataClassJsonMixin): # Default max channels per group (default 10); values above 15 are capped at 15 limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Optional query_timestamp descending with NULLS LAST when enabled. Omitted sort preserves existing last_updated ordering and cursor formats sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Groups to return, keyed by stored group name. Each entry can define limit, next, prev, and optional filter_conditions: date bounds for stored groups; all supports combined group/date branches or one group $ne exclusion. Cursors are only allowed when requesting exactly one group. Omitted or null filters preserve legacy grouping, including all. groups: "Optional[Dict[str, GroupedChannelsGroupRequest]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class GroupedQueryChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Groups keyed by the requested stored group name groups: "Dict[str, GroupedChannelsBucket]" = dc_field( metadata=dc_config(field_name="groups") ) @dataclass class GroupedStatsResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) unique: int = dc_field(metadata=dc_config(field_name="unique")) @dataclass class HLSSettings(DataClassJsonMixin): auto_on: bool = dc_field(metadata=dc_config(field_name="auto_on")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class HLSSettingsRequest(DataClassJsonMixin): # Quality tracks for HLS. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560 quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) # Whether HLS broadcasting should start automatically auto_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_on") ) # Whether HLS broadcasting is enabled enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class HLSSettingsResponse(DataClassJsonMixin): auto_on: bool = dc_field(metadata=dc_config(field_name="auto_on")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) layout: "LayoutSettingsResponse" = dc_field(metadata=dc_config(field_name="layout")) @dataclass class HarmConfig(DataClassJsonMixin): cooldown_period: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) severity: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="severity") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) action_sequences: "Optional[List[ActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) harm_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_types") ) @dataclass class HideChannelRequest(DataClassJsonMixin): # Whether to clear message history of the channel or not clear_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="clear_history") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class HideChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class HistoryWindowTeam(DataClassJsonMixin): # Date/time the team was first given full history created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The team, as set on channels and users team: str = dc_field(metadata=dc_config(field_name="team")) # Date/time the team was last marked updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) @dataclass class HuaweiConfig(DataClassJsonMixin): disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="secret") ) @dataclass class HuaweiConfigFields(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="secret") ) @dataclass class IPContentCountRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class IPFlagCountRuleParameters(DataClassJsonMixin): severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class ImageContentParameters(DataClassJsonMixin): label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class ImageData(DataClassJsonMixin): frames: str = dc_field(metadata=dc_config(field_name="frames")) height: str = dc_field(metadata=dc_config(field_name="height")) size: str = dc_field(metadata=dc_config(field_name="size")) url: str = dc_field(metadata=dc_config(field_name="url")) width: str = dc_field(metadata=dc_config(field_name="width")) @dataclass class ImageRuleParameters(DataClassJsonMixin): min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class ImageSize(DataClassJsonMixin): # Crop mode. One of: top, bottom, left, right, center crop: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="crop")) # Target image height height: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="height") ) # Resize method. One of: clip, crop, scale, fill resize: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="resize") ) # Target image width width: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="width") ) @dataclass class ImageUploadRequest(DataClassJsonMixin): file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) # field with JSON-encoded array of image size configurations upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ImageUploadResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) # Array of image size configurations upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) @dataclass class Images(DataClassJsonMixin): fixed_height: "ImageData" = dc_field(metadata=dc_config(field_name="fixed_height")) fixed_height_downsampled: "ImageData" = dc_field( metadata=dc_config(field_name="fixed_height_downsampled") ) fixed_height_still: "ImageData" = dc_field( metadata=dc_config(field_name="fixed_height_still") ) fixed_width: "ImageData" = dc_field(metadata=dc_config(field_name="fixed_width")) fixed_width_downsampled: "ImageData" = dc_field( metadata=dc_config(field_name="fixed_width_downsampled") ) fixed_width_still: "ImageData" = dc_field( metadata=dc_config(field_name="fixed_width_still") ) original: "ImageData" = dc_field(metadata=dc_config(field_name="original")) @dataclass class ImportBlockListRequest(DataClassJsonMixin): items: List[str] = dc_field(metadata=dc_config(field_name="items")) chunk_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="chunk_size") ) @dataclass class ImportBlockListResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ImportTask(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) mode: str = dc_field(metadata=dc_config(field_name="mode")) path: str = dc_field(metadata=dc_config(field_name="path")) state: str = dc_field(metadata=dc_config(field_name="state")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) history: "List[ImportTaskHistory]" = dc_field( metadata=dc_config(field_name="history") ) size: Optional[int] = dc_field(default=None, metadata=dc_config(field_name="size")) @dataclass class ImportTaskHistory(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) next_state: str = dc_field(metadata=dc_config(field_name="next_state")) prev_state: str = dc_field(metadata=dc_config(field_name="prev_state")) @dataclass class ImportV2TaskItem(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) product: str = dc_field(metadata=dc_config(field_name="product")) state: int = dc_field(metadata=dc_config(field_name="state")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) result: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="result") ) @dataclass class ImportV2TaskSettings(DataClassJsonMixin): merge_custom: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="merge_custom") ) mode: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mode")) path: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="path")) skip_references_check: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_references_check") ) use_import_time_as_op_time: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="use_import_time_as_op_time") ) s3: "Optional[ImportV2TaskSettingsS3]" = dc_field( default=None, metadata=dc_config(field_name="s3") ) @dataclass class ImportV2TaskSettingsS3(DataClassJsonMixin): bucket: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bucket") ) dir: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="dir")) region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="region") ) @dataclass class Incident(DataClassJsonMixin): _from: str = dc_field(metadata=dc_config(field_name="from")) peak_concurrency: int = dc_field(metadata=dc_config(field_name="peak_concurrency")) to: str = dc_field(metadata=dc_config(field_name="to")) viewers_interrupted: int = dc_field( metadata=dc_config(field_name="viewers_interrupted") ) @dataclass class IndividualRecordSettings(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) output_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="output_types") ) @dataclass class IndividualRecordingResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) @dataclass class IndividualRecordingSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) # Output types to include: audio_only, video_only, audio_video, screenshare_audio_only, screenshare_video_only, screenshare_audio_video output_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="output_types") ) @dataclass class IndividualRecordingSettingsResponse(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) output_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="output_types") ) @dataclass class IngressAudioEncodingOptions(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) channels: int = dc_field(metadata=dc_config(field_name="channels")) enable_dtx: bool = dc_field(metadata=dc_config(field_name="enable_dtx")) @dataclass class IngressAudioEncodingOptionsRequest(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) channels: int = dc_field(metadata=dc_config(field_name="channels")) enable_dtx: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_dtx") ) @dataclass class IngressAudioEncodingResponse(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) channels: int = dc_field(metadata=dc_config(field_name="channels")) enable_dtx: bool = dc_field(metadata=dc_config(field_name="enable_dtx")) @dataclass class IngressErrorEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Human-readable error message error: str = dc_field(metadata=dc_config(field_name="error")) # Unique identifier for the stream ingress_stream_id: str = dc_field( metadata=dc_config(field_name="ingress_stream_id") ) # User who was streaming user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # The type of event: "ingress.error" in this case type: str = dc_field(default="ingress.error", metadata=dc_config(field_name="type")) # Error code code: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="code")) @dataclass class IngressSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) audio_encoding_options: "Optional[IngressAudioEncodingOptions]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) video_encoding_options: "Optional[Dict[str, IngressVideoEncodingOptions]]" = ( dc_field(default=None, metadata=dc_config(field_name="video_encoding_options")) ) @dataclass class IngressSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) audio_encoding_options: "Optional[IngressAudioEncodingOptionsRequest]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) video_encoding_options: "Optional[Dict[str, IngressVideoEncodingOptionsRequest]]" = dc_field( default=None, metadata=dc_config(field_name="video_encoding_options") ) @dataclass class IngressSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) audio_encoding_options: "Optional[IngressAudioEncodingResponse]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) video_encoding_options: "Optional[Dict[str, IngressVideoEncodingResponse]]" = ( dc_field(default=None, metadata=dc_config(field_name="video_encoding_options")) ) @dataclass class IngressSource(DataClassJsonMixin): fps: int = dc_field(metadata=dc_config(field_name="fps")) height: int = dc_field(metadata=dc_config(field_name="height")) width: int = dc_field(metadata=dc_config(field_name="width")) @dataclass class IngressSourceRequest(DataClassJsonMixin): fps: int = dc_field(metadata=dc_config(field_name="fps")) height: int = dc_field(metadata=dc_config(field_name="height")) width: int = dc_field(metadata=dc_config(field_name="width")) @dataclass class IngressSourceResponse(DataClassJsonMixin): fps: int = dc_field(metadata=dc_config(field_name="fps")) height: int = dc_field(metadata=dc_config(field_name="height")) width: int = dc_field(metadata=dc_config(field_name="width")) @dataclass class IngressStartedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for this stream ingress_stream_id: str = dc_field( metadata=dc_config(field_name="ingress_stream_id") ) # Streaming protocol (e.g., 'rtmps', 'srt', 'rtmp', 'rtsp') publisher_type: str = dc_field(metadata=dc_config(field_name="publisher_type")) # User who started the stream user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # The type of event: "ingress.started" in this case type: str = dc_field( default="ingress.started", metadata=dc_config(field_name="type") ) # Client IP address client_ip: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="client_ip") ) # Streaming client software name (e.g., 'OBS Studio') client_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="client_name") ) # Client software version version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @dataclass class IngressStoppedEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for the stream ingress_stream_id: str = dc_field( metadata=dc_config(field_name="ingress_stream_id") ) # User who was streaming user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # The type of event: "ingress.stopped" in this case type: str = dc_field( default="ingress.stopped", metadata=dc_config(field_name="type") ) @dataclass class IngressVideoEncodingOptions(DataClassJsonMixin): layers: "List[IngressVideoLayer]" = dc_field( metadata=dc_config(field_name="layers") ) source: "Optional[IngressSource]" = dc_field( default=None, metadata=dc_config(field_name="source") ) @dataclass class IngressVideoEncodingOptionsRequest(DataClassJsonMixin): layers: "List[IngressVideoLayerRequest]" = dc_field( metadata=dc_config(field_name="layers") ) source: "IngressSourceRequest" = dc_field(metadata=dc_config(field_name="source")) @dataclass class IngressVideoEncodingResponse(DataClassJsonMixin): layers: "List[IngressVideoLayerResponse]" = dc_field( metadata=dc_config(field_name="layers") ) source: "IngressSourceResponse" = dc_field(metadata=dc_config(field_name="source")) @dataclass class IngressVideoLayer(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) # The codec an ingress video layer is encoded with. codec: "VideoCodec" = dc_field(metadata=dc_config(field_name="codec")) frame_rate: int = dc_field(metadata=dc_config(field_name="frame_rate")) max_dimension: int = dc_field(metadata=dc_config(field_name="max_dimension")) min_dimension: int = dc_field(metadata=dc_config(field_name="min_dimension")) @dataclass class IngressVideoLayerRequest(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) # The codec an ingress video layer is encoded with. codec: "VideoCodec" = dc_field(metadata=dc_config(field_name="codec")) frame_rate_limit: int = dc_field(metadata=dc_config(field_name="frame_rate_limit")) max_dimension: int = dc_field(metadata=dc_config(field_name="max_dimension")) min_dimension: int = dc_field(metadata=dc_config(field_name="min_dimension")) @dataclass class IngressVideoLayerResponse(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) codec: str = dc_field(metadata=dc_config(field_name="codec")) frame_rate_limit: int = dc_field(metadata=dc_config(field_name="frame_rate_limit")) max_dimension: int = dc_field(metadata=dc_config(field_name="max_dimension")) min_dimension: int = dc_field(metadata=dc_config(field_name="min_dimension")) @dataclass class InsertActionLogRequest(DataClassJsonMixin): # Type of moderation action taken action_type: str = dc_field(metadata=dc_config(field_name="action_type")) # ID of the user who created the entity entity_creator_id: str = dc_field( metadata=dc_config(field_name="entity_creator_id") ) # ID of the entity the action was taken on entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity the action was taken on entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # Reason for the action reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) # Type of reporter; 'api_integration' when the action was triggered by an API integration call with no authenticated user reporter_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reporter_type") ) # ID of the user who triggered the action; empty for automated actions reporter_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reporter_user_id") ) # Custom metadata for the action log custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class InsertActionLogResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class IntentConditionInfo(DataClassJsonMixin): # Whether the score reached the threshold. passed: bool = dc_field(metadata=dc_config(field_name="passed")) # Final (damped) score of the topic in this analysis; 0 when the topic is not defined in the policy. score: int = dc_field(metadata=dc_config(field_name="score")) # Minimum score (1-100) the condition requires. threshold: int = dc_field(metadata=dc_config(field_name="threshold")) # Policy intent topic label the condition references. topic: str = dc_field(metadata=dc_config(field_name="topic")) @dataclass class IntentConfigRequest(DataClassJsonMixin): # Topics to classify conversation text against (max 20, labels must be unique) topics: "Optional[List[IntentTopicRequest]]" = dc_field( default=None, metadata=dc_config(field_name="topics") ) @dataclass class IntentConfigResponse(DataClassJsonMixin): # Topics conversation text is classified against topics: "List[IntentTopicResponse]" = dc_field( metadata=dc_config(field_name="topics") ) @dataclass class IntentEvaluationInfo(DataClassJsonMixin): # The analyzed conversation: the channel CID for chat, the object ID for feeds. conversation_id: str = dc_field(metadata=dc_config(field_name="conversation_id")) # Number of conversation messages sent to the model. message_count: int = dc_field(metadata=dc_config(field_name="message_count")) # One entry per `intent_rule` condition of the rule, flat conditions first, then group conditions. conditions: "List[IntentConditionInfo]" = dc_field( metadata=dc_config(field_name="conditions") ) # Score (0-100) the model gave every topic in the analysis call, keyed by topic label, before message-count damping. raw_scores: "Dict[str, int]" = dc_field(metadata=dc_config(field_name="raw_scores")) # Final score (0-100) of every topic after message-count damping, keyed by topic label. Conditions compare against these. scores: "Dict[str, int]" = dc_field(metadata=dc_config(field_name="scores")) @dataclass class IntentRuleParameters(DataClassJsonMixin): topic: str = dc_field(metadata=dc_config(field_name="topic")) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) @dataclass class IntentScoreResponse(DataClassJsonMixin): score: int = dc_field(metadata=dc_config(field_name="score")) topic: str = dc_field(metadata=dc_config(field_name="topic")) @dataclass class IntentTopicRequest(DataClassJsonMixin): # Unique topic label (e.g. purchase_intent) label: str = dc_field(metadata=dc_config(field_name="label")) # Optional description used in the classification prompt; the label alone is used when empty description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) @dataclass class IntentTopicResponse(DataClassJsonMixin): # Unique topic label (e.g. purchase_intent) label: str = dc_field(metadata=dc_config(field_name="label")) # Optional description used in the classification prompt; the label alone is used when empty description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) @dataclass class InterestTagResponse(DataClassJsonMixin): # Lifetime number of distinct reacted-to activities tagged with this value, without decay; 0 for manually set tags count: int = dc_field(metadata=dc_config(field_name="count")) # How the tag was set: computed (from the user's reactions) or manual (through the API) source: str = dc_field(metadata=dc_config(field_name="source")) # The interest tag value tag: str = dc_field(metadata=dc_config(field_name="tag")) # Ranking weight between -1.0 and 1.0. Computed tags carry a recency-decayed weight in (0, 1.0]: the user's strongest tag is 1.0 and every other a proportional share weight: float = dc_field(metadata=dc_config(field_name="weight")) @dataclass class JoinCallAPIMetrics(DataClassJsonMixin): failures: float = dc_field(metadata=dc_config(field_name="failures")) total: float = dc_field(metadata=dc_config(field_name="total")) latency: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="latency") ) @dataclass class Joins(DataClassJsonMixin): reason: str = dc_field(metadata=dc_config(field_name="reason")) disconnect_reasons: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="disconnect_reasons") ) failure_stages: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="failure_stages") ) join_attempts: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_attempts") ) join_success_rate: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="join_success_rate") ) @dataclass class KeyframeOCRRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class KeyframeRuleParameters(DataClassJsonMixin): min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class KickUserRequest(DataClassJsonMixin): # The user to kick user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # If true, also block the user from rejoining the call block: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="block") ) # Server-side: ID of the user performing the action kicked_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="kicked_by_id") ) # User request object kicked_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="kicked_by") ) @dataclass class KickUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class KickedUserEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.kicked_user" in this case type: str = dc_field( default="call.kicked_user", metadata=dc_config(field_name="type") ) # User response object kicked_by_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="kicked_by_user") ) @dataclass class LLMConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) app_context: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="app_context") ) custom_keys_context_description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="custom_keys_context_description") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) context_custom_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="context_custom_keys") ) rules: "Optional[List[LLMRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) severity_descriptions: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="severity_descriptions") ) @dataclass class LLMRule(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="action") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) severity_rules: "Optional[List[BodyguardSeverityRule]]" = dc_field( default=None, metadata=dc_config(field_name="severity_rules") ) @dataclass class LabelResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) phrase_list_ids: "Optional[List[int]]" = dc_field( default=None, metadata=dc_config(field_name="phrase_list_ids") ) @dataclass class LabelResultResponse(DataClassJsonMixin): # Category category: str = dc_field(metadata=dc_config(field_name="category")) # The moderated content content: str = dc_field(metadata=dc_config(field_name="content")) content_type: str = dc_field(metadata=dc_config(field_name="content_type")) # Timestamp created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # High-level harm category harm_type: str = dc_field(metadata=dc_config(field_name="harm_type")) # Unique identifier id: str = dc_field(metadata=dc_config(field_name="id")) # Detected language language: str = dc_field(metadata=dc_config(field_name="language")) # Provider recommended action recommended_action: str = dc_field( metadata=dc_config(field_name="recommended_action") ) # Severity level severity: str = dc_field(metadata=dc_config(field_name="severity")) # Moderation labels labels: List[str] = dc_field(metadata=dc_config(field_name="labels")) # Customer-supplied identifier for the moderated content content_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_id") ) # Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.) directed_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="directed_at") ) # The stored content with every non-whitespace character masked. Present only when recommended_action is not 'keep'. Derived at runtime and never stored. fully_masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="fully_masked_content") ) # Content with blocklisted tokens masked (when a blocklist rule with action=mask rewrote the original) masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="masked_content") ) policy: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="policy") ) # Customer-supplied user identifier for the content author user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @dataclass class LabelThresholds(DataClassJsonMixin): # Threshold for automatic message block block: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="block") ) # Threshold for automatic message flag flag: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="flag") ) @dataclass class LabelsRequest(DataClassJsonMixin): # Content to moderate content: str = dc_field(metadata=dc_config(field_name="content")) # Optional category for filtering (max 128 chars) category: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="category") ) # Customer-supplied identifier for the moderated content, for tracing content_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_id") ) # Type of content: 'text' (default), 'message', or 'username'. Stored as-sent; only 'username' routes to the username moderation API. content_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_type") ) # When true, run moderation and return labels without persisting the result. Useful for one-off checks (e.g. UI testers) that should not be recorded in the stored history. dry_run: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="dry_run") ) # Optional moderation policy key (max 128 chars). For username moderation, set this to a policy whose key starts with 'username:' (e.g. 'username:default') to opt into the low-latency fast-path: blocklists (customer + Stream-managed defaults) short-circuit the LLM, and the LLM fallback uses gpt-4o-mini (overridable via moderation_settings.llm_username_model) with a 24h Valkey verdict cache. Without a 'username:' prefix the request falls through to the standard Bodyguard Analyze v1 username path. policy: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="policy") ) # Optional customer-supplied user identifier for the content author (max 256 chars). Enables filtering stored results by user_id. user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @dataclass class LabelsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Provider recommended action recommended_action: str = dc_field( metadata=dc_config(field_name="recommended_action") ) # Customer-supplied identifier for the moderated content, for tracing content_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_id") ) # Who the content is directed at (USER, GROUP, EVERYONE, NONE, etc.), when the provider exposes it directed_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="directed_at") ) # The original content with every non-whitespace character masked. Present only when recommended_action is not 'keep'. Derived at runtime and never stored. fully_masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="fully_masked_content") ) # High-level harm category harm_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="harm_type") ) # Detected language language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) # Content with blocklisted tokens masked or substituted. Present only when a blocklist rewrote the original content. masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="masked_content") ) # Severity level severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) # Moderation labels detected labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) LayoutNameType = NewType("LayoutNameType", str) class LayoutName: CUSTOM: Final[LayoutNameType] = "custom" GRID: Final[LayoutNameType] = "grid" MOBILE: Final[LayoutNameType] = "mobile" SINGLE_PARTICIPANT: Final[LayoutNameType] = "single-participant" SPOTLIGHT: Final[LayoutNameType] = "spotlight" @dataclass class LayoutSettings(DataClassJsonMixin): external_app_url: str = dc_field(metadata=dc_config(field_name="external_app_url")) external_css_url: str = dc_field(metadata=dc_config(field_name="external_css_url")) # The layout a call recording or broadcast is composed with. name: "LayoutName" = dc_field(metadata=dc_config(field_name="name")) detect_orientation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="detect_orientation") ) options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @dataclass class LayoutSettingsRequest(DataClassJsonMixin): # The layout a call recording or broadcast is composed with. name: "LayoutName" = dc_field(metadata=dc_config(field_name="name")) detect_orientation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="detect_orientation") ) external_app_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_app_url") ) external_css_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_css_url") ) options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @dataclass class LayoutSettingsResponse(DataClassJsonMixin): external_app_url: str = dc_field(metadata=dc_config(field_name="external_app_url")) external_css_url: str = dc_field(metadata=dc_config(field_name="external_css_url")) # The layout a call recording or broadcast is composed with. name: "LayoutName" = dc_field(metadata=dc_config(field_name="name")) detect_orientation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="detect_orientation") ) options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @dataclass class LifecycleSettingsRequest(DataClassJsonMixin): # Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer (currently: when the caller cancels the ring). Fixed at call creation mode: "Optional[CallLifecycleMode]" = dc_field( default=None, metadata=dc_config(field_name="mode") ) @dataclass class LifecycleSettingsResponse(DataClassJsonMixin): # Call lifecycle mode. One of: reusable, single_use. A single_use call cannot be reused once it has ended; the server ends it when its ring settles without an answer (currently: when the caller cancels the ring). Fixed at call creation mode: "CallLifecycleMode" = dc_field(metadata=dc_config(field_name="mode")) @dataclass class LimitInfoResponse(DataClassJsonMixin): # The maximum number of API calls allowed per time window limit: int = dc_field(metadata=dc_config(field_name="limit")) # The number of remaining calls in the current window remaining: int = dc_field(metadata=dc_config(field_name="remaining")) # The Unix timestamp when the rate limit resets reset: int = dc_field(metadata=dc_config(field_name="reset")) @dataclass class LimitsSettings(DataClassJsonMixin): max_participants_exclude_roles: List[str] = dc_field( metadata=dc_config(field_name="max_participants_exclude_roles") ) max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) max_participants_exclude_owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_owner") ) @dataclass class LimitsSettingsRequest(DataClassJsonMixin): max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) max_participants_exclude_owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_owner") ) max_participants_exclude_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_roles") ) @dataclass class LimitsSettingsResponse(DataClassJsonMixin): max_participants_exclude_roles: List[str] = dc_field( metadata=dc_config(field_name="max_participants_exclude_roles") ) max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) max_participants_exclude_owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_owner") ) @dataclass class ListBlockListResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) blocklists: "List[BlockListResponse]" = dc_field( metadata=dc_config(field_name="blocklists") ) next_cursor: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="next_cursor") ) @dataclass class ListCallTypeResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) call_types: "Dict[str, CallTypeResponse]" = dc_field( metadata=dc_config(field_name="call_types") ) @dataclass class ListChannelTypesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with all channel types channel_types: "Dict[str, Optional[ChannelTypeConfig]]" = dc_field( metadata=dc_config(field_name="channel_types") ) @dataclass class ListCommandsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of commands commands: "List[Command]" = dc_field(metadata=dc_config(field_name="commands")) @dataclass class ListDevicesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of devices devices: "List[DeviceResponse]" = dc_field(metadata=dc_config(field_name="devices")) @dataclass class ListExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) external_storages: "Dict[str, ExternalStorageResponse]" = dc_field( metadata=dc_config(field_name="external_storages") ) @dataclass class ListFeedGroupsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) groups: "Dict[str, FeedGroupResponse]" = dc_field( metadata=dc_config(field_name="groups") ) @dataclass class ListFeedViewsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Map of feed view ID to feed view views: "Dict[str, FeedViewResponse]" = dc_field( metadata=dc_config(field_name="views") ) @dataclass class ListFeedVisibilitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Map of feed visibility configurations by name feed_visibilities: "Dict[str, FeedVisibilityResponse]" = dc_field( metadata=dc_config(field_name="feed_visibilities") ) @dataclass class ListImportV2TasksResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) import_tasks: "List[ImportV2TaskItem]" = dc_field( metadata=dc_config(field_name="import_tasks") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class ListImportsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) import_tasks: "List[ImportTask]" = dc_field( metadata=dc_config(field_name="import_tasks") ) @dataclass class ListPermissionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) permissions: "List[Permission]" = dc_field( metadata=dc_config(field_name="permissions") ) @dataclass class ListPushProvidersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) push_providers: "List[PushProviderResponse]" = dc_field( metadata=dc_config(field_name="push_providers") ) @dataclass class ListQueuesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) queues: "List[ModerationQueueResponse]" = dc_field( metadata=dc_config(field_name="queues") ) @dataclass class ListRecordingsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) recordings: "List[CallRecording]" = dc_field( metadata=dc_config(field_name="recordings") ) @dataclass class ListRolesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) roles: "List[Role]" = dc_field(metadata=dc_config(field_name="roles")) @dataclass class ListSIPInboundRoutingRuleResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of SIP Inbound Routing Rules for the application sip_inbound_routing_rules: "List[SIPInboundRoutingRuleResponse]" = dc_field( metadata=dc_config(field_name="sip_inbound_routing_rules") ) @dataclass class ListSIPTrunksResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of SIP trunks for the application sip_trunks: "List[SIPTrunkResponse]" = dc_field( metadata=dc_config(field_name="sip_trunks") ) @dataclass class ListTranscriptionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of transcriptions for the call transcriptions: "List[CallTranscription]" = dc_field( metadata=dc_config(field_name="transcriptions") ) @dataclass class ListUserGroupsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of user groups user_groups: "List[UserGroupResponse]" = dc_field( metadata=dc_config(field_name="user_groups") ) @dataclass class Location(DataClassJsonMixin): # Latitude coordinate lat: float = dc_field(metadata=dc_config(field_name="lat")) # Longitude coordinate lng: float = dc_field(metadata=dc_config(field_name="lng")) @dataclass class LocationResponse(DataClassJsonMixin): # Continent code continent_code: str = dc_field(metadata=dc_config(field_name="continent_code")) # Country ISO code country_iso_code: str = dc_field(metadata=dc_config(field_name="country_iso_code")) # Subdivision ISO code subdivision_iso_code: str = dc_field( metadata=dc_config(field_name="subdivision_iso_code") ) @dataclass class MarkActivityRequest(DataClassJsonMixin): # Whether to mark all activities as read mark_all_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_read") ) # Whether to mark all activities as seen mark_all_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_seen") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of activity IDs to mark as read mark_read: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_read") ) # List of activity IDs to mark as seen mark_seen: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_seen") ) # List of activity IDs to mark as watched (for stories) mark_watched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_watched") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkChannelsReadRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Map of channel ID to last read message ID read_by_channel: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="read_by_channel") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkDeliveredRequest(DataClassJsonMixin): latest_delivered_messages: "Optional[List[DeliveredMessagePayload]]" = dc_field( default=None, metadata=dc_config(field_name="latest_delivered_messages") ) @dataclass class MarkDeliveredResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class MarkReadRequest(DataClassJsonMixin): # ID of the message that is considered last read by client message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) # Optional Thread ID to specifically mark a given thread as read thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkReadResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) event: "Optional[MarkReadResponseEvent]" = dc_field( default=None, metadata=dc_config(field_name="event") ) @dataclass class MarkReadResponseEvent(DataClassJsonMixin): channel_id: str = dc_field(metadata=dc_config(field_name="channel_id")) channel_type: str = dc_field(metadata=dc_config(field_name="channel_type")) cid: str = dc_field(metadata=dc_config(field_name="cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field(metadata=dc_config(field_name="type")) channel_last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="channel_last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkReviewedRequestPayload(DataClassJsonMixin): # Maximum content items to mark as reviewed content_to_mark_as_reviewed_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="content_to_mark_as_reviewed_limit") ) # Reason for the appeal decision decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) # Skip marking content as reviewed disable_marking_content_as_reviewed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_marking_content_as_reviewed"), ) # Internal moderator note, stored on the action log and returned by QueryModerationLogs. Not shown to the appealing user; use decision_reason for that reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class MarkUnreadRequest(DataClassJsonMixin): # ID of the message from where the channel is marked unread message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) # Timestamp of the message from where the channel is marked unread message_timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_timestamp", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Mark a thread unread, specify one of the thread, message timestamp, or message id thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MatchedContent(DataClassJsonMixin): # The `content_ids[label]` value supplied on the `/analyze` request that contributed this entry. id: str = dc_field(metadata=dc_config(field_name="id")) # `content_published_at` from the contributing `/analyze` request, or server receive time when that field was omitted. published_at: datetime = dc_field( metadata=dc_config( field_name="published_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Content type that contributed this entry: `image` or `text`. type: str = dc_field(metadata=dc_config(field_name="type")) # Image-classification entries only. Aggregate (max) confidence score across the entry's classifications + sub-classifications. Absent on text and OCR entries. confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) # Text and OCR entries. Aggregate (max) Bodyguard severity level (`LOW` / `MEDIUM` / `HIGH` / `CRITICAL`). Absent on image-classification entries. severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Image-classification entries (keyframe rule, Type=image) carry nested L1 → L2 classifications. Text entries (closed_caption rule, Type=text) carry flat label + severity. Resolved against the app's effective taxonomy on the image side. classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="classifications") ) # OCR entries only (keyframe_ocr rule, Type=image). Bodyguard labels that fired against the keyframe's OCR-extracted text (e.g. `INSULT`, `HATE_SPEECH`). Distinct from `classifications` so consumers can route OCR matches separately from image-classification matches. ocr_classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_classifications") ) @dataclass class MaxStreakChangedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="channel.max_streak_changed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class MediaDisplayResponse(DataClassJsonMixin): # Reveals must be recorded via the reveal media endpoint (blurred CSAM or gore) audit_reveal: bool = dc_field(metadata=dc_config(field_name="audit_reveal")) # Default rendering before a reveal mode: str = dc_field(metadata=dc_config(field_name="mode")) # Only users with the RevealProtectedMedia permission may reveal the media (CSAM) reveal_restricted: bool = dc_field( metadata=dc_config(field_name="reveal_restricted") ) @dataclass class MemberAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) member: "ChannelMemberResponse" = dc_field(metadata=dc_config(field_name="member")) # The type of event: "member.added" in this case type: str = dc_field(default="member.added", metadata=dc_config(field_name="type")) # The ID of the channel to which the member was added channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel to which the member was added channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel to which the member was added cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MemberRemovedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) member: "ChannelMemberResponse" = dc_field(metadata=dc_config(field_name="member")) # The type of event: "member.removed" in this case type: str = dc_field( default="member.removed", metadata=dc_config(field_name="type") ) # The ID of the channel from which the member was removed channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel from which the member was removed channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel from which the member was removed cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MemberRequest(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class MemberResponse(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Custom member response data custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Date/time of deletion deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) @dataclass class MemberUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) member: "ChannelMemberResponse" = dc_field(metadata=dc_config(field_name="member")) # The type of event: "member.updated" in this case type: str = dc_field( default="member.updated", metadata=dc_config(field_name="type") ) # The ID of the channel in which the member was updated channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel in which the member was updated channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel in which the member was updated cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MemberUserRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) invisible: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invisible") ) language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) teams: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="teams") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class MembersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of found members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) @dataclass class MembershipLevelResponse(DataClassJsonMixin): # When the membership level was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for the membership level id: str = dc_field(metadata=dc_config(field_name="id")) # Display name for the membership level name: str = dc_field(metadata=dc_config(field_name="name")) # Priority level priority: int = dc_field(metadata=dc_config(field_name="priority")) # When the membership level was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Activity tags this membership level gives access to tags: List[str] = dc_field(metadata=dc_config(field_name="tags")) # Description of the membership level description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Custom data for the membership level custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class MessageActionRequest(DataClassJsonMixin): # ReadOnlyData to execute command with form_data: "Dict[str, str]" = dc_field(metadata=dc_config(field_name="form_data")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageActionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class MessageChangeSet(DataClassJsonMixin): attachments: bool = dc_field(metadata=dc_config(field_name="attachments")) custom: bool = dc_field(metadata=dc_config(field_name="custom")) html: bool = dc_field(metadata=dc_config(field_name="html")) mentioned_user_ids: bool = dc_field( metadata=dc_config(field_name="mentioned_user_ids") ) mml: bool = dc_field(metadata=dc_config(field_name="mml")) pin: bool = dc_field(metadata=dc_config(field_name="pin")) quoted_message_id: bool = dc_field( metadata=dc_config(field_name="quoted_message_id") ) silent: bool = dc_field(metadata=dc_config(field_name="silent")) text: bool = dc_field(metadata=dc_config(field_name="text")) @dataclass class MessageDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Whether the message was hard deleted hard_delete: bool = dc_field(metadata=dc_config(field_name="hard_delete")) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.deleted" in this case type: str = dc_field( default="message.deleted", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Whether the message was deleted only for the current user deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageFlagResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by_automod: bool = dc_field( metadata=dc_config(field_name="created_by_automod") ) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) approved_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="approved_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="rejected_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) details: "Optional[FlagDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="details") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) moderation_feedback: "Optional[FlagFeedbackResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_feedback") ) # Result of the message moderation moderation_result: "Optional[MessageModerationResult]" = dc_field( default=None, metadata=dc_config(field_name="moderation_result") ) # User response object reviewed_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="reviewed_by") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageFlaggedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.flagged" in this case type: str = dc_field( default="message.flagged", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The reason for the flag reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The total number of flags for the user total_flags: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_flags") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Custom data custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Result of the message moderation details: "Optional[MessageModerationResult]" = dc_field( default=None, metadata=dc_config(field_name="details") ) flag: "Optional[FlagResponse]" = dc_field( default=None, metadata=dc_config(field_name="flag") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageHistoryEntryResponse(DataClassJsonMixin): is_deleted: bool = dc_field(metadata=dc_config(field_name="is_deleted")) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) message_updated_at: datetime = dc_field( metadata=dc_config( field_name="message_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_updated_by_id: str = dc_field( metadata=dc_config(field_name="message_updated_by_id") ) text: str = dc_field(metadata=dc_config(field_name="text")) attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) @dataclass class MessageModerationResult(DataClassJsonMixin): # Action taken by automod action: str = dc_field(metadata=dc_config(field_name="action")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the message message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Whether user has bad karma user_bad_karma: bool = dc_field(metadata=dc_config(field_name="user_bad_karma")) # Karma of the user user_karma: float = dc_field(metadata=dc_config(field_name="user_karma")) # Word that was blocked blocked_word: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocked_word") ) # Name of the blocklist blocklist_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_name") ) # User who moderated the message moderated_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderated_by") ) # Response from AI moderation ai_moderation_response: "Optional[ModerationResponse]" = dc_field( default=None, metadata=dc_config(field_name="ai_moderation_response") ) # Sets thresholds for AI moderation moderation_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="moderation_thresholds") ) @dataclass class MessageNewEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The number of watchers watcher_count: int = dc_field(metadata=dc_config(field_name="watcher_count")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.new" in this case type: str = dc_field(default="message.new", metadata=dc_config(field_name="type")) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The author of the parent message parent_author: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_author") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) total_unread_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_unread_count") ) unread_channels: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_channels") ) # The number of unread messages unread_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_count") ) # The participants of the thread thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) grouped_unread_channels: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="grouped_unread_channels") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageOptions(DataClassJsonMixin): include_thread_participants: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_thread_participants") ) member_custom_include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_custom_include") ) @dataclass class MessagePaginationParams(DataClassJsonMixin): # The timestamp to get messages with a created_at timestamp greater than created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The timestamp to get messages with a created_at timestamp greater than or equal to created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The result will be a set of messages, that are both older and newer than the created_at timestamp provided, distributed evenly around the timestamp created_at_around: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_around", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The timestamp to get messages with a created_at timestamp smaller than created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The timestamp to get messages with a created_at timestamp smaller than or equal to created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The result will be a set of messages, that are both older and newer than the message with the provided ID, and the message with the ID provided will be in the middle of the set id_around: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_around") ) # The ID of the message to get messages with a timestamp greater than id_gt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_gt") ) # The ID of the message to get messages with a timestamp greater than or equal to id_gte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_gte") ) # The ID of the message to get messages with a timestamp smaller than id_lt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_lt") ) # The ID of the message to get messages with a timestamp smaller than or equal to id_lte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_lte") ) # The maximum number of messages to return (max limit limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) @dataclass class MessageReadEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "message.read" in this case type: str = dc_field(default="message.read", metadata=dc_config(field_name="type")) # The ID of the channel where the message was read channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was read channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was read cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the last read message last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageRequest(DataClassJsonMixin): # Contains HTML markup of the message. Can only be set when using server-side API html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) # Message ID is unique string identifier of the message id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) mentioned_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mentioned_channel") ) mentioned_here: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mentioned_here") ) # Should be empty if `text` is provided. Can only be set when using server-side API mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether message is pinned or not pinned: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pinned") ) # Date when message got pinned pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Identifier of the poll to include in the message poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) # Whether thread reply should be shown in the channel as well show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # Whether message is silent or not silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) # Text of the message. Should be empty if `mml` is provided text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Contains type of the message. One of: regular, system type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of message attachments attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of user group IDs to mention. Group members who are also channel members will receive push notifications. Max 10 groups mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) # Array of user IDs to mention mentioned_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) # A list of user ids that have restricted visibility to the message restricted_visibility: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="restricted_visibility") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) shared_location: "Optional[SharedLocation]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageResponse(DataClassJsonMixin): # Channel unique identifier in : format cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_reply_count: int = dc_field( metadata=dc_config(field_name="deleted_reply_count") ) # Contains HTML markup of the message. Can only be set when using server-side API html: str = dc_field(metadata=dc_config(field_name="html")) # Message ID is unique string identifier of the message id: str = dc_field(metadata=dc_config(field_name="id")) # Whether the message mentioned the channel tag mentioned_channel: bool = dc_field( metadata=dc_config(field_name="mentioned_channel") ) # Whether the message mentioned online users with @here tag mentioned_here: bool = dc_field(metadata=dc_config(field_name="mentioned_here")) # Whether message is pinned or not pinned: bool = dc_field(metadata=dc_config(field_name="pinned")) # Number of replies to this message reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) # Whether the message was shadowed or not shadowed: bool = dc_field(metadata=dc_config(field_name="shadowed")) # Whether message is silent or not silent: bool = dc_field(metadata=dc_config(field_name="silent")) # Text of the message. Should be empty if `mml` is provided text: str = dc_field(metadata=dc_config(field_name="text")) # Contains type of the message. One of: regular, ephemeral, error, reply, system, deleted type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Array of message attachments attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) # List of 10 latest reactions to this message latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # List of mentioned users mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) # List of 10 latest reactions of authenticated user to this message own_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list restricted_visibility: List[str] = dc_field( metadata=dc_config(field_name="restricted_visibility") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int) reaction_counts: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_counts") ) # An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int) reaction_scores: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_scores") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Contains provided slash command command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) # Date/time of deletion deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Should be empty if `text` is provided. Can only be set when using server-side API mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date when message got pinned pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Identifier of the poll to include in the message poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) # Whether thread reply should be shown in the channel as well show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # List of user group IDs mentioned in the message. Group members who are also channel members will receive push notifications based on their push preferences. Max 10 groups mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) # List of mentioned user group objects. mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) # List of roles mentioned in the message (e.g. admin, channel_moderator, custom roles). Members with matching roles will receive push notifications based on their push preferences. Max 10 roles mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) # List of users who participate in thread thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) # Object with translations. Key `language` contains the original language key. Other keys contain translations i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) # Contains image moderation information image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) # Channel member data for the users mentioned in the message, keyed by user id. Only present when the app has member custom on mentioned users enabled, and only for the first two mentioned users of each message mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class MessageStatsResponse(DataClassJsonMixin): count_over_time: "Optional[List[CountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) @dataclass class MessageUnblockedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.unblocked" in this case type: str = dc_field( default="message.unblocked", metadata=dc_config(field_name="type") ) # The CID of the channel where the message was unblocked cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageUndeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.undeleted" in this case type: str = dc_field( default="message.undeleted", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) @dataclass class MessageUpdate(DataClassJsonMixin): old_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="old_text") ) change_set: "Optional[MessageChangeSet]" = dc_field( default=None, metadata=dc_config(field_name="change_set") ) @dataclass class MessageUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "message.updated" in this case type: str = dc_field( default="message.updated", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) message_update: "Optional[MessageUpdate]" = dc_field( default=None, metadata=dc_config(field_name="message_update") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageWithChannelResponse(DataClassJsonMixin): # Channel unique identifier in : format cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_reply_count: int = dc_field( metadata=dc_config(field_name="deleted_reply_count") ) # Contains HTML markup of the message. Can only be set when using server-side API html: str = dc_field(metadata=dc_config(field_name="html")) # Message ID is unique string identifier of the message id: str = dc_field(metadata=dc_config(field_name="id")) # Whether the message mentioned the channel tag mentioned_channel: bool = dc_field( metadata=dc_config(field_name="mentioned_channel") ) # Whether the message mentioned online users with @here tag mentioned_here: bool = dc_field(metadata=dc_config(field_name="mentioned_here")) # Whether message is pinned or not pinned: bool = dc_field(metadata=dc_config(field_name="pinned")) # Number of replies to this message reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) # Whether the message was shadowed or not shadowed: bool = dc_field(metadata=dc_config(field_name="shadowed")) # Whether message is silent or not silent: bool = dc_field(metadata=dc_config(field_name="silent")) # Text of the message. Should be empty if `mml` is provided text: str = dc_field(metadata=dc_config(field_name="text")) # Contains type of the message. One of: regular, ephemeral, error, reply, system, deleted type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Array of message attachments attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) # List of 10 latest reactions to this message latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # List of mentioned users mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) # List of 10 latest reactions of authenticated user to this message own_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # A list of user ids that have restricted visibility to the message, if the list is not empty, the message is only visible to the users in the list restricted_visibility: List[str] = dc_field( metadata=dc_config(field_name="restricted_visibility") ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # An object containing number of reactions of each type. Key: reaction type (string), value: number of reactions (int) reaction_counts: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_counts") ) # An object containing scores of reactions of each type. Key: reaction type (string), value: total score of reactions (int) reaction_scores: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_scores") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Contains provided slash command command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) # Date/time of deletion deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Should be empty if `text` is provided. Can only be set when using server-side API mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date when message got pinned pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Identifier of the poll to include in the message poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) # Whether thread reply should be shown in the channel as well show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # List of user group IDs mentioned in the message. Group members who are also channel members will receive push notifications based on their push preferences. Max 10 groups mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) # List of mentioned user group objects. mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) # List of roles mentioned in the message (e.g. admin, channel_moderator, custom roles). Members with matching roles will receive push notifications based on their push preferences. Max 10 roles mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) # List of users who participate in thread thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) # Object with translations. Key `language` contains the original language key. Other keys contain translations i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) # Contains image moderation information image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) # Channel member data for the users mentioned in the message, keyed by user id. Only present when the app has member custom on mentioned users enabled, and only for the first two mentioned users of each message mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class MetricDescriptor(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) unit: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="unit")) @dataclass class MetricStats(DataClassJsonMixin): # Aggregated total value total: int = dc_field(metadata=dc_config(field_name="total")) # Per-day values (only present in daily mode) daily: "Optional[List[DailyValue]]" = dc_field( default=None, metadata=dc_config(field_name="daily") ) @dataclass class MetricThreshold(DataClassJsonMixin): level: str = dc_field(metadata=dc_config(field_name="level")) operator: str = dc_field(metadata=dc_config(field_name="operator")) value: float = dc_field(metadata=dc_config(field_name="value")) value_unit: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="value_unit") ) window_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="window_seconds") ) @dataclass class MetricTimeSeries(DataClassJsonMixin): data_points: "Optional[List[List[float]]]" = dc_field( default=None, metadata=dc_config(field_name="data_points") ) @dataclass class MetricsPct(DataClassJsonMixin): freezes: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="freezes") ) geo: Optional[float] = dc_field(default=None, metadata=dc_config(field_name="geo")) jitter: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="jitter") ) latency: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latency") ) quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="quality_score") ) ModerationActionType = NewType("ModerationActionType", str) class ModerationAction: BOUNCE: Final[ModerationActionType] = "bounce" BOUNCE_FLAG: Final[ModerationActionType] = "bounce_flag" BOUNCE_REMOVE: Final[ModerationActionType] = "bounce_remove" FLAG: Final[ModerationActionType] = "flag" REMOVE: Final[ModerationActionType] = "remove" SHADOW: Final[ModerationActionType] = "shadow" @dataclass class ModerationActionConfigResponse(DataClassJsonMixin): # The action to take action: str = dc_field(metadata=dc_config(field_name="action")) # Description of what this action does description: str = dc_field(metadata=dc_config(field_name="description")) # Type of entity this action applies to entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # Icon for the dashboard icon: str = dc_field(metadata=dc_config(field_name="icon")) # Display order (lower numbers shown first) order: int = dc_field(metadata=dc_config(field_name="order")) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Queue type this action config belongs to queue_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="queue_type") ) # Custom data for the action custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ModerationAnalysisFailedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field( default="moderation.analysis.failed", metadata=dc_config(field_name="type") ) # The moderation policy key the request targeted. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Echo of the `entity_creator_id` on the /analyze request. entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Echo of the `entity_id` on the /analyze request. entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Echo of the `entity_type` on the /analyze request. entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Echo of the request's `content_ids`, keyed by text/image label. On keyframe and caption streams every request repeats the same entity_type/entity_id/entity_creator_id, so this is what identifies the specific submission that went unscreened. content_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="content_ids") ) # Echo of the `custom` metadata on the /analyze request. custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ModerationBanResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class ModerationCallResponse(DataClassJsonMixin): backstage: bool = dc_field(metadata=dc_config(field_name="backstage")) captioning: bool = dc_field(metadata=dc_config(field_name="captioning")) cid: str = dc_field(metadata=dc_config(field_name="cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) current_session_id: str = dc_field( metadata=dc_config(field_name="current_session_id") ) id: str = dc_field(metadata=dc_config(field_name="id")) recording: bool = dc_field(metadata=dc_config(field_name="recording")) transcribing: bool = dc_field(metadata=dc_config(field_name="transcribing")) translating: bool = dc_field(metadata=dc_config(field_name="translating")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) routing_number: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="routing_number") ) starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class ModerationCheckCompletedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of entity which was moderated entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # The type of the entity which was moderated entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # The recommended action recommended_action: str = dc_field( metadata=dc_config(field_name="recommended_action") ) # The review queue item ID review_queue_item_id: str = dc_field( metadata=dc_config(field_name="review_queue_item_id") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="moderation_check.completed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ModerationConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) key: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="key")) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) supported_video_call_harm_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="supported_video_call_harm_types") ) ai_image_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_config") ) ai_image_lite_config: "Optional[BodyguardImageAnalysisConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_lite_config") ) ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) ai_video_config: "Optional[AIVideoConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( dc_field( default=None, metadata=dc_config(field_name="automod_semantic_filters_config"), ) ) automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) flood_config: "Optional[FloodConfig]" = dc_field( default=None, metadata=dc_config(field_name="flood_config") ) google_vision_config: "Optional[GoogleVisionConfig]" = dc_field( default=None, metadata=dc_config(field_name="google_vision_config") ) llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @dataclass class ModerationCustomActionEvent(DataClassJsonMixin): # The ID of the custom action that was executed action_id: str = dc_field(metadata=dc_config(field_name="action_id")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) review_queue_item: "ReviewQueueItemResponse" = dc_field( metadata=dc_config(field_name="review_queue_item") ) type: str = dc_field( default="moderation.custom_action", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Additional options passed to the custom action action_options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="action_options") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class ModerationDashboardPreferences(DataClassJsonMixin): async_review_queue_upsert: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async_review_queue_upsert") ) block_foreign_cdn_attachments: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="block_foreign_cdn_attachments") ) custom_views_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_views_enabled") ) disable_action_logs: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_action_logs") ) disable_audit_logs: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_audit_logs") ) disable_flagging_reviewed_entity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_flagging_reviewed_entity") ) enforce_shadow_server_side: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_shadow_server_side") ) escalation_queue_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="escalation_queue_enabled") ) flag_user_on_flagged_content: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="flag_user_on_flagged_content") ) include_attachment_payload: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_attachment_payload") ) media_queue_blur_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="media_queue_blur_enabled") ) text_redaction_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="text_redaction_enabled") ) allowed_moderation_action_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_moderation_action_reasons") ) escalation_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="escalation_reasons") ) filterable_custom_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filterable_custom_keys") ) keyframe_classifications_map: "Optional[Dict[str, Dict[str, bool]]]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_classifications_map") ) media_label_display: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="media_label_display") ) overview_dashboard: "Optional[OverviewDashboardConfig]" = dc_field( default=None, metadata=dc_config(field_name="overview_dashboard") ) @dataclass class ModerationEngineConfigRequest(DataClassJsonMixin): # LLM model used when the provider resolves to llm. Not allowed with provider nlp. Empty uses the app's moderation settings model: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="model") ) # llm or nlp. Empty follows the app's LLM moderation setting provider: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="provider") ) @dataclass class ModerationEngineConfigResponse(DataClassJsonMixin): # LLM model used when the provider resolves to llm. Not allowed with provider nlp. Empty uses the app's moderation settings model: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="model") ) # llm or nlp. Empty follows the app's LLM moderation setting provider: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="provider") ) @dataclass class ModerationFeedbackItemResponse(DataClassJsonMixin): # When the item was submitted; all items of one submission share it created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Feedback item ID id: str = dc_field(metadata=dc_config(field_name="id")) # false_positive or false_negative kind: str = dc_field(metadata=dc_config(field_name="kind")) # Bodyguard's ID for the delivered feedback bodyguard_feedback_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bodyguard_feedback_id") ) # When Bodyguard accepted the feedback; unset if not sent bodyguard_sent_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="bodyguard_sent_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Channel of a single-message feedback channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # Moderator's confidence confidence: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) # Action the content had current_recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_recommended_action") ) # Moderator's description description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # ID of the moderated entity entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the moderated entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Action the moderator expected expected_recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expected_recommended_action") ) # Flag the feedback disputes flag_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="flag_id") ) # Image content of the item image_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image_url") ) # Publish time of a single-message feedback published_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="published_at") ) # Which content of the entity the item is about reference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reference") ) # Moderator who submitted the feedback reporter_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reporter_id") ) # Review queue item the feedback is about review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Text content of the item text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Labels the content had current_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="current_labels") ) # Labels the moderator expected expected_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="expected_labels") ) @dataclass class ModerationFeedbackSubmissionResponse(DataClassJsonMixin): # When the submission was made created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Number of items in the submission, matching the filter or not item_count: int = dc_field(metadata=dc_config(field_name="item_count")) # Number of items in the submission that match the filter, including those left out by item_limit matched_count: int = dc_field(metadata=dc_config(field_name="matched_count")) # Number of items in the submission that Bodyguard accepted sent_count: int = dc_field(metadata=dc_config(field_name="sent_count")) # The submission's items that match the filter items: "List[ModerationFeedbackItemResponse]" = dc_field( metadata=dc_config(field_name="items") ) # ID of the moderated entity entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the moderated entity entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Moderator who submitted the feedback reporter_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reporter_id") ) # Review queue item the feedback is about review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Distinct labels the submission's items had current_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="current_labels") ) # Distinct labels the moderator expected across the submission's items expected_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="expected_labels") ) @dataclass class ModerationFlagResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) result: "List[Dict[str, object]]" = dc_field( metadata=dc_config(field_name="result") ) content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Unique identifier of the flag id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Content payload for moderation moderation_payload: "Optional[ModerationPayloadResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ModerationFlaggedEvent(DataClassJsonMixin): # The type of content that was flagged content_type: str = dc_field(metadata=dc_config(field_name="content_type")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the flagged content object_id: str = dc_field(metadata=dc_config(field_name="object_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="moderation.flagged", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ModerationImageAnalysisCompleteEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field( default="moderation.image_analysis.complete", metadata=dc_config(field_name="type"), ) # The moderation policy key that was applied. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Echo of the `entity_creator_id` on the /analyze request. entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Echo of the `entity_id` on the /analyze request. entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Echo of the `entity_type` on the /analyze request. entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Review queue row ID for deep-linking into the dashboard. review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Echo of the `custom` metadata on the /analyze request. custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Per-image verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`. images: "Optional[Dict[str, AnalyzeImageField]]" = dc_field( default=None, metadata=dc_config(field_name="images") ) # Per-text-field verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`. texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @dataclass class ModerationMarkReviewedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) item: "ReviewQueueItemResponse" = dc_field(metadata=dc_config(field_name="item")) type: str = dc_field( default="moderation.mark_reviewed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class ModerationPayload(DataClassJsonMixin): country_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_code") ) audios: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="audios") ) country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) image_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_ordered_keys") ) images: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="images") ) other_media: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="other_media") ) text_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_ordered_keys") ) texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) image_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="image_ids") ) text_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="text_ids") ) @dataclass class ModerationPayloadRequest(DataClassJsonMixin): # Audio URLs to moderate audios: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="audios") ) # Image URLs to moderate (max 30) images: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="images") ) # Text content to moderate texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) # Video URLs to moderate videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) # Custom data for moderation custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ModerationPayloadResponse(DataClassJsonMixin): # Audio URLs to moderate audios: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="audios") ) # Caller-supplied keys for images, index-aligned with images[] image_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_ordered_keys") ) # Image URLs to moderate images: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="images") ) # Media URLs from attachments outside the typed image/video/audio lists (custom attachment types such as GIF pickers) other_media: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="other_media") ) # Caller-supplied keys for texts (e.g. "title", "description"), index-aligned with texts[] text_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_ordered_keys") ) # Text content to moderate texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) # Video URLs to moderate videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) # Custom data for moderation custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Caller-supplied content IDs per image key (from content_ids on /analyze) image_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="image_ids") ) # Caller-supplied content IDs per text key (from content_ids on /analyze) text_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="text_ids") ) @dataclass class ModerationQueueResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by: str = dc_field(metadata=dc_config(field_name="created_by")) description: str = dc_field(metadata=dc_config(field_name="description")) id: str = dc_field(metadata=dc_config(field_name="id")) item_count: int = dc_field(metadata=dc_config(field_name="item_count")) name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) sort: "List[Dict[str, object]]" = dc_field(metadata=dc_config(field_name="sort")) filters: Dict[str, object] = dc_field(metadata=dc_config(field_name="filters")) @dataclass class ModerationResponse(DataClassJsonMixin): # Action taken by automod action: str = dc_field(metadata=dc_config(field_name="action")) # Explicit score explicit: float = dc_field(metadata=dc_config(field_name="explicit")) # Spam score spam: float = dc_field(metadata=dc_config(field_name="spam")) # Toxicity score toxic: float = dc_field(metadata=dc_config(field_name="toxic")) @dataclass class ModerationRuleInfo(DataClassJsonMixin): description: str = dc_field(metadata=dc_config(field_name="description")) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) @dataclass class ModerationRuleV2Response(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) description: str = dc_field(metadata=dc_config(field_name="description")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) rule_type: str = dc_field(metadata=dc_config(field_name="rule_type")) team: str = dc_field(metadata=dc_config(field_name="team")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) config_keys: List[str] = dc_field(metadata=dc_config(field_name="config_keys")) cooldown_period: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) logic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="logic") ) action_sequences: "Optional[List[CallRuleActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) @dataclass class ModerationRulesTriggeredEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the entity that triggered the rule entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # The type of the entity (call, user, message, etc.) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # The ID of the user who triggered the rule user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Array of action types that were triggered triggered_actions: List[str] = dc_field( metadata=dc_config(field_name="triggered_actions") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) rule: "ModerationRuleInfo" = dc_field(metadata=dc_config(field_name="rule")) type: str = dc_field( default="moderation_rule.triggered", metadata=dc_config(field_name="type") ) # Application ID the rule belongs to. app_id: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="app_id") ) # The `category` sent on the labels request. Omitted when the event was not produced by the labels API. category: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="category") ) # CID of the channel the moderated content belongs to. Omitted when the content has no channel. channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The review queue item ID if applicable review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Highest severity (`LOW` / `MEDIUM` / `HIGH` / `CRITICAL`) among the moderation results that carried a matched label. Omitted when no label matched or the provider reports no severity. severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) # Configured count that fires the condition. This is the number stored on the rule, not the live counter. threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) # Configured window of the condition that fired, for example 10m. time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) # The violation number for call rules (optional) violation_number: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="violation_number") ) # Ordered list of contents whose verdicts contributed to an aggregation rule's threshold. Populated only for aggregation rules when callers supplied `content_ids`. matched_contents: "Optional[List[MatchedContent]]" = dc_field( default=None, metadata=dc_config(field_name="matched_contents") ) # Harm labels on the moderated content that the rule's text label conditions (`text_content`, `text_rule`) matched. Omitted when the rule has no such condition. matched_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="matched_labels") ) # Cross-user webhook_only flood rules only: the distinct users who sent the content since the previous webhook for this rule. Omitted on other events. matched_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="matched_user_ids") ) # The rule's config_keys. Omitted when the rule is application-wide. scope: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="scope") ) app_count: "Optional[AppCountInfo]" = dc_field( default=None, metadata=dc_config(field_name="app_count") ) intent: "Optional[IntentEvaluationInfo]" = dc_field( default=None, metadata=dc_config(field_name="intent") ) @dataclass class ModerationTextAnalysisCompleteEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field( default="moderation.text_analysis.complete", metadata=dc_config(field_name="type"), ) # The moderation policy key that was applied. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Echo of the `entity_creator_id` on the /analyze request. entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # Echo of the `entity_id` on the /analyze request. entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Echo of the `entity_type` on the /analyze request. entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Review queue row ID for deep-linking into the dashboard. review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Echo of the `custom` metadata on the /analyze request. custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Per-text-field verdicts, same shape as the /analyze HTTP response. Each entry carries `id` when the request supplied `content_ids`. texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @dataclass class ModerationV2Response(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) original_text: str = dc_field(metadata=dc_config(field_name="original_text")) blocklist_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_matched") ) platform_circumvented: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="platform_circumvented") ) semantic_filter_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_matched") ) blocklists_matched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklists_matched") ) image_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_harms") ) text_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_harms") ) @dataclass class MuteChannelRequest(DataClassJsonMixin): # Duration of mute in milliseconds expiration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="expiration") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Channel CIDs to mute (if multiple channels) channel_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_cids") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MuteChannelResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with mutes (if multiple channels were muted) channel_mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="channel_mutes") ) channel_mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="channel_mute") ) own_user: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_user") ) @dataclass class MuteRequest(DataClassJsonMixin): # User IDs to mute (if multiple users) target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) # Duration of mute in minutes timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MuteResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with mutes (if multiple users were muted) mutes: "Optional[List[UserMuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mutes") ) # A list of users that can't be found. Common cause for this is deleted users non_existing_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="non_existing_users") ) own_user: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_user") ) @dataclass class MuteUsersRequest(DataClassJsonMixin): audio: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio") ) mute_all_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mute_all_users") ) muted_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="muted_by_id") ) screenshare: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="screenshare") ) screenshare_audio: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="screenshare_audio") ) video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="video") ) user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_ids") ) # User request object muted_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="muted_by") ) @dataclass class MuteUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class NetworkMetricsReportResponse(DataClassJsonMixin): average_connection_time: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_connection_time") ) average_jitter: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_jitter") ) average_latency: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_latency") ) average_time_to_reconnect: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_time_to_reconnect") ) @dataclass class NoiseCancellationSettings(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) @dataclass class NotificationComment(DataClassJsonMixin): # The text of the comment comment: str = dc_field(metadata=dc_config(field_name="comment")) # The ID of the comment id: str = dc_field(metadata=dc_config(field_name="id")) # The ID of the user who wrote the comment user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # The ID of the parent comment when this comment is a reply; omitted for top-level comments parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Attachments on the comment attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @dataclass class NotificationConfig(DataClassJsonMixin): # Time window for deduplicating notification activities (reactions and follows). Empty or '0' = always deduplicate (default). Examples: '1h', '24h', '7d', '1w' deduplication_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="deduplication_window") ) # Whether to track read status track_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_read") ) # Whether to track seen status track_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_seen") ) @dataclass class NotificationContext(DataClassJsonMixin): target: "Optional[NotificationTarget]" = dc_field( default=None, metadata=dc_config(field_name="target") ) trigger: "Optional[NotificationTrigger]" = dc_field( default=None, metadata=dc_config(field_name="trigger") ) @dataclass class NotificationFeedUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the feed fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.notification_feed.updated" in this case type: str = dc_field( default="feeds.notification_feed.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Aggregated activities for notification feeds aggregated_activities: "Optional[List[AggregatedActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="aggregated_activities") ) notification_status: "Optional[NotificationStatusResponse]" = dc_field( default=None, metadata=dc_config(field_name="notification_status") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class NotificationMarkUnreadEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "notification.mark_unread" in this case type: str = dc_field( default="notification.mark_unread", metadata=dc_config(field_name="type") ) # The ID of the channel which was marked as unread channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel which was marked as unread channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was marked as unread cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the first unread message first_unread_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="first_unread_message_id") ) # The time when the channel/thread was marked as unread last_read_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_read_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The ID of the last read message last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The ID of the thread which was marked as unread thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) # The total number of unread messages total_unread_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_unread_count") ) # The number of channels with unread messages unread_channels: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_channels") ) # The total number of unread messages unread_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_count") ) # The number of unread messages in the channel/thread after first_unread_message_id unread_messages: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_messages") ) # The total number of unread messages in the threads unread_thread_messages: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_thread_messages") ) # The number of unread threads unread_threads: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_threads") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) grouped_unread_channels: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="grouped_unread_channels") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class NotificationParentActivity(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @dataclass class NotificationSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) call_live_started: "EventNotificationSettings" = dc_field( metadata=dc_config(field_name="call_live_started") ) call_missed: "EventNotificationSettings" = dc_field( metadata=dc_config(field_name="call_missed") ) call_notification: "EventNotificationSettings" = dc_field( metadata=dc_config(field_name="call_notification") ) call_ring: "EventNotificationSettings" = dc_field( metadata=dc_config(field_name="call_ring") ) session_started: "EventNotificationSettings" = dc_field( metadata=dc_config(field_name="session_started") ) @dataclass class NotificationSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) call_live_started: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_live_started") ) call_missed: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_missed") ) call_notification: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_notification") ) call_ring: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_ring") ) session_started: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="session_started") ) @dataclass class NotificationSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) call_live_started: "EventNotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="call_live_started") ) call_missed: "EventNotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="call_missed") ) call_notification: "EventNotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="call_notification") ) call_ring: "EventNotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="call_ring") ) session_started: "EventNotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="session_started") ) @dataclass class NotificationStatusResponse(DataClassJsonMixin): # Number of unread notifications unread: int = dc_field(metadata=dc_config(field_name="unread")) # Number of unseen notifications unseen: int = dc_field(metadata=dc_config(field_name="unseen")) # When notifications were last read last_read_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_read_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When notifications were last seen last_seen_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_seen_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Deprecated: use is_read on each activity/group instead. IDs of activities that have been read. Capped at ~101 entries for aggregated feeds. read_activities: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="read_activities") ) # Deprecated: use is_seen on each activity/group instead. IDs of activities that have been seen. Capped at ~101 entries for aggregated feeds. seen_activities: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="seen_activities") ) @dataclass class NotificationTarget(DataClassJsonMixin): # The ID of the target (activity ID or user ID) id: str = dc_field(metadata=dc_config(field_name="id")) # The name of the target user (for user targets like follows) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # The text content of the target activity (for activity targets) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # The type of the target activity (for activity targets) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # The ID of the user who created the target activity (for activity targets) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Attachments on the target activity (for activity targets) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) comment: "Optional[NotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data from the target activity custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) parent_activity: "Optional[NotificationParentActivity]" = dc_field( default=None, metadata=dc_config(field_name="parent_activity") ) @dataclass class NotificationThreadMessageNewEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The ID of the thread thread_id: str = dc_field(metadata=dc_config(field_name="thread_id")) # The number of watchers watcher_count: int = dc_field(metadata=dc_config(field_name="watcher_count")) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "notification.message_new" in this case type: str = dc_field( default="notification.thread_message_new", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the message was sent channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the message was sent cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) parent_author: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_author") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) unread_thread_messages: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_thread_messages") ) unread_threads: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_threads") ) # The participants of the thread thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) @dataclass class NotificationTrigger(DataClassJsonMixin): # Human-readable text describing the notification text: str = dc_field(metadata=dc_config(field_name="text")) # The type of notification (mention, reaction, comment, follow, etc.) type: str = dc_field(metadata=dc_config(field_name="type")) comment: "Optional[NotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data from the trigger object (comment, reaction, etc.) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class OCRContentParameters(DataClassJsonMixin): label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class OCRRule(DataClassJsonMixin): # What a moderation rule does when it matches. action: "ModerationAction" = dc_field(metadata=dc_config(field_name="action")) label: str = dc_field(metadata=dc_config(field_name="label")) @dataclass class OnlyUserID(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) @dataclass class OverviewDashboardConfig(DataClassJsonMixin): default_date_range_days: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="default_date_range_days") ) visible_charts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="visible_charts") ) @dataclass class OwnBatchRequest(DataClassJsonMixin): # List of feed IDs to get own fields for feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Optional list of specific fields to return. If not specified, all fields (own_follows, own_followings, own_capabilities, own_membership) are returned fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="fields") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class OwnBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Map of feed ID to own fields data data: "Dict[str, FeedOwnData]" = dc_field(metadata=dc_config(field_name="data")) OwnCapabilityType = NewType("OwnCapabilityType", str) class OwnCapability: BLOCK_USERS: Final[OwnCapabilityType] = "block-users" CHANGE_MAX_DURATION: Final[OwnCapabilityType] = "change-max-duration" CREATE_CALL: Final[OwnCapabilityType] = "create-call" CREATE_REACTION: Final[OwnCapabilityType] = "create-reaction" ENABLE_NOISE_CANCELLATION: Final[OwnCapabilityType] = "enable-noise-cancellation" END_CALL: Final[OwnCapabilityType] = "end-call" JOIN_BACKSTAGE: Final[OwnCapabilityType] = "join-backstage" JOIN_CALL: Final[OwnCapabilityType] = "join-call" JOIN_ENDED_CALL: Final[OwnCapabilityType] = "join-ended-call" KICK_USER: Final[OwnCapabilityType] = "kick-user" MUTE_USERS: Final[OwnCapabilityType] = "mute-users" PIN_FOR_EVERYONE: Final[OwnCapabilityType] = "pin-for-everyone" READ_CALL: Final[OwnCapabilityType] = "read-call" REMOVE_CALL_MEMBER: Final[OwnCapabilityType] = "remove-call-member" SCREENSHARE: Final[OwnCapabilityType] = "screenshare" SEND_AUDIO: Final[OwnCapabilityType] = "send-audio" SEND_CLOSED_CAPTIONS_CALL: Final[OwnCapabilityType] = "send-closed-captions-call" SEND_VIDEO: Final[OwnCapabilityType] = "send-video" START_BROADCAST_CALL: Final[OwnCapabilityType] = "start-broadcast-call" START_CLOSED_CAPTIONS_CALL: Final[OwnCapabilityType] = "start-closed-captions-call" START_FRAME_RECORD_CALL: Final[OwnCapabilityType] = "start-frame-record-call" START_INDIVIDUAL_RECORD_CALL: Final[OwnCapabilityType] = ( "start-individual-record-call" ) START_RAW_RECORD_CALL: Final[OwnCapabilityType] = "start-raw-record-call" START_RECORD_CALL: Final[OwnCapabilityType] = "start-record-call" START_TRANSCRIPTION_CALL: Final[OwnCapabilityType] = "start-transcription-call" STOP_BROADCAST_CALL: Final[OwnCapabilityType] = "stop-broadcast-call" STOP_CLOSED_CAPTIONS_CALL: Final[OwnCapabilityType] = "stop-closed-captions-call" STOP_FRAME_RECORD_CALL: Final[OwnCapabilityType] = "stop-frame-record-call" STOP_INDIVIDUAL_RECORD_CALL: Final[OwnCapabilityType] = ( "stop-individual-record-call" ) STOP_RAW_RECORD_CALL: Final[OwnCapabilityType] = "stop-raw-record-call" STOP_RECORD_CALL: Final[OwnCapabilityType] = "stop-record-call" STOP_TRANSCRIPTION_CALL: Final[OwnCapabilityType] = "stop-transcription-call" UPDATE_CALL: Final[OwnCapabilityType] = "update-call" UPDATE_CALL_MEMBER: Final[OwnCapabilityType] = "update-call-member" UPDATE_CALL_PERMISSIONS: Final[OwnCapabilityType] = "update-call-permissions" UPDATE_CALL_SETTINGS: Final[OwnCapabilityType] = "update-call-settings" @dataclass class OwnUserResponse(DataClassJsonMixin): banned: bool = dc_field(metadata=dc_config(field_name="banned")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) invisible: bool = dc_field(metadata=dc_config(field_name="invisible")) language: str = dc_field(metadata=dc_config(field_name="language")) online: bool = dc_field(metadata=dc_config(field_name="online")) role: str = dc_field(metadata=dc_config(field_name="role")) total_unread_count: int = dc_field( metadata=dc_config(field_name="total_unread_count") ) unread_channels: int = dc_field(metadata=dc_config(field_name="unread_channels")) # Deprecated: Use total_unread_count instead. # Deprecated unread_count: int = dc_field(metadata=dc_config(field_name="unread_count")) unread_threads: int = dc_field(metadata=dc_config(field_name="unread_threads")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) channel_mutes: "List[ChannelMute]" = dc_field( metadata=dc_config(field_name="channel_mutes") ) devices: "List[DeviceResponse]" = dc_field(metadata=dc_config(field_name="devices")) mutes: "List[UserMuteResponse]" = dc_field(metadata=dc_config(field_name="mutes")) teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) latest_hidden_channels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="latest_hidden_channels") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) # The push preference details. push_preferences: "Optional[PushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) total_unread_count_by_team: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="total_unread_count_by_team") ) @dataclass class PagerDefaults(DataClassJsonMixin): # Number of records returned when `limit` is omitted. limit: int = dc_field(metadata=dc_config(field_name="limit")) @dataclass class PagerRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class PagerResponse(DataClassJsonMixin): next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class PaginationParams(DataClassJsonMixin): id_gt: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="id_gt") ) id_gte: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="id_gte") ) id_lt: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="id_lt") ) id_lte: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="id_lte") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) @dataclass class ParsedPredefinedFilterResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class ParticipantCountByMinuteResponse(DataClassJsonMixin): first: int = dc_field(metadata=dc_config(field_name="first")) last: int = dc_field(metadata=dc_config(field_name="last")) max: int = dc_field(metadata=dc_config(field_name="max")) min: int = dc_field(metadata=dc_config(field_name="min")) start_ts: datetime = dc_field( metadata=dc_config( field_name="start_ts", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) @dataclass class ParticipantCountOverTimeResponse(DataClassJsonMixin): by_minute: "Optional[List[ParticipantCountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_minute") ) @dataclass class ParticipantReportResponse(DataClassJsonMixin): sum: int = dc_field(metadata=dc_config(field_name="sum")) unique: int = dc_field(metadata=dc_config(field_name="unique")) max_concurrent: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_concurrent") ) by_browser: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_browser") ) by_country: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_country") ) by_device: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_device") ) by_operating_system: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_operating_system") ) count_over_time: "Optional[ParticipantCountOverTimeResponse]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) publishers: "Optional[PublisherStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) subscribers: "Optional[SubscriberStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @dataclass class ParticipantSeriesPublisherStats(DataClassJsonMixin): global_metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="global_metrics_order") ) _global: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="global") ) global_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="global_meta") ) global_thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="global_thresholds") ) tracks: "Optional[Dict[str, List[ParticipantSeriesTrackMetrics]]]" = dc_field( default=None, metadata=dc_config(field_name="tracks") ) @dataclass class ParticipantSeriesSubscriberStats(DataClassJsonMixin): global_metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="global_metrics_order") ) subscriptions: "Optional[List[ParticipantSeriesSubscriptionTrackMetrics]]" = ( dc_field(default=None, metadata=dc_config(field_name="subscriptions")) ) _global: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="global") ) global_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="global_meta") ) global_thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="global_thresholds") ) @dataclass class ParticipantSeriesSubscriptionTrackMetrics(DataClassJsonMixin): publisher_user_id: str = dc_field( metadata=dc_config(field_name="publisher_user_id") ) publisher_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_name") ) publisher_user_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_user_session_id") ) tracks: "Optional[Dict[str, List[ParticipantSeriesTrackMetrics]]]" = dc_field( default=None, metadata=dc_config(field_name="tracks") ) @dataclass class ParticipantSeriesTimeframe(DataClassJsonMixin): max_points: int = dc_field(metadata=dc_config(field_name="max_points")) since: datetime = dc_field( metadata=dc_config( field_name="since", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) step_seconds: int = dc_field(metadata=dc_config(field_name="step_seconds")) until: datetime = dc_field( metadata=dc_config( field_name="until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) @dataclass class ParticipantSeriesTrackMetrics(DataClassJsonMixin): track_id: str = dc_field(metadata=dc_config(field_name="track_id")) codec: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="codec") ) label: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label") ) rid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="rid")) track_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="track_type") ) metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="metrics_order") ) metrics: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) metrics_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="metrics_meta") ) thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="thresholds") ) @dataclass class ParticipantSeriesUserStats(DataClassJsonMixin): metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="metrics_order") ) metrics: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) metrics_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="metrics_meta") ) thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="thresholds") ) @dataclass class ParticipantSessionDetails(DataClassJsonMixin): publisher_type: str = dc_field(metadata=dc_config(field_name="publisher_type")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) roles: List[str] = dc_field(metadata=dc_config(field_name="roles")) duration_in_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="duration_in_seconds") ) joined_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="joined_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) left_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="left_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PendingMessageEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The method used for the pending message method: str = dc_field(metadata=dc_config(field_name="method")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "message.pending" in this case type: str = dc_field( default="message.pending", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Metadata attached to the pending message metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="metadata") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class PendingMessageResponse(DataClassJsonMixin): # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="metadata") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class PerSDKUsageReport(DataClassJsonMixin): total: int = dc_field(metadata=dc_config(field_name="total")) by_version: "Dict[str, int]" = dc_field(metadata=dc_config(field_name="by_version")) @dataclass class Percentiles(DataClassJsonMixin): p50: Optional[float] = dc_field(default=None, metadata=dc_config(field_name="p50")) p95: Optional[float] = dc_field(default=None, metadata=dc_config(field_name="p95")) @dataclass class PerformanceAnalysisResponse(DataClassJsonMixin): analysis_type: str = dc_field(metadata=dc_config(field_name="analysis_type")) score: str = dc_field(metadata=dc_config(field_name="score")) indexed_fields: List[str] = dc_field( metadata=dc_config(field_name="indexed_fields") ) recommendations: List[str] = dc_field( metadata=dc_config(field_name="recommendations") ) unindexed_fields: List[str] = dc_field( metadata=dc_config(field_name="unindexed_fields") ) unindexed_sort_fields: List[str] = dc_field( metadata=dc_config(field_name="unindexed_sort_fields") ) warnings: List[str] = dc_field(metadata=dc_config(field_name="warnings")) last_analyzed: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_analyzed", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) scan_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="scan_type") ) @dataclass class Permission(DataClassJsonMixin): # Action name this permission is for (e.g. SendMessage) action: str = dc_field(metadata=dc_config(field_name="action")) # Whether this is a custom permission or built-in custom: bool = dc_field(metadata=dc_config(field_name="custom")) # Description of the permission description: str = dc_field(metadata=dc_config(field_name="description")) # Unique permission ID id: str = dc_field(metadata=dc_config(field_name="id")) # Level at which permission could be applied (app or channel). One of: app, channel level: str = dc_field(metadata=dc_config(field_name="level")) # Name of the permission name: str = dc_field(metadata=dc_config(field_name="name")) # Whether this permission applies to resource owner or not owner: bool = dc_field(metadata=dc_config(field_name="owner")) # Resource type that defines ownership for this permission's action (e.g. 'Channel' for CreateMessage, 'Message' for UpdateMessage). Identical across all variants of an action; primarily meaningful for owner grants. owner_resource: str = dc_field(metadata=dc_config(field_name="owner_resource")) # Whether this permission applies to teammates (multi-tenancy mode only) same_team: bool = dc_field(metadata=dc_config(field_name="same_team")) # List of tags of the permission tags: List[str] = dc_field(metadata=dc_config(field_name="tags")) # MongoDB style condition which decides whether or not the permission is granted condition: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="condition") ) @dataclass class PermissionRequest(DataClassJsonMixin): # Action name this permission is for (e.g. SendMessage) action: str = dc_field(metadata=dc_config(field_name="action")) # Name of the permission name: str = dc_field(metadata=dc_config(field_name="name")) # MongoDB style condition which decides whether or not the permission is granted condition: Dict[str, object] = dc_field(metadata=dc_config(field_name="condition")) # Description of the permission description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether this permission applies to resource owner or not owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="owner") ) # Whether this permission applies to teammates (multi-tenancy mode only) same_team: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="same_team") ) @dataclass class PermissionRequestEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The list of permissions requested by the user permissions: List[str] = dc_field(metadata=dc_config(field_name="permissions")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.permission_request" in this case type: str = dc_field( default="call.permission_request", metadata=dc_config(field_name="type") ) @dataclass class PinActivityRequest(DataClassJsonMixin): # If true, enriches the activity's current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class PinActivityResponse(DataClassJsonMixin): # When the activity was pinned created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Fully qualified ID of the feed the activity was pinned to feed: str = dc_field(metadata=dc_config(field_name="feed")) # ID of the user who pinned the activity user_id: str = dc_field(metadata=dc_config(field_name="user_id")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class PinRequest(DataClassJsonMixin): # the session ID of the user who pinned the message session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # the user ID of the user who pinned the message user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class PinResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class PlatformDataResponse(DataClassJsonMixin): browser: "BrowserDataResponse" = dc_field(metadata=dc_config(field_name="browser")) device: "DeviceDataResponse" = dc_field(metadata=dc_config(field_name="device")) os: "ClientOSDataResponse" = dc_field(metadata=dc_config(field_name="os")) @dataclass class Policy(DataClassJsonMixin): action: int = dc_field(metadata=dc_config(field_name="action")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) name: str = dc_field(metadata=dc_config(field_name="name")) owner: bool = dc_field(metadata=dc_config(field_name="owner")) priority: int = dc_field(metadata=dc_config(field_name="priority")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) resources: List[str] = dc_field(metadata=dc_config(field_name="resources")) roles: List[str] = dc_field(metadata=dc_config(field_name="roles")) @dataclass class PolicyConfig(DataClassJsonMixin): max_age_hours: int = dc_field(metadata=dc_config(field_name="max_age_hours")) @dataclass class PolicyRequest(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) # User-friendly policy name name: str = dc_field(metadata=dc_config(field_name="name")) # Whether policy applies to resource owner or not owner: bool = dc_field(metadata=dc_config(field_name="owner")) # Policy priority priority: int = dc_field(metadata=dc_config(field_name="priority")) # List of resources to apply policy to resources: List[str] = dc_field(metadata=dc_config(field_name="resources")) # List of roles to apply policy to roles: List[str] = dc_field(metadata=dc_config(field_name="roles")) @dataclass class PolicyTestLabelDrift(DataClassJsonMixin): changed: int = dc_field(metadata=dc_config(field_name="changed")) same: int = dc_field(metadata=dc_config(field_name="same")) @dataclass class PolicyTestResult(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: int = dc_field(metadata=dc_config(field_name="id")) message_text: str = dc_field(metadata=dc_config(field_name="message_text")) row_index: int = dc_field(metadata=dc_config(field_name="row_index")) run_id: str = dc_field(metadata=dc_config(field_name="run_id")) scored: bool = dc_field(metadata=dc_config(field_name="scored")) actual_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="actual_action") ) expected_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expected_action") ) failure_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="failure_reason") ) passed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="passed") ) severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) actual_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="actual_labels") ) expected_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="expected_labels") ) raw_response: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="raw_response") ) @dataclass class PolicyTestRow(DataClassJsonMixin): content_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_type") ) policy: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="policy") ) recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recommended_action") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) @dataclass class PolicyTestRun(DataClassJsonMixin): config_key: str = dc_field(metadata=dc_config(field_name="config_key")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) rows_completed: int = dc_field(metadata=dc_config(field_name="rows_completed")) rows_total: int = dc_field(metadata=dc_config(field_name="rows_total")) set_id: str = dc_field(metadata=dc_config(field_name="set_id")) status: str = dc_field(metadata=dc_config(field_name="status")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) triggered_by: str = dc_field(metadata=dc_config(field_name="triggered_by")) completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) config_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="config_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) error_message: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error_message") ) started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) metrics: "Optional[PolicyTestRunMetrics]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) @dataclass class PolicyTestRunMetrics(DataClassJsonMixin): mode: str = dc_field(metadata=dc_config(field_name="mode")) totals: "PolicyTestTotals" = dc_field(metadata=dc_config(field_name="totals")) by_label: "Optional[Dict[str, PolicyTestLabelDrift]]" = dc_field( default=None, metadata=dc_config(field_name="by_label") ) @dataclass class PolicyTestRunResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Per-row results (only present once the run has finished) results: "Optional[List[PolicyTestResult]]" = dc_field( default=None, metadata=dc_config(field_name="results") ) run: "Optional[PolicyTestRun]" = dc_field( default=None, metadata=dc_config(field_name="run") ) @dataclass class PolicyTestSeedSpec(DataClassJsonMixin): # How many rows to sample, newest first; capped at 1000 limit: int = dc_field(metadata=dc_config(field_name="limit")) # Sample only records carrying any of these labels; empty samples everything labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) @dataclass class PolicyTestSet(DataClassJsonMixin): config_key: str = dc_field(metadata=dc_config(field_name="config_key")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by: str = dc_field(metadata=dc_config(field_name="created_by")) id: str = dc_field(metadata=dc_config(field_name="id")) mode: str = dc_field(metadata=dc_config(field_name="mode")) name: str = dc_field(metadata=dc_config(field_name="name")) row_count: int = dc_field(metadata=dc_config(field_name="row_count")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) rows: "Optional[List[PolicyTestRow]]" = dc_field( default=None, metadata=dc_config(field_name="rows") ) last_run: "Optional[PolicyTestRun]" = dc_field( default=None, metadata=dc_config(field_name="last_run") ) @dataclass class PolicyTestSetListResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of policy test sets for the app sets: "List[PolicyTestSet]" = dc_field(metadata=dc_config(field_name="sets")) @dataclass class PolicyTestSetResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The set's baseline run (earliest completed run); later runs are scored against it. Absent until the first run completes baseline_run_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="baseline_run_id") ) # Retained run history for this set, newest first recent_runs: "Optional[List[PolicyTestRun]]" = dc_field( default=None, metadata=dc_config(field_name="recent_runs") ) set: "Optional[PolicyTestSet]" = dc_field( default=None, metadata=dc_config(field_name="set") ) @dataclass class PolicyTestTotals(DataClassJsonMixin): failed: int = dc_field(metadata=dc_config(field_name="failed")) passed: int = dc_field(metadata=dc_config(field_name="passed")) rows: int = dc_field(metadata=dc_config(field_name="rows")) scored: int = dc_field(metadata=dc_config(field_name="scored")) unscored: int = dc_field(metadata=dc_config(field_name="unscored")) @dataclass class PollClosedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) # The type of event: "poll.closed" in this case type: str = dc_field(default="poll.closed", metadata=dc_config(field_name="type")) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) # The type of event: "poll.deleted" in this case type: str = dc_field(default="poll.deleted", metadata=dc_config(field_name="type")) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollOptionInput(DataClassJsonMixin): text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class PollOptionRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class PollOptionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) poll_option: "PollOptionResponseData" = dc_field( metadata=dc_config(field_name="poll_option") ) @dataclass class PollOptionResponseData(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) text: str = dc_field(metadata=dc_config(field_name="text")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) text_i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="text_i18n") ) @dataclass class PollResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) @dataclass class PollResponseData(DataClassJsonMixin): allow_answers: bool = dc_field(metadata=dc_config(field_name="allow_answers")) allow_user_suggested_options: bool = dc_field( metadata=dc_config(field_name="allow_user_suggested_options") ) answers_count: int = dc_field(metadata=dc_config(field_name="answers_count")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by_id: str = dc_field(metadata=dc_config(field_name="created_by_id")) description: str = dc_field(metadata=dc_config(field_name="description")) enforce_unique_vote: bool = dc_field( metadata=dc_config(field_name="enforce_unique_vote") ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) vote_count: int = dc_field(metadata=dc_config(field_name="vote_count")) # Voting visibility of the poll voting_visibility: "VotingVisibility" = dc_field( metadata=dc_config(field_name="voting_visibility") ) latest_answers: "List[PollVoteResponseData]" = dc_field( metadata=dc_config(field_name="latest_answers") ) options: "List[PollOptionResponseData]" = dc_field( metadata=dc_config(field_name="options") ) own_votes: "List[PollVoteResponseData]" = dc_field( metadata=dc_config(field_name="own_votes") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) latest_votes_by_option: "Dict[str, List[PollVoteResponseData]]" = dc_field( metadata=dc_config(field_name="latest_votes_by_option") ) vote_counts_by_option: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="vote_counts_by_option") ) is_closed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_closed") ) max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) description_i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="description_i18n") ) name_i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="name_i18n") ) @dataclass class PollUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) # The type of event: "poll.updated" in this case type: str = dc_field(default="poll.updated", metadata=dc_config(field_name="type")) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollVoteCastedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) poll_vote: "PollVoteResponseData" = dc_field( metadata=dc_config(field_name="poll_vote") ) # The type of event: "poll.vote_casted" in this case type: str = dc_field( default="poll.vote_casted", metadata=dc_config(field_name="type") ) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollVoteChangedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) poll_vote: "PollVoteResponseData" = dc_field( metadata=dc_config(field_name="poll_vote") ) # The type of event: "poll.vote_changed" in this case type: str = dc_field( default="poll.vote_changed", metadata=dc_config(field_name="type") ) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollVoteRemovedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) poll: "PollResponseData" = dc_field(metadata=dc_config(field_name="poll")) poll_vote: "PollVoteResponseData" = dc_field( metadata=dc_config(field_name="poll_vote") ) # The type of event: "poll.vote_removed" in this case type: str = dc_field( default="poll.vote_removed", metadata=dc_config(field_name="type") ) activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) # The CID of the channel containing the poll cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the message containing the poll message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PollVoteResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) vote: "Optional[PollVoteResponseData]" = dc_field( default=None, metadata=dc_config(field_name="vote") ) @dataclass class PollVoteResponseData(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) option_id: str = dc_field(metadata=dc_config(field_name="option_id")) poll_id: str = dc_field(metadata=dc_config(field_name="poll_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) answer_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="answer_text") ) is_answer: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_answer") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) answer_text_i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="answer_text_i18n") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class PollVotesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Poll votes votes: "List[PollVoteResponseData]" = dc_field( metadata=dc_config(field_name="votes") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class PoorByCause(DataClassJsonMixin): delivery: int = dc_field(metadata=dc_config(field_name="delivery")) edge: int = dc_field(metadata=dc_config(field_name="edge")) isolated_local: int = dc_field(metadata=dc_config(field_name="isolated_local")) source: int = dc_field(metadata=dc_config(field_name="source")) unattributed: int = dc_field(metadata=dc_config(field_name="unattributed")) @dataclass class PoorTail(DataClassJsonMixin): healthy_viewers: int = dc_field(metadata=dc_config(field_name="healthy_viewers")) note: str = dc_field(metadata=dc_config(field_name="note")) poor_total: int = dc_field(metadata=dc_config(field_name="poor_total")) poor_by_cause: "PoorByCause" = dc_field( metadata=dc_config(field_name="poor_by_cause") ) supporting: "Supporting" = dc_field(metadata=dc_config(field_name="supporting")) healthy_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="healthy_pct") ) @dataclass class PredefinedFilterResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) name: str = dc_field(metadata=dc_config(field_name="name")) operation: str = dc_field(metadata=dc_config(field_name="operation")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) query_id: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="query_id") ) sort: "Optional[List[SortParam]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) performance: "Optional[PerformanceAnalysisResponse]" = dc_field( default=None, metadata=dc_config(field_name="performance") ) stats: "Optional[PredefinedFilterStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="stats") ) @dataclass class PredefinedFilterStatsResponse(DataClassJsonMixin): calls: int = dc_field(metadata=dc_config(field_name="calls")) max_latency_ms: int = dc_field(metadata=dc_config(field_name="max_latency_ms")) last_seen: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_seen", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PrivacySettingsResponse(DataClassJsonMixin): # The settings for the delivery receipt events. delivery_receipts: "Optional[DeliveryReceiptsResponse]" = dc_field( default=None, metadata=dc_config(field_name="delivery_receipts") ) # The settings for the read receipt events. read_receipts: "Optional[ReadReceiptsResponse]" = dc_field( default=None, metadata=dc_config(field_name="read_receipts") ) # The settings for typing indicator events. typing_indicators: "Optional[TypingIndicatorsResponse]" = dc_field( default=None, metadata=dc_config(field_name="typing_indicators") ) @dataclass class PublishedTrackFlags(DataClassJsonMixin): audio: bool = dc_field(metadata=dc_config(field_name="audio")) screenshare: bool = dc_field(metadata=dc_config(field_name="screenshare")) screenshare_audio: bool = dc_field( metadata=dc_config(field_name="screenshare_audio") ) video: bool = dc_field(metadata=dc_config(field_name="video")) @dataclass class PublishedTrackMetrics(DataClassJsonMixin): codec: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="codec") ) track_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="track_id") ) track_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="track_type") ) warnings: "Optional[List[SessionWarningResponse]]" = dc_field( default=None, metadata=dc_config(field_name="warnings") ) bitrate: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) framerate: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="framerate") ) resolution: "Optional[ResolutionMetricsTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="resolution") ) @dataclass class PublisherAllMetrics(DataClassJsonMixin): audio: "Optional[PublisherAudioMetrics]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) rtt_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="rtt_ms") ) video: "Optional[PublisherVideoMetrics]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class PublisherAudioMetrics(DataClassJsonMixin): jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) @dataclass class PublisherSession(DataClassJsonMixin): duration_min: float = dc_field(metadata=dc_config(field_name="duration_min")) started_offset_min: float = dc_field( metadata=dc_config(field_name="started_offset_min") ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) avg_jitter_ms: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_jitter_ms") ) browser: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser") ) delivery_zone: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="delivery_zone") ) ingest: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ingest") ) os: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="os")) send_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="send_quality_score") ) tool: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="tool")) encoding: "Optional[EncodingProfile]" = dc_field( default=None, metadata=dc_config(field_name="encoding") ) @dataclass class PublisherStatsResponse(DataClassJsonMixin): total: int = dc_field(metadata=dc_config(field_name="total")) unique: int = dc_field(metadata=dc_config(field_name="unique")) by_track: "Optional[List[TrackStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_track") ) @dataclass class PublisherVideoMetrics(DataClassJsonMixin): bitrate: "Optional[ActiveCallsBitrateStats]" = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) fps_30: "Optional[ActiveCallsFPSStats]" = dc_field( default=None, metadata=dc_config(field_name="fps_30") ) frame_encoding_time_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="frame_encoding_time_ms") ) jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) resolution: "Optional[ActiveCallsResolutionStats]" = dc_field( default=None, metadata=dc_config(field_name="resolution") ) @dataclass class PublishersMetrics(DataClassJsonMixin): all: "Optional[PublisherAllMetrics]" = dc_field( default=None, metadata=dc_config(field_name="all") ) @dataclass class PushConfig(DataClassJsonMixin): version: str = dc_field(metadata=dc_config(field_name="version")) offline_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="offline_only") ) PushLevelType = NewType("PushLevelType", str) class PushLevel: ALL: Final[PushLevelType] = "all" ALL_MENTIONS: Final[PushLevelType] = "all_mentions" DIRECT_MENTIONS: Final[PushLevelType] = "direct_mentions" MENTIONS: Final[PushLevelType] = "mentions" NONE: Final[PushLevelType] = "none" @dataclass class PushNotificationConfig(DataClassJsonMixin): # Whether push notifications are enabled for this feed group enable_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_push") ) # Allowlist of notification types that may trigger push (e.g. follow, comment, reaction, comment_reaction, mention, or any custom activity.type). Empty or omitted means no types. Built-in notifications match notification_context.trigger.type; manually added notification activities match activity.type. push_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="push_types") ) @dataclass class PushNotificationFields(DataClassJsonMixin): offline_only: bool = dc_field(metadata=dc_config(field_name="offline_only")) version: str = dc_field(metadata=dc_config(field_name="version")) apn: "APNConfigFields" = dc_field(metadata=dc_config(field_name="apn")) firebase: "FirebaseConfigFields" = dc_field( metadata=dc_config(field_name="firebase") ) huawei: "HuaweiConfigFields" = dc_field(metadata=dc_config(field_name="huawei")) xiaomi: "XiaomiConfigFields" = dc_field(metadata=dc_config(field_name="xiaomi")) providers: "Optional[List[PushProvider]]" = dc_field( default=None, metadata=dc_config(field_name="providers") ) @dataclass class PushNotificationSettingsResponse(DataClassJsonMixin): disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class PushPreferenceInput(DataClassJsonMixin): # Set the level of call push notifications for the user. One of: all, none, default call_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_level") ) # Set the push preferences for a specific channel. If empty it sets the default for the user channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Set the level of chat push notifications for the user. Note: "mentions" is deprecated in favor of "direct_mentions". One of: all, mentions, direct_mentions, all_mentions, none, default chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) # Disable push notifications till a certain time disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Set the level of feeds push notifications for the user. One of: all, none, default feeds_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feeds_level") ) # Remove the disabled until time. (IE stop snoozing notifications) remove_disable: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="remove_disable") ) # Remove the user's quiet-hours schedule, the counterpart of remove_disable. It is applied before schedule, so sending both in one item replaces the stored schedule instead of merging into it. Cannot be combined with channel_cid. To switch from a schedule to a snooze, send remove_schedule together with disabled_until. remove_schedule: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="remove_schedule") ) # The user id for which to set the push preferences. Required when using server side auths, defaults to current user with client side auth. user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) chat_preferences: "Optional[ChatPreferencesInput]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) feeds_preferences: "Optional[FeedsPreferences]" = dc_field( default=None, metadata=dc_config(field_name="feeds_preferences") ) # A recurring quiet-hours schedule: while any quiet window is active, push notifications for the user are suppressed. Suppressed notifications are dropped, not delayed. schedule: "Optional[PushScheduleInput]" = dc_field( default=None, metadata=dc_config(field_name="schedule") ) @dataclass class PushPreferencesResponse(DataClassJsonMixin): call_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_level") ) # The scope level of the push notifications. chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) # If provided the notifications will be disabled until the set date. disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) feeds_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feeds_level") ) chat_preferences: "Optional[ChatPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) feeds_preferences: "Optional[FeedsPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="feeds_preferences") ) # A recurring quiet-hours schedule: while any quiet window is active, push notifications for the user are suppressed. Suppressed notifications are dropped, not delayed. schedule: "Optional[PushScheduleResponse]" = dc_field( default=None, metadata=dc_config(field_name="schedule") ) @dataclass class PushProvider(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) apn_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_notification_template") ) apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) huawei_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_host") ) xiaomi_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_app_secret") ) xiaomi_package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_package_name") ) push_templates: "Optional[List[PushTemplate]]" = dc_field( default=None, metadata=dc_config(field_name="push_templates") ) PushProviderNameType = NewType("PushProviderNameType", str) class PushProviderName: APN: Final[PushProviderNameType] = "apn" FIREBASE: Final[PushProviderNameType] = "firebase" HUAWEI: Final[PushProviderNameType] = "huawei" XIAOMI: Final[PushProviderNameType] = "xiaomi" @dataclass class PushProviderRequest(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) apn_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_notification_template") ) apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) xiaomi_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_app_secret") ) xiaomi_package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_package_name") ) @dataclass class PushProviderResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) apn_sandbox_certificate: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_sandbox_certificate") ) apn_supports_remote_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_supports_remote_notifications") ) apn_supports_voip_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_supports_voip_notifications") ) apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) xiaomi_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_app_secret") ) xiaomi_package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_package_name") ) @dataclass class PushScheduleInput(DataClassJsonMixin): # IANA time zone name the quiet windows are evaluated in, for example Europe/Amsterdam or America/New_York. Daylight saving time is followed automatically for region-based names. Offsets such as +02:00 and the name "Local" are rejected; fixed-offset zones such as UTC or Etc/GMT-2 are accepted but never shift for daylight saving time. When updating an existing schedule, a non-empty timezone replaces the stored one and leaves the stored quiet_hours untouched. timezone: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="timezone") ) # The quiet windows, 1 to 7 rules. Push is suppressed while any rule is active. When present it replaces all stored rules; omit it to keep them, for example to change only the timezone. An empty array counts as omitted, so it cannot be used to clear the rules: use remove_schedule for that. quiet_hours: "Optional[List[QuietHoursRuleInput]]" = dc_field( default=None, metadata=dc_config(field_name="quiet_hours") ) @dataclass class PushScheduleResponse(DataClassJsonMixin): # IANA time zone name the quiet windows are evaluated in, for example Europe/Amsterdam. timezone: str = dc_field(metadata=dc_config(field_name="timezone")) # The quiet windows. Push is suppressed while any rule is active. quiet_hours: "List[QuietHoursRuleResponse]" = dc_field( metadata=dc_config(field_name="quiet_hours") ) @dataclass class PushTemplate(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) enable_push: bool = dc_field(metadata=dc_config(field_name="enable_push")) event_type: str = dc_field(metadata=dc_config(field_name="event_type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @dataclass class PushTemplateResponse(DataClassJsonMixin): # Time when the template was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Whether push notification is enabled for this event enable_push: bool = dc_field(metadata=dc_config(field_name="enable_push")) # Type of event this template applies to event_type: str = dc_field(metadata=dc_config(field_name="event_type")) # Internal ID of the push provider push_provider_internal_id: str = dc_field( metadata=dc_config(field_name="push_provider_internal_id") ) # Time when the template was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The push notification template template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @dataclass class Quality(DataClassJsonMixin): viewer_interruption_note: str = dc_field( metadata=dc_config(field_name="viewer_interruption_note") ) interruption_incidents: "List[Incident]" = dc_field( metadata=dc_config(field_name="interruption_incidents") ) connection_avg_jitter_ms: "Percentiles" = dc_field( metadata=dc_config(field_name="connection_avg_jitter_ms") ) connection_avg_latency_ms: "Percentiles" = dc_field( metadata=dc_config(field_name="connection_avg_latency_ms") ) score_bands_by_connection_pct: "ScoreBands" = dc_field( metadata=dc_config(field_name="score_bands_by_connection_pct") ) score_bands_by_watch_time_pct: "ScoreBands" = dc_field( metadata=dc_config(field_name="score_bands_by_watch_time_pct") ) p50_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p50_quality_score") ) p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) viewer_interruption_rate_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="viewer_interruption_rate_pct") ) @dataclass class QualityScoreReport(DataClassJsonMixin): histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class QualityScoreReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateQualityScoreReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class QueryActivitiesRequest(DataClassJsonMixin): enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # When true, include both expired and non-expired activities in the result. include_expired_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_expired_activities") ) # When true, include activities hidden by moderation (shadowed or removed). Server-side only; not allowed when a user is set. include_moderated_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_moderated_activities") ) include_private_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_private_activities") ) # When true, include soft-deleted activities in the result. Server-side only; not allowed when a user is set. include_soft_deleted_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_soft_deleted_activities") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query. Supports location-based queries with 'near' and 'within_bounds' operators. filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryActivitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of activities matching the query activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryActivityReactionsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryActivityReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryActivitySharesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) shares: "List[ShareResponse]" = dc_field(metadata=dc_config(field_name="shares")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryAggregateCallStatsRequest(DataClassJsonMixin): _from: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="from")) to: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="to")) report_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="report_types") ) @dataclass class QueryAggregateCallStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) call_duration_report: "Optional[CallDurationReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="call_duration_report") ) call_participant_count_report: "Optional[CallParticipantCountReportResponse]" = ( dc_field( default=None, metadata=dc_config(field_name="call_participant_count_report") ) ) calls_per_day_report: "Optional[CallsPerDayReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="calls_per_day_report") ) network_metrics_report: "Optional[NetworkMetricsReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="network_metrics_report") ) quality_score_report: "Optional[QualityScoreReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="quality_score_report") ) sdk_usage_report: "Optional[SDKUsageReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="sdk_usage_report") ) user_feedback_report: "Optional[UserFeedbackReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_feedback_report") ) @dataclass class QueryAppealsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for appeals sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for appeals filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryAppealsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of Appeal Items items: "List[AppealItemResponse]" = dc_field(metadata=dc_config(field_name="items")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryBannedUsersPayload(DataClassJsonMixin): # Filter conditions to apply to the query filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether to exclude expired bans or not exclude_expired_bans: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_expired_bans") ) # Number of records to return limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Number of records to offset offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryBannedUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of found bans bans: "List[BanResponse]" = dc_field(metadata=dc_config(field_name="bans")) @dataclass class QueryBookmarkFoldersRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryBookmarkFoldersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of bookmark folders matching the query bookmark_folders: "List[BookmarkFolderResponse]" = dc_field( metadata=dc_config(field_name="bookmark_folders") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryBookmarksRequest(DataClassJsonMixin): enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryBookmarksResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of bookmarks matching the query bookmarks: "List[BookmarkResponse]" = dc_field( metadata=dc_config(field_name="bookmarks") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCallMembersRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) type: str = dc_field(metadata=dc_config(field_name="type")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryCallMembersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCallParticipantSessionsResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Duration of the request in milliseconds duration: int = dc_field(metadata=dc_config(field_name="duration")) total_participant_duration: int = dc_field( metadata=dc_config(field_name="total_participant_duration") ) total_participant_sessions: int = dc_field( metadata=dc_config(field_name="total_participant_sessions") ) participants_sessions: "List[ParticipantSessionDetails]" = dc_field( metadata=dc_config(field_name="participants_sessions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) session: "Optional[CallSessionResponse]" = dc_field( default=None, metadata=dc_config(field_name="session") ) @dataclass class QueryCallParticipantsRequest(DataClassJsonMixin): # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryCallParticipantsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) total_participants: int = dc_field( metadata=dc_config(field_name="total_participants") ) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # List of call participants participants: "List[CallParticipantResponse]" = dc_field( metadata=dc_config(field_name="participants") ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class QueryCallRingAttemptsRequest(DataClassJsonMixin): # Call ID id: str = dc_field(metadata=dc_config(field_name="id")) # The type of call type: str = dc_field(metadata=dc_config(field_name="type")) # Limit the attempts to one call session; omit to read every session of the call call_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_session_id") ) @dataclass class QueryCallRingAttemptsResponse(DataClassJsonMixin): # The ID of the call the attempts belong to call_id: str = dc_field(metadata=dc_config(field_name="call_id")) # The type of the call the attempts belong to call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # The number of attempts returned count: int = dc_field(metadata=dc_config(field_name="count")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The attempts, newest first ring_attempts: "List[RingAttemptResponse]" = dc_field( metadata=dc_config(field_name="ring_attempts") ) # The call session the attempts were limited to, null when every session was read call_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_session_id") ) @dataclass class QueryCallSessionParticipantStatsResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) participants: "List[CallStatsParticipant]" = dc_field( metadata=dc_config(field_name="participants") ) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) tmp_data_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="tmp_data_source") ) call_events: "Optional[List[CallLevelEventPayload]]" = dc_field( default=None, metadata=dc_config(field_name="call_events") ) @dataclass class QueryCallSessionParticipantStatsTimelineResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) user_session_id: str = dc_field(metadata=dc_config(field_name="user_session_id")) events: "List[CallParticipantTimeline]" = dc_field( metadata=dc_config(field_name="events") ) @dataclass class QueryCallSessionStatsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryCallSessionStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) call_stats: "List[CallStatsSessionResponse]" = dc_field( metadata=dc_config(field_name="call_stats") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCallStatsMapResponse(DataClassJsonMixin): call_id: str = dc_field(metadata=dc_config(field_name="call_id")) call_session_id: str = dc_field(metadata=dc_config(field_name="call_session_id")) call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) data_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_source") ) end_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) generated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="generated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) start_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) publishers: "Optional[CallStatsMapPublishers]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) sfus: "Optional[CallStatsMapSFUs]" = dc_field( default=None, metadata=dc_config(field_name="sfus") ) subscribers: "Optional[CallStatsMapSubscribers]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @dataclass class QueryCallStatsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryCallStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reports: "List[CallStatsReportSummaryResponse]" = dc_field( metadata=dc_config(field_name="reports") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCallsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryCallsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) calls: "List[CallStateResponseFields]" = dc_field( metadata=dc_config(field_name="calls") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCampaignsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="user_limit") ) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryCampaignsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaigns: "List[CampaignResponse]" = dc_field( metadata=dc_config(field_name="campaigns") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryChannelBansRequest(DataClassJsonMixin): # Whether to exclude expired bans or not exclude_expired_bans: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_expired_bans") ) # When true, the response includes total and total_by_scope: the number of banned users overall and per scope, independent of paging include_total: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_total") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryChannelBansResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Users banned from the channel, one entry per user, newest ban first bans: "List[ChannelBanResponse]" = dc_field(metadata=dc_config(field_name="bans")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Number of banned users, each counted once, ignoring paging. Counted per scope with a cap of 100000 each, so it can reach 200000. Only present when include_total is set on the request; omitted when counting timed out total: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total") ) total_by_scope: "Optional[ChannelBansScopeTotals]" = dc_field( default=None, metadata=dc_config(field_name="total_by_scope") ) @dataclass class QueryChannelsDefaults(DataClassJsonMixin): # Number of channels returned when `limit` is omitted. A request asking for at most one message and one member per channel can return more, up to the higher ceiling described on `max_limit`. limit: int = dc_field(metadata=dc_config(field_name="limit")) # Largest number of channels returned for one request. A bigger `limit` is silently clamped to this value rather than rejected. An app with no per-app `max_limit` gets a higher ceiling for the narrow case of a request asking for at most one message and one member per channel. max_limit: int = dc_field(metadata=dc_config(field_name="max_limit")) # Number of members returned per channel when `member_limit` is omitted. member_limit: int = dc_field(metadata=dc_config(field_name="member_limit")) # Number of messages returned per channel when `message_limit` is omitted. message_limit: int = dc_field(metadata=dc_config(field_name="message_limit")) @dataclass class QueryChannelsRequest(DataClassJsonMixin): # Whether to include active_member_count for each channel include_active_member_count: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_active_member_count") ) # Number of channels to limit limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Number of members to limit member_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_limit") ) # Number of messages to limit message_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="message_limit") ) # Channel pagination offset offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) # ID of a predefined filter to use instead of filter_conditions predefined_filter: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) # Whether to update channel state or not state: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="state") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Top-level keys of the message sender's channel-member custom data to include under member.custom (max 8 keys, 64 chars each) member_custom_include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_custom_include") ) # List of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # Values to interpolate into the predefined filter template filter_values: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_values") ) sort_values: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="sort_values") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of channels channels: "List[ChannelStateResponseFields]" = dc_field( metadata=dc_config(field_name="channels") ) predefined_filter: "Optional[ParsedPredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class QueryCollectionsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of collections matching the query collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCommentReactionsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryCommentReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCommentsRequest(DataClassJsonMixin): # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # Returns the comment with the specified ID along with surrounding comments for context id_around: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_around") ) # When true, include soft-deleted comments in the result. Server-side only, and requires an object_id filter. Covers comments removed via deleteComment and via soft user-data deletion. Moderation-actioned comments (removed, hidden, shadow_blocked) remain excluded, as are comments whose parent activity is itself deleted. include_soft_deleted_comments: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_soft_deleted_comments") ) # Maximum number of comments to return limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="sort")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryCommentsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of comments matching the query comments: "List[CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryDeletedChannelsRequest(DataClassJsonMixin): # Number of channels per page, 1-100 (default 25) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Cursor for the next page, from the previous response next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for the previous page, from the previous response prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Sort order. Only created_at is supported; defaults to created_at ascending sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Optional filter. Omit it, or pass {}, to list every soft-deleted channel of the app; for example {"team": "tenant-a"} narrows to one tenant filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryDeletedChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Soft-deleted channels matching the filter, each with deleted_at set channels: "List[ChannelResponse]" = dc_field( metadata=dc_config(field_name="channels") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryDraftsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryDraftsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Drafts drafts: "List[DraftResponse]" = dc_field(metadata=dc_config(field_name="drafts")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryFeedMembersRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Sort parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter parameters for the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryFeedMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of feed members members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryFeedModerationTemplate(DataClassJsonMixin): # When the template was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Name of the moderation template name: str = dc_field(metadata=dc_config(field_name="name")) # When the template was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Configuration for a feeds moderation template config: "Optional[FeedsModerationTemplateConfigPayload]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @dataclass class QueryFeedModerationTemplatesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation templates templates: "List[QueryFeedModerationTemplate]" = dc_field( metadata=dc_config(field_name="templates") ) @dataclass class QueryFeedsRequest(DataClassJsonMixin): enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Whether to subscribe to realtime updates watch: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="watch") ) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryFeedsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of feeds matching the query feeds: "List[FeedResponse]" = dc_field(metadata=dc_config(field_name="feeds")) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryFeedsUsageStatsRequest(DataClassJsonMixin): # Start date in YYYY-MM-DD format (optional, defaults to 30 days ago) _from: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="from")) # End date in YYYY-MM-DD format (optional, defaults to today) to: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="to")) @dataclass class QueryFeedsUsageStatsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activities: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="activities") ) api_requests: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="api_requests") ) collections: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="collections") ) comments: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="comments") ) follows: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="follows") ) openai_requests: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="openai_requests") ) reactions: "DailyMetricStatsResponse" = dc_field( metadata=dc_config(field_name="reactions") ) emau: "Optional[EMAUStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="emau") ) @dataclass class QueryFollowsRequest(DataClassJsonMixin): # When true (server-side only), the response includes group_counts: accepted following counts keyed by the followed feed's group. Requires exactly one source_feed / source_fid string equality. HTTP 400 if target_feed appears, if two source FIDs are given, or if $in / $or mentions those keys. Independent of paging and of other filters, including status. include_group_counts: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_group_counts") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryFollowsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of follow relationships matching the query follows: "List[FollowResponse]" = dc_field(metadata=dc_config(field_name="follows")) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Accepted following counts keyed by followed feed group. Present only when include_group_counts is set with a source_feed equality. group_counts: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="group_counts") ) @dataclass class QueryFutureChannelBansPayload(DataClassJsonMixin): created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether to exclude expired bans or not exclude_expired_bans: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_expired_bans") ) # When true, the response includes the total number of bans matching the query filter (independent of limit and offset, capped at 100000) include_total: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_total") ) # Number of records to return limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Number of records to offset offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) # Filter by the target user ID. Server-side: returns all bans against this user. Client-side: narrows the authenticated user's own bans to this target. target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryFutureChannelBansResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of found future channel bans bans: "List[FutureChannelBanResponse]" = dc_field( metadata=dc_config(field_name="bans") ) # Total number of bans matching the query filter, computed at query time and capped at 100000. Only present when include_total is set on the request; omitted when computing the total timed out total: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total") ) @dataclass class QueryLabelResultsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryLabelResultsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation label results label_results: "List[LabelResultResponse]" = dc_field( metadata=dc_config(field_name="label_results") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryMembersPayload(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) user_id_gt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_gt") ) user_id_gte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_gte") ) user_id_lt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_lt") ) user_id_lte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_lte") ) members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryMembershipLevelsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryMembershipLevelsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) membership_levels: "List[MembershipLevelResponse]" = dc_field( metadata=dc_config(field_name="membership_levels") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryMessageFlagsPayload(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) # Whether to include deleted messages in the results show_deleted_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_deleted_messages") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryMessageFlagsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The flags that match the query flags: "List[MessageFlagResponse]" = dc_field( metadata=dc_config(field_name="flags") ) @dataclass class QueryMessageHistoryRequest(DataClassJsonMixin): # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class QueryMessageHistoryResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Message history entries message_history: "List[MessageHistoryEntryResponse]" = dc_field( metadata=dc_config(field_name="message_history") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryModerationConfigsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the results sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation configs filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryModerationConfigsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation configurations configs: "List[ConfigResponse]" = dc_field(metadata=dc_config(field_name="configs")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryModerationFeedbackRequest(DataClassJsonMixin): # Maximum number of matching items returned per submission, 1 to 50; all by default item_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="item_limit") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters: created_at only, newest first by default sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryModerationFeedbackResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Feedback submissions with at least one item matching the filter, each with its matching items submissions: "List[ModerationFeedbackSubmissionResponse]" = dc_field( metadata=dc_config(field_name="submissions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) filter_config: "Optional[FilterConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="filter_config") ) @dataclass class QueryModerationFlagsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation flags filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryModerationFlagsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) flags: "List[ModerationFlagResponse]" = dc_field( metadata=dc_config(field_name="flags") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryModerationLogsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the results sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation logs filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryModerationLogsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation action logs logs: "List[ActionLogResponse]" = dc_field(metadata=dc_config(field_name="logs")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryModerationRulesRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the results sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation rules filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryModerationRulesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # AI image label definitions with metadata for dashboard rendering ai_image_label_definitions: "List[AIImageLabelDefinition]" = dc_field( metadata=dc_config(field_name="ai_image_label_definitions") ) # Available harm labels for closed caption rules closed_caption_labels: List[str] = dc_field( metadata=dc_config(field_name="closed_caption_labels") ) # Deprecated: use keyframe_label_classifications instead. Available L1 harm labels for keyframe rules keyframe_labels: List[str] = dc_field( metadata=dc_config(field_name="keyframe_labels") ) # Available harm labels for OCR-based rule conditions (keyframe_ocr_rule and ocr_content). Mirrors `closed_caption_labels` today but kept as a separate field so the pickers can diverge later. ocr_labels: List[str] = dc_field(metadata=dc_config(field_name="ocr_labels")) # List of moderation rules rules: "List[ModerationRuleV2Response]" = dc_field( metadata=dc_config(field_name="rules") ) # Stream L1 to leaf-level label name mapping for AI image rules ai_image_subclassifications: "Dict[str, List[str]]" = dc_field( metadata=dc_config(field_name="ai_image_subclassifications") ) # Default LLM label descriptions default_llm_labels: "Dict[str, str]" = dc_field( metadata=dc_config(field_name="default_llm_labels") ) # Recommended LLM label descriptions for username-scoped policies (key starts with 'username:'). Used by /moderation/v2/labels fast-path. default_username_llm_labels: "Dict[str, str]" = dc_field( metadata=dc_config(field_name="default_username_llm_labels") ) # L1 to L2 mapping of keyframe harm label classifications keyframe_label_classifications: "Dict[str, List[str]]" = dc_field( metadata=dc_config(field_name="keyframe_label_classifications") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryPinnedActivitiesRequest(DataClassJsonMixin): enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # When true, return pinned activities even if they have expired. Server-side only; not allowed when a user is set. include_expired_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_expired_activities") ) # When true, return pinned activities even if moderation hides them (shadowed or removed). Server-side only; not allowed when a user is set. include_moderated_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_moderated_activities") ) # When true, return pinned activities even if they are soft-deleted. Server-side only; not allowed when a user is set. include_soft_deleted_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_soft_deleted_activities") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the query sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryPinnedActivitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of pinned activities matching the query pinned_activities: "List[ActivityPinResponse]" = dc_field( metadata=dc_config(field_name="pinned_activities") ) # Cursor for next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryPollVotesRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryPollsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryPollsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Polls data returned by the query polls: "List[PollResponseData]" = dc_field(metadata=dc_config(field_name="polls")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryPredefinedFiltersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Predefined filters predefined_filters: "List[PredefinedFilterResponse]" = dc_field( metadata=dc_config(field_name="predefined_filters") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryReactionsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryRemindersRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryRemindersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # MessageReminders data returned by the query reminders: "List[ReminderResponseData]" = dc_field( metadata=dc_config(field_name="reminders") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryReviewQueueRequest(DataClassJsonMixin): exclude_default_action_config: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_default_action_config") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Number of items to lock (1-25) lock_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="lock_count") ) # Duration for which items should be locked lock_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="lock_duration") ) # Whether to lock items for review (true), unlock items (false), or just fetch (nil) lock_items: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="lock_items") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Whether to return only statistics stats_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stats_only") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the results sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for review queue items. Accepts built-in fields (e.g. status, channel_cid, severity, recommended_action) and customer-supplied moderation_payload.custom keys: any key that is not a built-in field is matched against the item's custom moderation data (e.g. {"location_id": "loc-42"}). Use filter_config.filterable_custom_keys to discover which custom keys the app exposes as chips. content_text searches the moderated text: "$q" is a keyword search (terms ANDed, no adjacency) over the indexed tsvector, while "$eq" (or "$in" for several wordings) matches the text exactly. The exact form is unindexed, so scope it with date_range rather than running it across the whole queue. filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryReviewQueueResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of review queue items items: "List[ReviewQueueItemResponse]" = dc_field( metadata=dc_config(field_name="items") ) # Configuration for moderation actions action_config: "Dict[str, List[ModerationActionConfigResponse]]" = dc_field( metadata=dc_config(field_name="action_config") ) # Statistics about the review queue stats: Dict[str, object] = dc_field(metadata=dc_config(field_name="stats")) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) default_action_config: "Optional[Dict[str, List[ModerationActionConfigResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="default_action_config") ) filter_config: "Optional[FilterConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="filter_config") ) @dataclass class QueryRevisionHistoryRequest(DataClassJsonMixin): # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class QueryRevisionHistoryResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Revision history entries revisions: "List[RevisionHistoryResponse]" = dc_field( metadata=dc_config(field_name="revisions") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryScheduledMessagesRequest(DataClassJsonMixin): # Page size, 1 to 100. Defaults to 20 limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Cursor from the previous page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Only scheduled_at ascending is supported. Pending messages come before failed ones sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter for querying scheduled messages filter: "Optional[ScheduledMessagesFilter]" = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryScheduledMessagesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Pending messages first, then failed ones, each by scheduled_at scheduled_messages: "List[ScheduledMessageResponse]" = dc_field( metadata=dc_config(field_name="scheduled_messages") ) # Cursor for the next page; empty on the last page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) @dataclass class QuerySegmentTargetsRequest(DataClassJsonMixin): # Limit limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Next next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Prev prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="Sort") ) filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="Filter") ) @dataclass class QuerySegmentTargetsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Targets targets: "List[SegmentTargetResponse]" = dc_field( metadata=dc_config(field_name="targets") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QuerySegmentsRequest(DataClassJsonMixin): # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class QuerySegmentsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Segments segments: "List[SegmentResponse]" = dc_field( metadata=dc_config(field_name="segments") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryTeamUsageStatsRequest(DataClassJsonMixin): # End date in YYYY-MM-DD format. Used with start_date for custom date range. Returns daily breakdown. end_date: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="end_date") ) # Maximum number of teams to return per page (default: 30, max: 30) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Month in YYYY-MM format (e.g., '2026-01'). Mutually exclusive with start_date/end_date. Returns aggregated monthly values. month: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="month") ) # Cursor for pagination to fetch next page of teams next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Start date in YYYY-MM-DD format. Used with end_date for custom date range. Returns daily breakdown. start_date: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="start_date") ) # Filter results to a single team ID. Empty string selects users not assigned to any team. Mutually exclusive with 'next'. team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) @dataclass class QueryTeamUsageStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Array of team usage statistics teams: "List[TeamUsageStats]" = dc_field(metadata=dc_config(field_name="teams")) # Cursor for pagination to fetch next page next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) @dataclass class QueryThreadsRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) member_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Limit the number of participants returned per each thread participant_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="participant_limit") ) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Limit the number of replies returned per each thread reply_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reply_limit") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryThreadsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of enriched thread states threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryUserFeedbackRequest(DataClassJsonMixin): limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @dataclass class QueryUserFeedbackResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) user_feedback: "List[UserFeedbackResponse]" = dc_field( metadata=dc_config(field_name="user_feedback") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryUsersPayload(DataClassJsonMixin): # Filter conditions to apply to the query filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) id_gt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_gt") ) id_gte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_gte") ) id_lt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_lt") ) id_lte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_lte") ) include_deactivated_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_deactivated_users") ) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) presence: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="presence") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Array of users as result of filters applied. users: "List[FullUserResponse]" = dc_field(metadata=dc_config(field_name="users")) @dataclass class QueueResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) queue: "Optional[ModerationQueueResponse]" = dc_field( default=None, metadata=dc_config(field_name="queue") ) @dataclass class QuietHoursRuleInput(DataClassJsonMixin): # When the window closes, as HH:MM local wall-clock time between 00:00 and 24:00. The end is exclusive: a window ending at 07:00 is already over at 07:00. An end earlier than start wraps past midnight into the next day (start 22:00, end 07:00). 24:00 means the end of the day, so start 00:00 with end 24:00 covers the whole day. end: str = dc_field(metadata=dc_config(field_name="end")) # When the window opens, as HH:MM local wall-clock time between 00:00 and 23:59. Must differ from end. start: str = dc_field(metadata=dc_config(field_name="start")) # The days of the week the window opens on, any of mon, tue, wed, thu, fri, sat, sun, each at most once. A window belongs to the day it opens: ["fri"] with 22:00 to 07:00 is quiet from Friday 22:00 until Saturday 07:00, and not on Saturday night. Empty or omitted means every day. days: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="days") ) @dataclass class QuietHoursRuleResponse(DataClassJsonMixin): # When the window closes, as HH:MM local wall-clock time between 00:00 and 24:00. The end is exclusive. An end earlier than start wraps past midnight into the next day. end: str = dc_field(metadata=dc_config(field_name="end")) # When the window opens, as HH:MM local wall-clock time between 00:00 and 23:59. start: str = dc_field(metadata=dc_config(field_name="start")) # The days of the week the window opens on, any of mon, tue, wed, thu, fri, sat, sun. A window belongs to the day it opens: ["fri"] with 22:00 to 07:00 is quiet from Friday 22:00 until Saturday 07:00. Omitted means every day. days: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="days") ) @dataclass class RTMPBroadcastRequest(DataClassJsonMixin): # Name identifier for RTMP broadcast, must be unique in call name: str = dc_field(metadata=dc_config(field_name="name")) # URL for the RTMP server to send the call to stream_url: str = dc_field(metadata=dc_config(field_name="stream_url")) # If provided, will override the call's RTMP settings quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560 quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) # If provided, will be appended at the end of stream_url stream_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_key") ) layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class RTMPIngress(DataClassJsonMixin): address: str = dc_field(metadata=dc_config(field_name="address")) @dataclass class RTMPLocation(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) stream_key: str = dc_field(metadata=dc_config(field_name="stream_key")) stream_url: str = dc_field(metadata=dc_config(field_name="stream_url")) @dataclass class RTMPSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) quality_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality_name") ) layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) location: "Optional[RTMPLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class RTMPSettingsRequest(DataClassJsonMixin): # Whether RTMP broadcasting is enabled enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Resolution to set for the RTMP stream. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560 quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class RTMPSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) quality: str = dc_field(metadata=dc_config(field_name="quality")) layout: "LayoutSettingsResponse" = dc_field(metadata=dc_config(field_name="layout")) @dataclass class RankingConfig(DataClassJsonMixin): # Type of ranking algorithm. Required. One of: expression, interest type: str = dc_field(metadata=dc_config(field_name="type")) # Activities scoring strictly below this value are dropped from the ranked feed. Not supported on aggregated feeds exclude_below: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="exclude_below") ) # Scoring formula. Required when type is 'expression' (unless for_you.preset is set) or 'interest' score: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="score") ) arrange: "Optional[ArrangeConfig]" = dc_field( default=None, metadata=dc_config(field_name="arrange") ) # Default values for ranking defaults: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="defaults") ) for_you: "Optional[ForYouConfig]" = dc_field( default=None, metadata=dc_config(field_name="for_you") ) # Decay functions configuration functions: "Optional[Dict[str, DecayFunctionConfig]]" = dc_field( default=None, metadata=dc_config(field_name="functions") ) @dataclass class RawRecordSettings(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) @dataclass class RawRecordingResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) @dataclass class RawRecordingSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) # If true, only audio tracks will be recorded audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) @dataclass class RawRecordingSettingsResponse(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) @dataclass class Reaction(DataClassJsonMixin): activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) kind: str = dc_field(metadata=dc_config(field_name="kind")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) parent: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent") ) score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="score") ) target_feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds") ) children_counts: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="children_counts") ) data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) latest_children: "Optional[Dict[str, List[Reaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_children") ) moderation: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="moderation") ) own_children: "Optional[Dict[str, List[Reaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_children") ) target_feeds_extra_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds_extra_data") ) user: "Optional[User]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactionDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "reaction.deleted" in this case type: str = dc_field( default="reaction.deleted", metadata=dc_config(field_name="type") ) # The ID of the channel containing the message channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel containing the message channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The participants of the thread thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactionGroupResponse(DataClassJsonMixin): # Count is the number of reactions of this type. count: int = dc_field(metadata=dc_config(field_name="count")) # FirstReactionAt is the time of the first reaction of this type. This is the same also if all reaction of this type are deleted, because if someone will react again with the same type, will be preserved the sorting. first_reaction_at: datetime = dc_field( metadata=dc_config( field_name="first_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # LastReactionAt is the time of the last reaction of this type. last_reaction_at: datetime = dc_field( metadata=dc_config( field_name="last_reaction_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # SumScores is the sum of all scores of reactions of this type. Medium allows you to clap articles more than once and shows the sum of all claps from all users. For example, you can send `clap` x5 using `score: 5`. sum_scores: int = dc_field(metadata=dc_config(field_name="sum_scores")) # The most recent users who reacted with this type, ordered by most recent first. latest_reactions_by: "List[ReactionGroupUserResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions_by") ) @dataclass class ReactionGroupUserResponse(DataClassJsonMixin): # The time when the user reacted. created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the user who reacted. user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactionNewEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "reaction.new" in this case type: str = dc_field(default="reaction.new", metadata=dc_config(field_name="type")) # The ID of the channel containing the message channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel containing the message channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The participants of the thread thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactionRequest(DataClassJsonMixin): # The type of reaction (e.g. 'like', 'laugh', 'wow') type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of creation created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Reaction score. If not specified reaction has score of 1 score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="score") ) # Date/time of the last update updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactionResponse(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Message ID message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Score of the reaction score: int = dc_field(metadata=dc_config(field_name="score")) # Type of reaction type: str = dc_field(metadata=dc_config(field_name="type")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User ID user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class ReactionUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Represents channel in chat channel: "ChannelResponse" = dc_field(metadata=dc_config(field_name="channel")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # The type of event: "reaction.updated" in this case type: str = dc_field( default="reaction.updated", metadata=dc_config(field_name="type") ) # The ID of the channel containing the message channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # The number of members in the channel channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) # The number of messages in the channel channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel containing the message channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team ID team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactivateUserRequest(DataClassJsonMixin): # ID of the user who's reactivating the user created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Set this field to put new name for the user name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Restore previously deleted messages restore_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_messages") ) @dataclass class ReactivateUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReactivateUsersRequest(DataClassJsonMixin): # User IDs to reactivate user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) # ID of the user who's reactivating the users created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) restore_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_channels") ) # Restore previously deleted messages restore_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_messages") ) @dataclass class ReactivateUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) @dataclass class ReadCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of collections matching the references collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @dataclass class ReadReceiptsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) @dataclass class ReadStateResponse(DataClassJsonMixin): last_read: datetime = dc_field( metadata=dc_config( field_name="last_read", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) unread_messages: int = dc_field(metadata=dc_config(field_name="unread_messages")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) last_delivered_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_delivered_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) last_delivered_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_delivered_message_id") ) last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) @dataclass class RecordSettings(DataClassJsonMixin): mode: str = dc_field(metadata=dc_config(field_name="mode")) audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class RecordSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) # Whether to record audio only audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) # Recording quality. One of: 360p, 480p, 720p, 1080p, 1440p, portrait-360x640, portrait-480x854, portrait-720x1280, portrait-1080x1920, portrait-1440x2560 quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @dataclass class RecordSettingsResponse(DataClassJsonMixin): audio_only: bool = dc_field(metadata=dc_config(field_name="audio_only")) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) quality: str = dc_field(metadata=dc_config(field_name="quality")) layout: "LayoutSettingsResponse" = dc_field(metadata=dc_config(field_name="layout")) RecordingTypeType = NewType("RecordingTypeType", str) class RecordingType: COMPOSITE: Final[RecordingTypeType] = "composite" INDIVIDUAL: Final[RecordingTypeType] = "individual" RAW: Final[RecordingTypeType] = "raw" @dataclass class RejectAppealRequestPayload(DataClassJsonMixin): # Reason for rejecting the appeal decision_reason: str = dc_field(metadata=dc_config(field_name="decision_reason")) @dataclass class RejectFeedMemberInviteRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class RejectFeedMemberInviteResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) member: "FeedMemberResponse" = dc_field(metadata=dc_config(field_name="member")) @dataclass class RejectFollowRequest(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) @dataclass class RejectFollowResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) @dataclass class ReminderCreatedEvent(DataClassJsonMixin): # The CID of the Channel for which the reminder was created cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the message for which the reminder was created message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The ID of the user for whom the reminder was created user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) # The type of event: "reminder.created" in this case type: str = dc_field( default="reminder.created", metadata=dc_config(field_name="type") ) # The ID of the parent message, if the reminder is for a thread message parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ReminderDeletedEvent(DataClassJsonMixin): # The CID of the Channel for which the reminder was created cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the message for which the reminder was created message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The ID of the user for whom the reminder was created user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) # The type of event: "reminder.deleted" in this case type: str = dc_field( default="reminder.deleted", metadata=dc_config(field_name="type") ) # The ID of the parent message, if the reminder is for a thread message parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ReminderNotificationEvent(DataClassJsonMixin): # The CID of the Channel for which the reminder was created cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the message for which the reminder was created message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The ID of the user for whom the reminder was created user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) # The type of event: "notification.reminder_due" in this case type: str = dc_field( default="notification.reminder_due", metadata=dc_config(field_name="type") ) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ReminderResponseData(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) remind_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="remind_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ReminderUpdatedEvent(DataClassJsonMixin): # The CID of the Channel for which the reminder was created cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the message for which the reminder was created message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The ID of the user for whom the reminder was created user_id: str = dc_field(metadata=dc_config(field_name="user_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) # The type of event: "reminder.updated" in this case type: str = dc_field( default="reminder.updated", metadata=dc_config(field_name="type") ) # The ID of the parent message, if the reminder is for a thread message parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class RemoveUserGroupMembersRequest(DataClassJsonMixin): # List of user IDs to remove member_ids: List[str] = dc_field(metadata=dc_config(field_name="member_ids")) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @dataclass class RemoveUserGroupMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class RepliesMeta(DataClassJsonMixin): # True if the subtree was cut because the requested depth was reached. depth_truncated: bool = dc_field(metadata=dc_config(field_name="depth_truncated")) # True if more siblings exist in the database. has_more: bool = dc_field(metadata=dc_config(field_name="has_more")) # Number of unread siblings that match current filters. remaining: int = dc_field(metadata=dc_config(field_name="remaining")) # Opaque cursor to request the next page of siblings. next_cursor: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="next_cursor") ) @dataclass class ReportByHistogramBucket(DataClassJsonMixin): category: str = dc_field(metadata=dc_config(field_name="category")) count: int = dc_field(metadata=dc_config(field_name="count")) sum: float = dc_field(metadata=dc_config(field_name="sum")) lower_bound: "Optional[Bound]" = dc_field( default=None, metadata=dc_config(field_name="lower_bound") ) upper_bound: "Optional[Bound]" = dc_field( default=None, metadata=dc_config(field_name="upper_bound") ) @dataclass class ReportClientEventRequest(DataClassJsonMixin): # Client-side events to report (1-100 per request) events: "List[ClientEvent]" = dc_field(metadata=dc_config(field_name="events")) @dataclass class ReportClientEventResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class ReportResponse(DataClassJsonMixin): call: "CallReportResponse" = dc_field(metadata=dc_config(field_name="call")) participants: "ParticipantReportResponse" = dc_field( metadata=dc_config(field_name="participants") ) user_ratings: "UserRatingReportResponse" = dc_field( metadata=dc_config(field_name="user_ratings") ) @dataclass class ResolutionMetricsTimeSeries(DataClassJsonMixin): height: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="height") ) width: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="width") ) @dataclass class ResolveSipAuthRequest(DataClassJsonMixin): # SIP caller number sip_caller_number: str = dc_field( metadata=dc_config(field_name="sip_caller_number") ) # SIP trunk number to look up sip_trunk_number: str = dc_field(metadata=dc_config(field_name="sip_trunk_number")) # Host from the SIP From header from_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="from_host") ) # Transport-layer source IP address of the SIP request source_ip: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="source_ip") ) @dataclass class ResolveSipAuthResponse(DataClassJsonMixin): # Authentication result: password, accept, or no_trunk_found auth_result: str = dc_field(metadata=dc_config(field_name="auth_result")) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Password for digest authentication (when auth_result is password) password: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="password") ) # ID of the matched SIP trunk trunk_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="trunk_id") ) # Username for digest authentication (when auth_result is password) username: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="username") ) @dataclass class ResolveSipInboundRequest(DataClassJsonMixin): # SIP caller number sip_caller_number: str = dc_field( metadata=dc_config(field_name="sip_caller_number") ) # SIP trunk number to resolve sip_trunk_number: str = dc_field(metadata=dc_config(field_name="sip_trunk_number")) # Optional routing number for routing number-based call routing (10 digits) routing_number: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="routing_number") ) # Optional pre-authenticated trunk ID (from PreAuth no-auth flow) trunk_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="trunk_id") ) # SIP digest challenge authentication data challenge: "Optional[SIPChallengeRequest]" = dc_field( default=None, metadata=dc_config(field_name="challenge") ) # Optional SIP headers as key-value pairs sip_headers: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="sip_headers") ) @dataclass class ResolveSipInboundResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Credentials for SIP inbound call authentication credentials: "SipInboundCredentials" = dc_field( metadata=dc_config(field_name="credentials") ) # SIP Inbound Routing Rule response sip_routing_rule: "Optional[SIPInboundRoutingRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_routing_rule") ) # SIP trunk information sip_trunk: "Optional[SIPTrunkResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_trunk") ) @dataclass class Response(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class RestoreActionRequestPayload(DataClassJsonMixin): # Reason for the appeal decision decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) # Internal moderator note, stored on the action log and returned by QueryModerationLogs. Not shown to the appealing user; use decision_reason for that reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class RestoreActivityRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class RestoreActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class RestoreCommentRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class RestoreCommentResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class RestoreFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_group: "FeedGroupResponse" = dc_field( metadata=dc_config(field_name="feed_group") ) @dataclass class RestoreUsersRequest(DataClassJsonMixin): user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) RestrictRepliesType = NewType("RestrictRepliesType", str) class RestrictReplies: EVERYONE: Final[RestrictRepliesType] = "everyone" NOBODY: Final[RestrictRepliesType] = "nobody" PEOPLE_I_FOLLOW: Final[RestrictRepliesType] = "people_i_follow" @dataclass class RetentionPolicy(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) enabled_at: datetime = dc_field( metadata=dc_config( field_name="enabled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) policy: str = dc_field(metadata=dc_config(field_name="policy")) config: "PolicyConfig" = dc_field(metadata=dc_config(field_name="config")) RetentionPolicyTypeType = NewType("RetentionPolicyTypeType", str) class RetentionPolicyType: INACTIVE_CHANNELS: Final[RetentionPolicyTypeType] = "inactive-channels" INACTIVE_CHANNELS_BY_TYPE: Final[RetentionPolicyTypeType] = ( "inactive-channels-by-type" ) OLD_MESSAGES: Final[RetentionPolicyTypeType] = "old-messages" @dataclass class RetentionRunResponse(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) date: str = dc_field(metadata=dc_config(field_name="date")) policy: str = dc_field(metadata=dc_config(field_name="policy")) stats: "RunStats" = dc_field(metadata=dc_config(field_name="stats")) channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) @dataclass class RevealMediaRequest(DataClassJsonMixin): # ID of the review queue item whose media is revealed item_id: str = dc_field(metadata=dc_config(field_name="item_id")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class RevealMediaResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Display policy for a review queue item's images and video media_display: "MediaDisplayResponse" = dc_field( metadata=dc_config(field_name="media_display") ) @dataclass class ReviewQueueItemNewEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="review_queue_item.new", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The flags associated with this review queue item flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="action") ) review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) @dataclass class ReviewQueueItemResponse(DataClassJsonMixin): # AI-determined text severity ai_text_severity: str = dc_field(metadata=dc_config(field_name="ai_text_severity")) # When the item was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # ID of the entity being reviewed entity_id: str = dc_field(metadata=dc_config(field_name="entity_id")) # Type of entity being reviewed entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # Whether the item has been escalated escalated: bool = dc_field(metadata=dc_config(field_name="escalated")) flags_count: int = dc_field(metadata=dc_config(field_name="flags_count")) # Unique identifier of the review queue item id: str = dc_field(metadata=dc_config(field_name="id")) latest_moderator_action: str = dc_field( metadata=dc_config(field_name="latest_moderator_action") ) # Suggested moderation action recommended_action: str = dc_field( metadata=dc_config(field_name="recommended_action") ) # ID of the moderator who reviewed the item reviewed_by: str = dc_field(metadata=dc_config(field_name="reviewed_by")) # Severity level of the content severity: int = dc_field(metadata=dc_config(field_name="severity")) # Current status of the review status: str = dc_field(metadata=dc_config(field_name="status")) # When the item was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Moderation actions taken actions: "List[ActionLogResponse]" = dc_field( metadata=dc_config(field_name="actions") ) # Associated ban records bans: "List[BanInfoResponse]" = dc_field(metadata=dc_config(field_name="bans")) # Associated flag records flags: "List[ModerationFlagResponse]" = dc_field( metadata=dc_config(field_name="flags") ) # Detected languages in the content languages: List[str] = dc_field(metadata=dc_config(field_name="languages")) # Display policy for a review queue item's images and video media_display: "MediaDisplayResponse" = dc_field( metadata=dc_config(field_name="media_display") ) # When the review was completed completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Highest per-label confidence (0-1) any provider reported across the item's flags; absent when no flag carried one confidence_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence_score") ) config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) country_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_code") ) # ID of who created the entity entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # When the item was escalated escalated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="escalated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ID of the moderator who escalated the item escalated_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="escalated_by") ) # When the item was reviewed reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) country_codes: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="country_codes") ) # IDs of the item's flags a moderator marked as false positives false_positive_flags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="false_positive_flags") ) # Teams associated with this item teams: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="teams") ) activity: "Optional[EnrichedActivity]" = dc_field( default=None, metadata=dc_config(field_name="activity") ) appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) # User response object assigned_to: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="assigned_to") ) call: "Optional[ModerationCallResponse]" = dc_field( default=None, metadata=dc_config(field_name="call") ) entity_creator: "Optional[EntityCreatorResponse]" = dc_field( default=None, metadata=dc_config(field_name="entity_creator") ) escalation_metadata: "Optional[EscalationMetadata]" = dc_field( default=None, metadata=dc_config(field_name="escalation_metadata") ) feeds_v2_activity: "Optional[EnrichedActivity]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_activity") ) feeds_v2_reaction: "Optional[Reaction]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_reaction") ) feeds_v3_activity: "Optional[FeedsV3ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v3_activity") ) feeds_v3_comment: "Optional[FeedsV3CommentResponse]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v3_comment") ) message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Content payload for moderation moderation_payload: "Optional[ModerationPayloadResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) reaction: "Optional[Reaction]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) @dataclass class ReviewQueueItemUpdatedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="review_queue_item.updated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The flags associated with this review queue item flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="action") ) review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) @dataclass class RevisionHistoryResponse(DataClassJsonMixin): action_type: str = dc_field(metadata=dc_config(field_name="action_type")) actor_type: str = dc_field(metadata=dc_config(field_name="actor_type")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) object_id: str = dc_field(metadata=dc_config(field_name="object_id")) object_type: str = dc_field(metadata=dc_config(field_name="object_type")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) changed_fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="changed_fields") ) previous_obj_serialized: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="previous_obj_serialized") ) @dataclass class RewindChannelRequest(DataClassJsonMixin): # ID of the newest visible message the caller saw. The rewind fails with a conflict when it is no longer the newest expected_last_message_id: str = dc_field( metadata=dc_config(field_name="expected_last_message_id") ) # ID of the top-level message to rewind the channel to. Every message created after it is hidden message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # When true, `message_id` is hidden too and the message before it becomes the newest visible message inclusive: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="inclusive") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class RewindChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # A rewind of an agent channel rewind: "ChannelRewindResponse" = dc_field(metadata=dc_config(field_name="rewind")) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @dataclass class RingAttemptResponse(DataClassJsonMixin): # The application this ring belongs to app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) # The ID of the call that was rung call_id: str = dc_field(metadata=dc_config(field_name="call_id")) # The type of the call that was rung call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # When the ring went out created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # When the ring expires, i.e. when the missed call deadline fires expires_at: datetime = dc_field( metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The user that started the ring initiated_by: str = dc_field(metadata=dc_config(field_name="initiated_by")) # The derived outcome: ringing, answered_some, answered_all, rejected_all, missed_all, cancelled or mixed outcome: str = dc_field(metadata=dc_config(field_name="outcome")) # The ring, as published in the ring_id of the call.ring event ring_id: str = dc_field(metadata=dc_config(field_name="ring_id")) # The call session that was rung session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # Why the ring settled: answered, rejected, cancel, timeout, ended or auto_end; empty while it is still ringing settle_reason: str = dc_field(metadata=dc_config(field_name="settle_reason")) # The user that settled the ring, or 'server'; empty while it is still ringing settled_by: str = dc_field(metadata=dc_config(field_name="settled_by")) # Opaque context stored on the ring by the caller custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The rung users, keyed by user ID targets: "Dict[str, RingTargetResponse]" = dc_field( metadata=dc_config(field_name="targets") ) # When the ring was deleted deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the outcome left ringing settled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="settled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class RingCallRequest(DataClassJsonMixin): # Indicate if call should be video video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="video") ) # Members that should receive the ring. If no ids are provided, all call members who are not already in the call will receive ring notifications. members_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="members_ids") ) # Opaque context stored on the ring attempt; refs and IDs only custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class RingCallResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of members ringing notification was sent to members_ids: List[str] = dc_field(metadata=dc_config(field_name="members_ids")) # The ring this call created, for correlating the accept, reject and missed outcomes that follow ring_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ring_id") ) @dataclass class RingDeliveryResponse(DataClassJsonMixin): # The transport the ring was dispatched over: ws, apns_voip, apns or fcm channel: str = dc_field(metadata=dc_config(field_name="channel")) # When the ring was dispatched sent_at: datetime = dc_field( metadata=dc_config( field_name="sent_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # When the device acknowledged the ring; not populated yet acked_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="acked_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The device the ring was dispatched to, empty for websocket deliveries which fan out to every connection device_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="device_id") ) # When the device displayed the ring; not populated yet displayed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="displayed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the device fetched the call; not populated yet fetched_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="fetched_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # When the push provider accepted the dispatch; not populated yet provider_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="provider_accepted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class RingSettings(DataClassJsonMixin): auto_cancel_timeout_ms: int = dc_field( metadata=dc_config(field_name="auto_cancel_timeout_ms") ) incoming_call_timeout_ms: int = dc_field( metadata=dc_config(field_name="incoming_call_timeout_ms") ) missed_call_timeout_ms: int = dc_field( metadata=dc_config(field_name="missed_call_timeout_ms") ) @dataclass class RingSettingsRequest(DataClassJsonMixin): # When none of the callees accept a ring call in this time a rejection will be sent by the caller with reason 'timeout' by the SDKs auto_cancel_timeout_ms: int = dc_field( metadata=dc_config(field_name="auto_cancel_timeout_ms") ) # When a callee is online but doesn't answer a ring call in this time a rejection will be sent with reason 'timeout' by the SDKs incoming_call_timeout_ms: int = dc_field( metadata=dc_config(field_name="incoming_call_timeout_ms") ) # When a callee doesn't accept or reject a ring call in this time a missed call event will be sent missed_call_timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="missed_call_timeout_ms") ) @dataclass class RingSettingsResponse(DataClassJsonMixin): auto_cancel_timeout_ms: int = dc_field( metadata=dc_config(field_name="auto_cancel_timeout_ms") ) incoming_call_timeout_ms: int = dc_field( metadata=dc_config(field_name="incoming_call_timeout_ms") ) missed_call_timeout_ms: int = dc_field( metadata=dc_config(field_name="missed_call_timeout_ms") ) @dataclass class RingSettledTarget(DataClassJsonMixin): state: str = dc_field(metadata=dc_config(field_name="state")) state_at: datetime = dc_field( metadata=dc_config( field_name="state_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class RingTargetResponse(DataClassJsonMixin): # The reject or cancel reason, empty otherwise reason: str = dc_field(metadata=dc_config(field_name="reason")) # The target's state for this ring: pending, accepted, rejected, missed or cancelled state: str = dc_field(metadata=dc_config(field_name="state")) # When the target last changed state state_at: datetime = dc_field( metadata=dc_config( field_name="state_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The dispatches of this ring to the target's devices deliveries: "List[RingDeliveryResponse]" = dc_field( metadata=dc_config(field_name="deliveries") ) @dataclass class Role(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Whether this is a custom role or built-in custom: bool = dc_field(metadata=dc_config(field_name="custom")) # Unique role name name: str = dc_field(metadata=dc_config(field_name="name")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # List of scopes where this role is currently present. `.app` means that role is present in app-level grants scopes: List[str] = dc_field(metadata=dc_config(field_name="scopes")) @dataclass class RuleBuilderAction(DataClassJsonMixin): reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) skip_inbox: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_inbox") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) ban_options: "Optional[BanOptions]" = dc_field( default=None, metadata=dc_config(field_name="ban_options") ) call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) flag_user_options: "Optional[FlagUserOptions]" = dc_field( default=None, metadata=dc_config(field_name="flag_user_options") ) @dataclass class RuleBuilderCondition(DataClassJsonMixin): confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # app_channel_count params: fires when the app creates at least threshold distinct channels within time_window app_channel_count_params: "Optional[AppChannelCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="app_channel_count_params") ) # app_message_count params: fires when the app sends at least threshold chat messages within time_window app_message_count_params: "Optional[AppMessageCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="app_message_count_params") ) call_custom_property_params: "Optional[CallCustomPropertyParameters]" = dc_field( default=None, metadata=dc_config(field_name="call_custom_property_params") ) call_type_rule_params: "Optional[CallTypeRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="call_type_rule_params") ) call_violation_count_params: "Optional[CallViolationCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="call_violation_count_params") ) channel_message_count_rule_params: "Optional[ChannelMessageCountRuleParameters]" = ( dc_field( default=None, metadata=dc_config(field_name="channel_message_count_rule_params"), ) ) closed_caption_rule_params: "Optional[ClosedCaptionRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="closed_caption_rule_params") ) content_count_rule_params: "Optional[ContentCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_count_rule_params") ) content_country_code_params: "Optional[ContentCountryCodeParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_country_code_params") ) content_custom_property_count_params: "Optional[ContentCustomPropertyCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_custom_property_count_params"), ) content_custom_property_params: "Optional[ContentCustomPropertyParameters]" = ( dc_field( default=None, metadata=dc_config(field_name="content_custom_property_params"), ) ) content_flag_count_rule_params: "Optional[FlagCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_flag_count_rule_params") ) flood_identical_params: "Optional[FloodIdenticalRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="flood_identical_params") ) flood_similar_params: "Optional[FloodSimilarRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="flood_similar_params") ) image_content_params: "Optional[ImageContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="image_content_params") ) image_rule_params: "Optional[ImageRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="image_rule_params") ) # intent_rule params: policy intent topic label and the minimum final score (1-100) that fires the condition intent_rule_params: "Optional[IntentRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="intent_rule_params") ) ip_content_count_rule_params: "Optional[IPContentCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="ip_content_count_rule_params") ) ip_flag_count_rule_params: "Optional[IPFlagCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="ip_flag_count_rule_params") ) keyframe_ocr_rule_params: "Optional[KeyframeOCRRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_ocr_rule_params") ) keyframe_rule_params: "Optional[KeyframeRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_rule_params") ) ocr_content_params: "Optional[OCRContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="ocr_content_params") ) text_content_params: "Optional[TextContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="text_content_params") ) text_rule_params: "Optional[TextRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="text_rule_params") ) user_channel_ban_count_params: "Optional[UserChannelBanCountRuleParameters]" = ( dc_field( default=None, metadata=dc_config(field_name="user_channel_ban_count_params") ) ) user_channel_count_params: "Optional[UserChannelCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_channel_count_params") ) user_created_within_params: "Optional[UserCreatedWithinParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_created_within_params") ) user_custom_property_params: "Optional[UserCustomPropertyParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_custom_property_params") ) user_flag_count_rule_params: "Optional[FlagCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_flag_count_rule_params") ) user_identical_content_count_params: "Optional[UserIdenticalContentCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_identical_content_count_params"), ) user_identical_image_count_params: "Optional[UserIdenticalImageCountParameters]" = ( dc_field( default=None, metadata=dc_config(field_name="user_identical_image_count_params"), ) ) user_reaction_count_params: "Optional[UserReactionCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_reaction_count_params") ) user_role_params: "Optional[UserRoleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_role_params") ) user_rule_params: "Optional[UserRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_rule_params") ) video_content_params: "Optional[VideoContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="video_content_params") ) video_rule_params: "Optional[VideoRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="video_rule_params") ) @dataclass class RuleBuilderConditionGroup(DataClassJsonMixin): logic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="logic") ) conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) @dataclass class RuleBuilderConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) rules: "Optional[List[RuleBuilderRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class RuleBuilderRule(DataClassJsonMixin): rule_type: str = dc_field(metadata=dc_config(field_name="rule_type")) cooldown_period: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) logic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="logic") ) action_sequences: "Optional[List[CallRuleActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) @dataclass class RunStats(DataClassJsonMixin): activities_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="activities_deleted") ) channels_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channels_deleted") ) messages_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="messages_deleted") ) @dataclass class S3Request(DataClassJsonMixin): # The AWS region where the bucket is hosted s3_region: str = dc_field(metadata=dc_config(field_name="s3_region")) # The AWS API key. To use Amazon S3 as your storage provider, you have two authentication options: IAM role or API key. If you do not specify the `s3_api_key` parameter, Stream will use IAM role authentication. In that case make sure to have the correct IAM role configured for your application. s3_api_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_api_key") ) # The custom endpoint for S3. If you want to use a custom endpoint, you must also provide the `s3_api_key` and `s3_secret` parameters. s3_custom_endpoint_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_custom_endpoint_url") ) # The AWS API Secret s3_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_secret") ) @dataclass class SDKUsageReport(DataClassJsonMixin): per_sdk_usage: "Dict[str, Optional[PerSDKUsageReport]]" = dc_field( metadata=dc_config(field_name="per_sdk_usage") ) @dataclass class SDKUsageReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateSDKUsageReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class SFULocationResponse(DataClassJsonMixin): datacenter: str = dc_field(metadata=dc_config(field_name="datacenter")) id: str = dc_field(metadata=dc_config(field_name="id")) # Geographic coordinates coordinates: "CoordinatesResponse" = dc_field( metadata=dc_config(field_name="coordinates") ) # Geographic location metadata location: "LocationResponse" = dc_field(metadata=dc_config(field_name="location")) count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="count") ) @dataclass class SIPCallConfigsRequest(DataClassJsonMixin): # Custom data associated with the call custom_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_data") ) @dataclass class SIPCallConfigsResponse(DataClassJsonMixin): # Custom data associated with the call custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="custom_data") ) @dataclass class SIPCallerConfigsRequest(DataClassJsonMixin): # Unique identifier for the caller (handlebars template) id: str = dc_field(metadata=dc_config(field_name="id")) # Custom data associated with the caller (values are handlebars templates) custom_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_data") ) @dataclass class SIPCallerConfigsResponse(DataClassJsonMixin): # Unique identifier for the caller id: str = dc_field(metadata=dc_config(field_name="id")) # Custom data associated with the caller custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="custom_data") ) @dataclass class SIPChallengeRequest(DataClassJsonMixin): # Deprecated: A1 hash for backward compatibility a1: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="a1")) # Hash algorithm (e.g., MD5, SHA-256) algorithm: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="algorithm") ) # Character set charset: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="charset") ) # Client nonce for qop=auth cnonce: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cnonce") ) # SIP method (e.g., INVITE) method: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="method") ) # Nonce count for qop=auth nc: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="nc")) # Server nonce nonce: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="nonce") ) # Opaque value opaque: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="opaque") ) # Authentication realm realm: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="realm") ) # Digest response hash from client response: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="response") ) # Whether the nonce is stale stale: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stale") ) # Request URI uri: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="uri")) # Whether to hash the username userhash: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="userhash") ) # Username for authentication username: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="username") ) # Domain list domain: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="domain") ) # Quality of protection options qop: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="qop") ) @dataclass class SIPDirectRoutingRuleCallConfigsRequest(DataClassJsonMixin): # ID of the call (handlebars template) call_id: str = dc_field(metadata=dc_config(field_name="call_id")) # Type of the call call_type: str = dc_field(metadata=dc_config(field_name="call_type")) @dataclass class SIPDirectRoutingRuleCallConfigsResponse(DataClassJsonMixin): # ID of the call call_id: str = dc_field(metadata=dc_config(field_name="call_id")) # Type of the call call_type: str = dc_field(metadata=dc_config(field_name="call_type")) @dataclass class SIPInboundRoutingRulePinConfigsRequest(DataClassJsonMixin): # Optional webhook URL for custom PIN handling custom_webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="custom_webhook_url") ) # Prompt message for failed PIN attempts pin_failed_attempt_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_failed_attempt_prompt") ) # Prompt message for hangup after PIN input pin_hangup_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_hangup_prompt") ) # Prompt message for PIN input pin_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_prompt") ) # Prompt message for successful PIN input pin_success_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_success_prompt") ) @dataclass class SIPInboundRoutingRulePinConfigsResponse(DataClassJsonMixin): # Optional webhook URL for custom PIN handling custom_webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="custom_webhook_url") ) # Prompt message for failed PIN attempts pin_failed_attempt_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_failed_attempt_prompt") ) # Prompt message for hangup after PIN input pin_hangup_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_hangup_prompt") ) # Prompt message for PIN input pin_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_prompt") ) # Prompt message for successful PIN input pin_success_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_success_prompt") ) @dataclass class SIPInboundRoutingRuleRequest(DataClassJsonMixin): # Name of the SIP Inbound Routing Rule name: str = dc_field(metadata=dc_config(field_name="name")) # List of SIP trunk IDs trunk_ids: List[str] = dc_field(metadata=dc_config(field_name="trunk_ids")) # Configuration for SIP caller settings caller_configs: "SIPCallerConfigsRequest" = dc_field( metadata=dc_config(field_name="caller_configs") ) # List of called numbers called_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="called_numbers") ) # List of caller numbers (optional) caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # Configuration for SIP call settings call_configs: "Optional[SIPCallConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # Configuration for direct routing rule calls direct_routing_configs: "Optional[SIPDirectRoutingRuleCallConfigsRequest]" = ( dc_field(default=None, metadata=dc_config(field_name="direct_routing_configs")) ) # Configuration for PIN protection settings pin_protection_configs: "Optional[SIPPinProtectionConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_protection_configs") ) # Configuration for PIN routing rule calls pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @dataclass class SIPInboundRoutingRuleResponse(DataClassJsonMixin): # Creation timestamp created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Unique identifier of the SIP Inbound Routing Rule id: str = dc_field(metadata=dc_config(field_name="id")) # Name of the SIP Inbound Routing Rule name: str = dc_field(metadata=dc_config(field_name="name")) # Last update timestamp updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # List of called numbers called_numbers: List[str] = dc_field( metadata=dc_config(field_name="called_numbers") ) # List of SIP trunk IDs trunk_ids: List[str] = dc_field(metadata=dc_config(field_name="trunk_ids")) # List of caller numbers caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # SIP call configuration response call_configs: "Optional[SIPCallConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # SIP caller configuration response caller_configs: "Optional[SIPCallerConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="caller_configs") ) # Direct routing rule call configuration response direct_routing_configs: "Optional[SIPDirectRoutingRuleCallConfigsResponse]" = ( dc_field(default=None, metadata=dc_config(field_name="direct_routing_configs")) ) # PIN protection configuration response pin_protection_configs: "Optional[SIPPinProtectionConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="pin_protection_configs") ) # PIN routing rule call configuration response pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @dataclass class SIPPinProtectionConfigsRequest(DataClassJsonMixin): # Default PIN to use if there is no PIN set on the call object default_pin: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_pin") ) # Whether PIN protection is enabled enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Maximum number of PIN attempts allowed max_attempts: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_attempts") ) # Number of digits required for the PIN required_pin_digits: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="required_pin_digits") ) @dataclass class SIPPinProtectionConfigsResponse(DataClassJsonMixin): # Whether PIN protection is enabled enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) # Default PIN to use if there is no PIN set on the call object default_pin: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_pin") ) # Maximum number of PIN attempts allowed max_attempts: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_attempts") ) # Number of digits required for the PIN required_pin_digits: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="required_pin_digits") ) @dataclass class SIPTrunkResponse(DataClassJsonMixin): # Creation timestamp created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier for the SIP trunk id: str = dc_field(metadata=dc_config(field_name="id")) # Name of the SIP trunk name: str = dc_field(metadata=dc_config(field_name="name")) # Password for SIP trunk authentication password: str = dc_field(metadata=dc_config(field_name="password")) # Last update timestamp updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The URI for the SIP trunk uri: str = dc_field(metadata=dc_config(field_name="uri")) # Username for SIP trunk authentication username: str = dc_field(metadata=dc_config(field_name="username")) # Allowed IPv4/IPv6 addresses or CIDR blocks allowed_ips: List[str] = dc_field(metadata=dc_config(field_name="allowed_ips")) # Phone numbers associated with this SIP trunk numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) @dataclass class SRTIngress(DataClassJsonMixin): address: str = dc_field(metadata=dc_config(field_name="address")) @dataclass class ScheduledMessageChannelResponse(DataClassJsonMixin): # Channel CID (:) cid: str = dc_field(metadata=dc_config(field_name="cid")) # Channel ID id: str = dc_field(metadata=dc_config(field_name="id")) # Channel type type: str = dc_field(metadata=dc_config(field_name="type")) # Channel image, from its custom data image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) # Channel name, from its custom data name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) @dataclass class ScheduledMessageContentResponse(DataClassJsonMixin): # Text of the message text: str = dc_field(metadata=dc_config(field_name="text")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Contains HTML markup of the message html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) # Whether the message mentions the whole channel mentioned_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mentioned_channel") ) # Whether the message mentions the online channel members mentioned_here: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mentioned_here") ) # MML content of the message mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date/time the pin expires pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether the message will be pinned when sent pinned: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pinned") ) # Identifier of the poll to include in the message poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) # Whether thread reply should be shown in the channel as well show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # Whether message is silent or not silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) # Contains type of the message. One of: regular, system type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # Array of message attachments attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # IDs of the user groups mentioned in the message mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) # Roles mentioned in the message mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) # IDs of the users mentioned in the message mentioned_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) # IDs of the users the message will be visible to restricted_visibility: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="restricted_visibility") ) # The location a scheduled message will share shared_location: "Optional[ScheduledMessageLocation]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class ScheduledMessageFailedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "scheduled_message.failed" in this case type: str = dc_field( default="scheduled_message.failed", metadata=dc_config(field_name="type") ) # The CID of the channel the message is scheduled in cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # A message scheduled to be sent later scheduled_message: "Optional[ScheduledMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_message") ) ScheduledMessageFailureReasonType = NewType("ScheduledMessageFailureReasonType", str) class ScheduledMessageFailureReason: BANNED: Final[ScheduledMessageFailureReasonType] = "banned" CHANNEL_DELETED: Final[ScheduledMessageFailureReasonType] = "channel_deleted" CHANNEL_FROZEN: Final[ScheduledMessageFailureReasonType] = "channel_frozen" EXPIRED: Final[ScheduledMessageFailureReasonType] = "expired" HOOK_REJECTED: Final[ScheduledMessageFailureReasonType] = "hook_rejected" INTERNAL_ERROR: Final[ScheduledMessageFailureReasonType] = "internal_error" INVALID_MESSAGE: Final[ScheduledMessageFailureReasonType] = "invalid_message" MODERATION_BLOCKED: Final[ScheduledMessageFailureReasonType] = "moderation_blocked" NO_PERMISSION: Final[ScheduledMessageFailureReasonType] = "no_permission" PENDING_NOT_SUPPORTED: Final[ScheduledMessageFailureReasonType] = ( "pending_not_supported" ) USER_DELETED: Final[ScheduledMessageFailureReasonType] = "user_deleted" @dataclass class ScheduledMessageLocation(DataClassJsonMixin): # The ID of the device that created the location. created_by_device_id: str = dc_field( metadata=dc_config(field_name="created_by_device_id") ) # The date when the location sharing ends. # If it's empty, it means the location sharing is static instead of live. end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The latitude of the location. latitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latitude") ) # The longitude of the location. longitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="longitude") ) ScheduledMessageQueryStatusType = NewType("ScheduledMessageQueryStatusType", str) class ScheduledMessageQueryStatus: FAILED: Final[ScheduledMessageQueryStatusType] = "failed" SCHEDULED: Final[ScheduledMessageQueryStatusType] = "scheduled" SENDING: Final[ScheduledMessageQueryStatusType] = "sending" @dataclass class ScheduledMessageResponse(DataClassJsonMixin): # The CID of the channel the message will be sent to cid: str = dc_field(metadata=dc_config(field_name="cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique identifier of the scheduled message id: str = dc_field(metadata=dc_config(field_name="id")) # Date/time the message is scheduled to be sent scheduled_at: datetime = dc_field( metadata=dc_config( field_name="scheduled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Status of the scheduled message. One of: scheduled, sending, failed, canceled, sent. A message is sending from its first send attempt until it is sent or fails, including while it waits to retry a failed attempt; it cannot be edited, canceled or sent now while sending status: "ScheduledMessageStatus" = dc_field(metadata=dc_config(field_name="status")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The message a scheduled message will send message: "ScheduledMessageContentResponse" = dc_field( metadata=dc_config(field_name="message") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Why sending the message failed. Only set when status is failed. One of: banned, no_permission, channel_frozen, channel_deleted, user_deleted, moderation_blocked, hook_rejected, expired, internal_error, invalid_message, pending_not_supported failure_reason: "Optional[ScheduledMessageFailureReason]" = dc_field( default=None, metadata=dc_config(field_name="failure_reason") ) # The channel of a scheduled message channel: "Optional[ScheduledMessageChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @dataclass class ScheduledMessageSentEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the message that was sent message_id: str = dc_field(metadata=dc_config(field_name="message_id")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "scheduled_message.sent" in this case type: str = dc_field( default="scheduled_message.sent", metadata=dc_config(field_name="type") ) # The CID of the channel the message was sent to cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # A message scheduled to be sent later scheduled_message: "Optional[ScheduledMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_message") ) ScheduledMessageStatusType = NewType("ScheduledMessageStatusType", str) class ScheduledMessageStatus: CANCELED: Final[ScheduledMessageStatusType] = "canceled" FAILED: Final[ScheduledMessageStatusType] = "failed" SCHEDULED: Final[ScheduledMessageStatusType] = "scheduled" SENDING: Final[ScheduledMessageStatusType] = "sending" SENT: Final[ScheduledMessageStatusType] = "sent" @dataclass class ScheduledMessagesFilter(DataClassJsonMixin): # Only scheduled messages of this channel cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Only these statuses, as reported in each scheduled message's status. One or more of: scheduled, sending, failed status: "Optional[List[ScheduledMessageQueryStatus]]" = dc_field( default=None, metadata=dc_config(field_name="status") ) @dataclass class ScoreBands(DataClassJsonMixin): good: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="good") ) ok: Optional[float] = dc_field(default=None, metadata=dc_config(field_name="ok")) poor: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor") ) @dataclass class ScreensharingSettings(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @dataclass class ScreensharingSettingsRequest(DataClassJsonMixin): access_request_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="access_request_enabled") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @dataclass class ScreensharingSettingsResponse(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @dataclass class SearchPayload(DataClassJsonMixin): # Channel filter conditions filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) force_default_search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_default_search") ) force_sql_v2_backend: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_sql_v2_backend") ) # Number of messages to return limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) # Pagination parameter. Cannot be used with non-zero offset. next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Pagination offset. Cannot be used with sort or next. offset: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="offset") ) # Search phrase query: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="query") ) # Sort parameters. Cannot be used with non-zero offset sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Message filter conditions message_filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="message_filter_conditions") ) message_options: "Optional[MessageOptions]" = dc_field( default=None, metadata=dc_config(field_name="message_options") ) @dataclass class SearchResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Search results results: "List[SearchResult]" = dc_field(metadata=dc_config(field_name="results")) # Value to pass to the next search query in order to paginate next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Value that points to the previous page. Pass as the next value in a search query to paginate backwards previous: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="previous") ) results_warning: "Optional[SearchWarning]" = dc_field( default=None, metadata=dc_config(field_name="results_warning") ) @dataclass class SearchResult(DataClassJsonMixin): message: "Optional[SearchResultMessage]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class SearchResultMessage(DataClassJsonMixin): cid: str = dc_field(metadata=dc_config(field_name="cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_reply_count: int = dc_field( metadata=dc_config(field_name="deleted_reply_count") ) html: str = dc_field(metadata=dc_config(field_name="html")) id: str = dc_field(metadata=dc_config(field_name="id")) mentioned_channel: bool = dc_field( metadata=dc_config(field_name="mentioned_channel") ) mentioned_here: bool = dc_field(metadata=dc_config(field_name="mentioned_here")) pinned: bool = dc_field(metadata=dc_config(field_name="pinned")) reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) shadowed: bool = dc_field(metadata=dc_config(field_name="shadowed")) silent: bool = dc_field(metadata=dc_config(field_name="silent")) text: str = dc_field(metadata=dc_config(field_name="text")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) own_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) restricted_visibility: List[str] = dc_field( metadata=dc_config(field_name="restricted_visibility") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction_counts: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_counts") ) reaction_scores: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="reaction_scores") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class SearchRolesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Matching roles, sorted ascending by name roles: "List[Role]" = dc_field(metadata=dc_config(field_name="roles")) @dataclass class SearchUserGroupsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of matching user groups user_groups: "List[UserGroupResponse]" = dc_field( metadata=dc_config(field_name="user_groups") ) @dataclass class SearchWarning(DataClassJsonMixin): # Code corresponding to the warning warning_code: int = dc_field(metadata=dc_config(field_name="warning_code")) # Description of the warning warning_description: str = dc_field( metadata=dc_config(field_name="warning_description") ) # Number of channels searched channel_search_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_search_count") ) # Channel CIDs for the searched channels channel_search_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_search_cids") ) @dataclass class Segment(DataClassJsonMixin): all_sender_channels: bool = dc_field( metadata=dc_config(field_name="all_sender_channels") ) all_users: bool = dc_field(metadata=dc_config(field_name="all_users")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) size: int = dc_field(metadata=dc_config(field_name="size")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class SegmentResponse(DataClassJsonMixin): all_sender_channels: bool = dc_field( metadata=dc_config(field_name="all_sender_channels") ) all_users: bool = dc_field(metadata=dc_config(field_name="all_users")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) deleted_at: datetime = dc_field( metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) description: str = dc_field(metadata=dc_config(field_name="description")) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) size: int = dc_field(metadata=dc_config(field_name="size")) type: str = dc_field(metadata=dc_config(field_name="type")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) @dataclass class SegmentTargetResponse(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) segment_id: str = dc_field(metadata=dc_config(field_name="segment_id")) target_id: str = dc_field(metadata=dc_config(field_name="target_id")) @dataclass class Segments(DataClassJsonMixin): by_country_reason: str = dc_field( metadata=dc_config(field_name="by_country_reason") ) by_browser: "List[BroadcastSegment]" = dc_field( metadata=dc_config(field_name="by_browser") ) by_country: "List[BroadcastSegment]" = dc_field( metadata=dc_config(field_name="by_country") ) by_delivery_zone: "List[DeliveryZoneSegment]" = dc_field( metadata=dc_config(field_name="by_delivery_zone") ) by_os: "List[BroadcastSegment]" = dc_field(metadata=dc_config(field_name="by_os")) by_sdk: "List[BroadcastSegment]" = dc_field(metadata=dc_config(field_name="by_sdk")) @dataclass class SendCallEventRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class SendCallEventResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class SendClosedCaptionRequest(DataClassJsonMixin): speaker_id: str = dc_field(metadata=dc_config(field_name="speaker_id")) text: str = dc_field(metadata=dc_config(field_name="text")) end_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) service: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="service") ) start_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="start_time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) translated: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="translated") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class SendClosedCaptionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class SendEventRequest(DataClassJsonMixin): event: "EventRequest" = dc_field(metadata=dc_config(field_name="event")) @dataclass class SendMessageRequest(DataClassJsonMixin): # Message data for creating or updating a message message: "MessageRequest" = dc_field(metadata=dc_config(field_name="message")) force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # When true, the response includes channel_context: a slim channel object with cid, type, id and created_by include_channel_context: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_channel_context") ) # When true, the response includes mentioned_members: for each mentioned user, whether that user is currently a channel member. Requires the ReadChannelMembers permission include_mentioned_members: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_mentioned_members") ) keep_channel_hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_channel_hidden") ) pending: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pending") ) # When set to a future time, the message is not sent now: it is stored and sent at that time (UTC), rounded up to the first whole minute that is at least 1 minute from now, never earlier than requested. The response then carries scheduled_message with the rounded time. Must be at most the app's maximum lead time (120 days by default) from now. A time that is now or in the past sends the message now as if scheduled_at was not set, unless the request's message ID belongs to a scheduled message that was canceled or already sent. Slash commands cannot be scheduled scheduled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @dataclass class SendMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # Slim channel object: identity plus creator channel_context: "Optional[ChannelContextResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel_context") ) # Map of mentioned user ID to whether that user is currently an active channel member. Only set when include_mentioned_members was requested; omitted when the message has no mentions or the membership lookup failed mentioned_members: "Optional[Dict[str, bool]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_members") ) # Pending message metadata pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) # A message scheduled to be sent later scheduled_message: "Optional[ScheduledMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="scheduled_message") ) @dataclass class SendReactionRequest(DataClassJsonMixin): # Represents user reaction to a message reaction: "ReactionRequest" = dc_field(metadata=dc_config(field_name="reaction")) # Whether to replace all existing user reactions enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) # Skips any mobile push notifications skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) @dataclass class SendReactionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) reaction: "ReactionResponse" = dc_field(metadata=dc_config(field_name="reaction")) @dataclass class SendScheduledMessageNowResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # A message scheduled to be sent later scheduled_message: "ScheduledMessageResponse" = dc_field( metadata=dc_config(field_name="scheduled_message") ) @dataclass class SendUserCustomEventRequest(DataClassJsonMixin): event: "UserCustomEventRequest" = dc_field(metadata=dc_config(field_name="event")) @dataclass class SessionClient(DataClassJsonMixin): ip: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="ip")) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) network_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="network_type") ) version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class SessionSettings(DataClassJsonMixin): inactivity_timeout_seconds: int = dc_field( metadata=dc_config(field_name="inactivity_timeout_seconds") ) @dataclass class SessionSettingsRequest(DataClassJsonMixin): inactivity_timeout_seconds: int = dc_field( metadata=dc_config(field_name="inactivity_timeout_seconds") ) @dataclass class SessionSettingsResponse(DataClassJsonMixin): inactivity_timeout_seconds: int = dc_field( metadata=dc_config(field_name="inactivity_timeout_seconds") ) @dataclass class SessionWarningResponse(DataClassJsonMixin): code: str = dc_field(metadata=dc_config(field_name="code")) warning: str = dc_field(metadata=dc_config(field_name="warning")) time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="time", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class SetFeedsRetentionPolicyRequest(DataClassJsonMixin): max_age_hours: int = dc_field(metadata=dc_config(field_name="max_age_hours")) policy: str = dc_field(metadata=dc_config(field_name="policy")) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) feed_groups: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) @dataclass class SetFeedsRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) policy: "FeedsRetentionPolicy" = dc_field(metadata=dc_config(field_name="policy")) @dataclass class SetHistoryWindowTeamsRequest(DataClassJsonMixin): # Teams to give full history, 1 to 10, each listed once. Marking a team that already has full history keeps its created_at teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) @dataclass class SetHistoryWindowTeamsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The teams of the request, each with full history teams: "List[HistoryWindowTeam]" = dc_field(metadata=dc_config(field_name="teams")) @dataclass class SetRetentionPolicyRequest(DataClassJsonMixin): max_age_hours: int = dc_field(metadata=dc_config(field_name="max_age_hours")) # What a retention policy applies to. policy: "RetentionPolicyType" = dc_field(metadata=dc_config(field_name="policy")) channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) @dataclass class SetRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) policy: "RetentionPolicy" = dc_field(metadata=dc_config(field_name="policy")) channel_type_rule: "Optional[ChannelTypeRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel_type_rule") ) @dataclass class SetupSession(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # A step in the moderation setup wizard. current_step: "SetupStep" = dc_field(metadata=dc_config(field_name="current_step")) # Whether a moderation setup session is still in progress. status: "SetupStatus" = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) setup_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="setup_data") ) completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) SetupStatusType = NewType("SetupStatusType", str) class SetupStatus: COMPLETED: Final[SetupStatusType] = "completed" IN_PROGRESS: Final[SetupStatusType] = "in_progress" SetupStepType = NewType("SetupStepType", str) class SetupStep: CONFIGURE: Final[SetupStepType] = "configure" INPUT: Final[SetupStepType] = "input" LIVE: Final[SetupStepType] = "live" WELCOME: Final[SetupStepType] = "welcome" @dataclass class ShadowBlockActionRequestPayload(DataClassJsonMixin): # Reason for shadow blocking reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) @dataclass class ShareResponse(DataClassJsonMixin): # ID of the sharing (child) activity activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) # When the share occurred created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) @dataclass class SharedLocation(DataClassJsonMixin): latitude: float = dc_field(metadata=dc_config(field_name="latitude")) longitude: float = dc_field(metadata=dc_config(field_name="longitude")) created_by_device_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_device_id") ) end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class SharedLocationResponse(DataClassJsonMixin): # Channel CID channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Device ID that created the live location created_by_device_id: str = dc_field( metadata=dc_config(field_name="created_by_device_id") ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Latitude coordinate latitude: float = dc_field(metadata=dc_config(field_name="latitude")) # Longitude coordinate longitude: float = dc_field(metadata=dc_config(field_name="longitude")) # Message ID message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User ID user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Time when the live location expires end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class SharedLocationResponseData(DataClassJsonMixin): # The CID (type:id) of the channel that the location is attached to. channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # The date when the location was created. created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the device that created the location. created_by_device_id: str = dc_field( metadata=dc_config(field_name="created_by_device_id") ) # The latitude of the location. latitude: float = dc_field(metadata=dc_config(field_name="latitude")) # The longitude of the location. longitude: float = dc_field(metadata=dc_config(field_name="longitude")) # The ID of the message that the location is attached to. message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # The date when the location was updated. updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the user that created the location. user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # The date when the location sharing ends. # If it's empty, it means the location sharing is static instead of live. end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class SharedLocationsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) active_live_locations: "List[SharedLocationResponseData]" = dc_field( metadata=dc_config(field_name="active_live_locations") ) @dataclass class ShowChannelRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ShowChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class SingleFollowResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) # Whether a notification activity was successfully created notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @dataclass class SipInboundCredentials(DataClassJsonMixin): # API key for the application api_key: str = dc_field(metadata=dc_config(field_name="api_key")) # ID of the call call_id: str = dc_field(metadata=dc_config(field_name="call_id")) # Type of the call call_type: str = dc_field(metadata=dc_config(field_name="call_type")) # Authentication token for the call token: str = dc_field(metadata=dc_config(field_name="token")) # User ID for the call user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Custom data associated with the call call_custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="call_custom_data") ) # Custom data associated with the user user_custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="user_custom_data") ) @dataclass class SortParam(DataClassJsonMixin): direction: int = dc_field(metadata=dc_config(field_name="direction")) field: str = dc_field(metadata=dc_config(field_name="field")) type: str = dc_field(metadata=dc_config(field_name="type")) @dataclass class SortParamRequest(DataClassJsonMixin): # Direction of sorting, 1 for Ascending, -1 for Descending, default is 1. One of: -1, 1 direction: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="direction") ) # Name of field to sort by field: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="field") ) # Type of field to sort by. Empty string or omitted means string type (default). One of: number, boolean type: "Optional[SortParamType]" = dc_field( default=None, metadata=dc_config(field_name="type") ) SortParamTypeType = NewType("SortParamTypeType", str) class SortParamType: BOOLEAN: Final[SortParamTypeType] = "boolean" EMPTY: Final[SortParamTypeType] = "" NUMBER: Final[SortParamTypeType] = "number" @dataclass class SourceHealth(DataClassJsonMixin): co_host_peak: int = dc_field(metadata=dc_config(field_name="co_host_peak")) dead_air_s: int = dc_field(metadata=dc_config(field_name="dead_air_s")) interruptions: "List[SourceInterruption]" = dc_field( metadata=dc_config(field_name="interruptions") ) publisher_sessions: "List[PublisherSession]" = dc_field( metadata=dc_config(field_name="publisher_sessions") ) @dataclass class SourceInterruption(DataClassJsonMixin): at_offset_min: float = dc_field(metadata=dc_config(field_name="at_offset_min")) dead_air_s: int = dc_field(metadata=dc_config(field_name="dead_air_s")) kind: str = dc_field(metadata=dc_config(field_name="kind")) seamless: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="seamless") ) @dataclass class SpeechSegmentConfig(DataClassJsonMixin): max_speech_caption_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_speech_caption_ms") ) silence_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="silence_duration_ms") ) @dataclass class StartCampaignRequest(DataClassJsonMixin): scheduled_for: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_for", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) stop_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="stop_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class StartCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @dataclass class StartClosedCaptionsRequest(DataClassJsonMixin): # Enable transcriptions along with closed captions enable_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_transcription") ) # Which external storage to use for transcriptions (only applicable if enable_transcription is true) external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) # The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) speech_segment_config: "Optional[SpeechSegmentConfig]" = dc_field( default=None, metadata=dc_config(field_name="speech_segment_config") ) @dataclass class StartClosedCaptionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StartFrameRecordingRequest(DataClassJsonMixin): recording_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_external_storage") ) @dataclass class StartFrameRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StartHLSBroadcastingResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # the URL of the HLS playlist playlist_url: str = dc_field(metadata=dc_config(field_name="playlist_url")) @dataclass class StartRTMPBroadcastsRequest(DataClassJsonMixin): # List of broadcasts to start broadcasts: "List[RTMPBroadcastRequest]" = dc_field( metadata=dc_config(field_name="broadcasts") ) @dataclass class StartRTMPBroadcastsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StartRecordingRequest(DataClassJsonMixin): recording_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_external_storage") ) @dataclass class StartRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StartTranscriptionRequest(DataClassJsonMixin): # Enable closed captions along with transcriptions enable_closed_captions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_closed_captions") ) # The spoken language in the call, if not provided the language defined in the transcription settings will be used. One of: auto, ar, bg, ca, cs, da, de, el, en, es, et, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sk, sl, sv, ta, th, tl, tr, uk, zh language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) # Store transcriptions in this external storage transcription_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="transcription_external_storage") ) @dataclass class StartTranscriptionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopAllRTMPBroadcastsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) @dataclass class StopClosedCaptionsRequest(DataClassJsonMixin): stop_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stop_transcription") ) @dataclass class StopClosedCaptionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopFrameRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopHLSBroadcastingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopLiveRequest(DataClassJsonMixin): continue_closed_caption: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_closed_caption") ) continue_composite_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_composite_recording") ) continue_hls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_hls") ) continue_individual_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_individual_recording") ) continue_raw_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_raw_recording") ) continue_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_recording") ) continue_rtmp_broadcasts: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_rtmp_broadcasts") ) continue_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_transcription") ) @dataclass class StopLiveResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class StopRTMPBroadcastsRequest(DataClassJsonMixin): pass @dataclass class StopRTMPBroadcastsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopRecordingRequest(DataClassJsonMixin): pass @dataclass class StopRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StopTranscriptionRequest(DataClassJsonMixin): stop_closed_captions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stop_closed_captions") ) @dataclass class StopTranscriptionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class StoriesConfig(DataClassJsonMixin): # Whether to skip already watched stories skip_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_watched") ) # Whether to track watched status for stories track_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_watched") ) @dataclass class StoriesFeedUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The ID of the feed fid: str = dc_field(metadata=dc_config(field_name="fid")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "feeds.stories_feed.updated" in this case type: str = dc_field( default="feeds.stories_feed.updated", metadata=dc_config(field_name="type") ) # Who can see and follow a feed. feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Individual activities for stories feeds activities: "Optional[List[ActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activities") ) # Aggregated activities for stories feeds aggregated_activities: "Optional[List[AggregatedActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="aggregated_activities") ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class SubmitActionRequest(DataClassJsonMixin): # Type of moderation action to perform. One of: mark_reviewed, delete_message, delete_activity, delete_comment, delete_reaction, delete_poll, delete_poll_option, delete_poll_answer, ban, custom, unban, restore, delete_user, delete_user_messages, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate action_type: str = dc_field(metadata=dc_config(field_name="action_type")) # UUID of the appeal to act on (required for reject_appeal, optional for other actions) appeal_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="appeal_id") ) # UUID of the review queue item to act on item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="item_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Configuration for ban moderation action ban: "Optional[BanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="ban") ) # Configuration for block action block: "Optional[BlockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="block") ) bypass: "Optional[BypassActionRequest]" = dc_field( default=None, metadata=dc_config(field_name="bypass") ) # Configuration for custom moderation action custom: "Optional[CustomActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Configuration for activity deletion action delete_activity: "Optional[DeleteActivityRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_activity") ) # Configuration for comment deletion action delete_comment: "Optional[DeleteCommentRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_comment") ) # Configuration for message deletion action delete_message: "Optional[DeleteMessageRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_message") ) # Configuration for poll deletion action. Poll deletion is always permanent. delete_poll: "Optional[DeletePollRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_poll") ) # Configuration for deleting the free-text poll answer a review item was raised for. Chat polls only. Deletion is permanent; the poll and other votes are kept. delete_poll_answer: "Optional[DeletePollAnswerRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_poll_answer") ) # Configuration for deleting the single poll option a review item was raised for. Deletion is permanent; the rest of the poll is kept. delete_poll_option: "Optional[DeletePollOptionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_poll_option") ) # Configuration for reaction deletion action delete_reaction: "Optional[DeleteReactionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_reaction") ) # Configuration for user deletion action delete_user: "Optional[DeleteUserRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_user") ) # Configuration for deleting all of a user's chat messages without banning them or deleting their account delete_user_messages: "Optional[DeleteUserMessagesRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_user_messages") ) # Configuration for escalation action escalate: "Optional[EscalatePayload]" = dc_field( default=None, metadata=dc_config(field_name="escalate") ) flag: "Optional[FlagRequest]" = dc_field( default=None, metadata=dc_config(field_name="flag") ) # Configuration for mark reviewed action mark_reviewed: "Optional[MarkReviewedRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="mark_reviewed") ) # Configuration for rejecting an appeal reject_appeal: "Optional[RejectAppealRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="reject_appeal") ) # Configuration for restore action. State-aware: reverses whichever of a delete, a block, or a shadow block currently applies to the content (including both a delete and a block/shadow block at once). restore: "Optional[RestoreActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="restore") ) # Configuration for shadow block action shadow_block: "Optional[ShadowBlockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="shadow_block") ) # Configuration for unban moderation action unban: "Optional[UnbanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unban") ) # Deprecated: Use restore instead, which now also reverses a block or shadow block. Configuration for unblock action. # Deprecated unblock: "Optional[UnblockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unblock") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class SubmitActionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Present when the appeal was accepted but the entity could not be restored automatically. The moderator should restore it manually. auto_restore_warning: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_restore_warning") ) appeal_item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal_item") ) item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @dataclass class SubmitModerationFeedbackItem(DataClassJsonMixin): # Action originally produced for this item current_recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_recommended_action") ) # ID of the moderation flag the feedback is about flag_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="flag_id") ) # Image URL, required for kind=image image_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image_url") ) # Content kind: text or image kind: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="kind")) # Identifies this piece of content within the entity (keyframe ID, caption ID, message ID, title, description, thumbnail, ...) reference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reference") ) # Text content, for kind=text text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Classifications originally produced for this item current_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="current_labels") ) @dataclass class SubmitModerationFeedbackRequest(DataClassJsonMixin): # Optional moderation channel UUID for context channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) # Moderator's confidence in this feedback (LOW, MEDIUM, HIGH, VERY_HIGH); forwarded to the moderation provider. Optional confidence: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) # Action originally produced by the moderation system current_recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_recommended_action") ) # Optional free-form note explaining why the classification was wrong description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # ID of the user who created the entity entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # ID of the entity the items belong to entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity the items belong to entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Optional moderator-supplied action expected_recommended_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expected_recommended_action") ) # Whether the referenced flags are marked (true, default) or unmarked (false) as false positives false_positive: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="false_positive") ) # false_positive (default) disputes existing detections; false_negative reports missed content: items carry the content, expected_labels is required and flag_id is not allowed feedback_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feedback_type") ) # The moderated content the moderator is providing feedback on. Required unless items is provided message: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message") ) # Original publication time of the moderated content (RFC3339). Required unless items is provided published_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="published_at") ) # Provider-side reference identifying the moderated content. Required unless items is provided reference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reference") ) # Review queue item the feedback targets, as an alternative to entity_type and entity_id review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Classifications originally produced by the moderation system current_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="current_labels") ) # Optional moderator-supplied classifications (up to 16 entries) expected_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="expected_labels") ) # Pieces of content of one entity the feedback is about (1 to 50) items: "Optional[List[SubmitModerationFeedbackItem]]" = dc_field( default=None, metadata=dc_config(field_name="items") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class SubmitModerationFeedbackResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # ID of the first stored feedback item, when any was stored feedback_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feedback_id") ) # Review queue item the feedback was applied to review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # IDs of the item's flags marked as false positives after this request false_positive_flags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="false_positive_flags") ) # IDs of the stored feedback items, one per submitted item feedback_item_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="feedback_item_ids") ) @dataclass class SubscriberAllMetrics(DataClassJsonMixin): audio: "Optional[SubscriberAudioMetrics]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) rtt_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="rtt_ms") ) video: "Optional[SubscriberVideoMetrics]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class SubscriberAudioMetrics(DataClassJsonMixin): concealment_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="concealment_pct") ) jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) packets_lost_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="packets_lost_pct") ) @dataclass class SubscriberStatsResponse(DataClassJsonMixin): total: int = dc_field(metadata=dc_config(field_name="total")) total_subscribed_duration_seconds: int = dc_field( metadata=dc_config(field_name="total_subscribed_duration_seconds") ) unique: int = dc_field(metadata=dc_config(field_name="unique")) @dataclass class SubscriberVideoMetrics(DataClassJsonMixin): fps_30: "Optional[ActiveCallsFPSStats]" = dc_field( default=None, metadata=dc_config(field_name="fps_30") ) jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) packets_lost_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="packets_lost_pct") ) @dataclass class SubscribersMetrics(DataClassJsonMixin): all: "Optional[SubscriberAllMetrics]" = dc_field( default=None, metadata=dc_config(field_name="all") ) @dataclass class Supporting(DataClassJsonMixin): delivery_incident_windows: "List[Incident]" = dc_field( metadata=dc_config(field_name="delivery_incident_windows") ) edge_outlier_zones: List[str] = dc_field( metadata=dc_config(field_name="edge_outlier_zones") ) source_drop_windows: "List[TimeWindow]" = dc_field( metadata=dc_config(field_name="source_drop_windows") ) @dataclass class TargetResolution(DataClassJsonMixin): height: int = dc_field(metadata=dc_config(field_name="height")) width: int = dc_field(metadata=dc_config(field_name="width")) bitrate: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) @dataclass class TeamUsageStats(DataClassJsonMixin): # Team identifier (empty string for users not assigned to any team) team: str = dc_field(metadata=dc_config(field_name="team")) # Statistics for a single metric with optional daily breakdown concurrent_connections: "MetricStats" = dc_field( metadata=dc_config(field_name="concurrent_connections") ) # Statistics for a single metric with optional daily breakdown concurrent_users: "MetricStats" = dc_field( metadata=dc_config(field_name="concurrent_users") ) # Statistics for a single metric with optional daily breakdown image_moderations_daily: "MetricStats" = dc_field( metadata=dc_config(field_name="image_moderations_daily") ) # Statistics for a single metric with optional daily breakdown messages_daily: "MetricStats" = dc_field( metadata=dc_config(field_name="messages_daily") ) # Statistics for a single metric with optional daily breakdown messages_last_24_hours: "MetricStats" = dc_field( metadata=dc_config(field_name="messages_last_24_hours") ) # Statistics for a single metric with optional daily breakdown messages_last_30_days: "MetricStats" = dc_field( metadata=dc_config(field_name="messages_last_30_days") ) # Statistics for a single metric with optional daily breakdown messages_month_to_date: "MetricStats" = dc_field( metadata=dc_config(field_name="messages_month_to_date") ) # Statistics for a single metric with optional daily breakdown messages_total: "MetricStats" = dc_field( metadata=dc_config(field_name="messages_total") ) # Statistics for a single metric with optional daily breakdown translations_daily: "MetricStats" = dc_field( metadata=dc_config(field_name="translations_daily") ) # Statistics for a single metric with optional daily breakdown users_daily: "MetricStats" = dc_field(metadata=dc_config(field_name="users_daily")) # Statistics for a single metric with optional daily breakdown users_engaged_last_30_days: "MetricStats" = dc_field( metadata=dc_config(field_name="users_engaged_last_30_days") ) # Statistics for a single metric with optional daily breakdown users_engaged_month_to_date: "MetricStats" = dc_field( metadata=dc_config(field_name="users_engaged_month_to_date") ) # Statistics for a single metric with optional daily breakdown users_last_24_hours: "MetricStats" = dc_field( metadata=dc_config(field_name="users_last_24_hours") ) # Statistics for a single metric with optional daily breakdown users_last_30_days: "MetricStats" = dc_field( metadata=dc_config(field_name="users_last_30_days") ) # Statistics for a single metric with optional daily breakdown users_month_to_date: "MetricStats" = dc_field( metadata=dc_config(field_name="users_month_to_date") ) # Statistics for a single metric with optional daily breakdown users_total: "MetricStats" = dc_field(metadata=dc_config(field_name="users_total")) @dataclass class TextContentParameters(DataClassJsonMixin): contains_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="contains_url") ) label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) text_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="text_length") ) text_length_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="text_length_operator") ) blocklist_match: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklist_match") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) llm_harm_labels: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="llm_harm_labels") ) @dataclass class TextRuleParameters(DataClassJsonMixin): contains_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="contains_url") ) semantic_filter_min_threshold: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_min_threshold") ) severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) blocklist_match: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklist_match") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) semantic_filter_names: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_names") ) llm_harm_labels: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="llm_harm_labels") ) @dataclass class ThreadParticipant(DataClassJsonMixin): channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) last_read_at: datetime = dc_field( metadata=dc_config( field_name="last_read_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) last_thread_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_thread_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Left Thread At is the time when the user left the thread left_thread_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="left_thread_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Thead ID is unique string identifier of the thread thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) # User ID is unique string identifier of the user user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ThreadResponse(DataClassJsonMixin): # Active Participant Count active_participant_count: int = dc_field( metadata=dc_config(field_name="active_participant_count") ) # Channel CID channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Created By User ID created_by_user_id: str = dc_field( metadata=dc_config(field_name="created_by_user_id") ) # Parent Message ID parent_message_id: str = dc_field( metadata=dc_config(field_name="parent_message_id") ) # Participant Count participant_count: int = dc_field( metadata=dc_config(field_name="participant_count") ) # Reply Count reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) # Title title: str = dc_field(metadata=dc_config(field_name="title")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Deleted At deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Last Message At last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Thread Participants thread_participants: "Optional[List[ThreadParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) # Represents any chat message parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) @dataclass class ThreadStateResponse(DataClassJsonMixin): # Active Participant Count active_participant_count: int = dc_field( metadata=dc_config(field_name="active_participant_count") ) # Channel CID channel_cid: str = dc_field(metadata=dc_config(field_name="channel_cid")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Created By User ID created_by_user_id: str = dc_field( metadata=dc_config(field_name="created_by_user_id") ) # Parent Message ID parent_message_id: str = dc_field( metadata=dc_config(field_name="parent_message_id") ) # Participant Count participant_count: int = dc_field( metadata=dc_config(field_name="participant_count") ) # Reply Count reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) # Title title: str = dc_field(metadata=dc_config(field_name="title")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) latest_replies: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="latest_replies") ) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Deleted At deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Last Message At last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) # Thread Participants thread_participants: "Optional[List[ThreadParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) # Represents any chat message parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) @dataclass class ThreadUpdatedEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( default="thread.updated", metadata=dc_config(field_name="type") ) channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) @dataclass class ThreadedCommentResponse(DataClassJsonMixin): bookmark_count: int = dc_field(metadata=dc_config(field_name="bookmark_count")) confidence_score: float = dc_field( metadata=dc_config(field_name="confidence_score") ) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) downvote_count: int = dc_field(metadata=dc_config(field_name="downvote_count")) hidden: bool = dc_field(metadata=dc_config(field_name="hidden")) id: str = dc_field(metadata=dc_config(field_name="id")) object_id: str = dc_field(metadata=dc_config(field_name="object_id")) object_type: str = dc_field(metadata=dc_config(field_name="object_type")) reaction_count: int = dc_field(metadata=dc_config(field_name="reaction_count")) reply_count: int = dc_field(metadata=dc_config(field_name="reply_count")) score: int = dc_field(metadata=dc_config(field_name="score")) # Status of the comment. One of: active, deleted, removed, hidden status: "CommentStatus" = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) upvote_count: int = dc_field(metadata=dc_config(field_name="upvote_count")) mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) # Slice of nested comments (may be empty). replies: "Optional[List[ThreadedCommentResponse]]" = dc_field( default=None, metadata=dc_config(field_name="replies") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) # Cursor & depth information for a comment's direct replies. Mirrors Reddit's 'load more replies' semantics. meta: "Optional[RepliesMeta]" = dc_field( default=None, metadata=dc_config(field_name="meta") ) moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @dataclass class Thresholds(DataClassJsonMixin): explicit: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="explicit") ) spam: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="spam") ) toxic: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="toxic") ) @dataclass class ThumbnailResponse(DataClassJsonMixin): image_url: str = dc_field(metadata=dc_config(field_name="image_url")) @dataclass class ThumbnailsSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) @dataclass class ThumbnailsSettingsRequest(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @dataclass class ThumbnailsSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) @dataclass class TimeWindow(DataClassJsonMixin): _from: str = dc_field(metadata=dc_config(field_name="from")) to: str = dc_field(metadata=dc_config(field_name="to")) @dataclass class TopBroadcast(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) hours_watched: float = dc_field(metadata=dc_config(field_name="hours_watched")) peak_concurrent_viewers: int = dc_field( metadata=dc_config(field_name="peak_concurrent_viewers") ) poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) @dataclass class TrackActivityMetricsEvent(DataClassJsonMixin): # The ID of the activity to track the metric for activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) # The metric name (e.g. views, clicks, impressions, dwell). Alphanumeric and underscores only. dwell requires dwell_ms. metric: str = dc_field(metadata=dc_config(field_name="metric")) # The amount to increment (positive) or decrement (negative). Defaults to 1. The absolute value counts against rate limits. delta: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="delta") ) # Milliseconds the activity was in view. Required for the built-in dwell metric; apps with a custom dwell metric keep their own behavior. dwell_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="dwell_ms") ) # 1-based position of the activity in that feed read. A value below 1 fails only this event. Accepted but not stored yet. position: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="position") ) # The request_id returned by the feed read that showed the activity. An invalid, expired (older than 48h) or future-dated (more than 5 minutes ahead) value fails only this event. Impressions sent with a valid request_id feed ranking, are not added to the activity's metrics.impressions, and must use a delta of 1. request_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="request_id") ) @dataclass class TrackActivityMetricsEventResult(DataClassJsonMixin): # The activity ID from the request activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) # Whether the metric was counted (false if rate-limited) allowed: bool = dc_field(metadata=dc_config(field_name="allowed")) # The metric name from the request metric: str = dc_field(metadata=dc_config(field_name="metric")) # Error message if processing failed error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error") ) @dataclass class TrackActivityMetricsRequest(DataClassJsonMixin): # List of metric events to track (max 100 per request) events: "List[TrackActivityMetricsEvent]" = dc_field( metadata=dc_config(field_name="events") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class TrackActivityMetricsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Results for each event in the request, in the same order results: "List[TrackActivityMetricsEventResult]" = dc_field( metadata=dc_config(field_name="results") ) @dataclass class TrackStatsResponse(DataClassJsonMixin): duration_seconds: int = dc_field(metadata=dc_config(field_name="duration_seconds")) track_type: str = dc_field(metadata=dc_config(field_name="track_type")) TranscriptionLanguageType = NewType("TranscriptionLanguageType", str) class TranscriptionLanguage: AR: Final[TranscriptionLanguageType] = "ar" AUTO: Final[TranscriptionLanguageType] = "auto" BG: Final[TranscriptionLanguageType] = "bg" CA: Final[TranscriptionLanguageType] = "ca" CS: Final[TranscriptionLanguageType] = "cs" DA: Final[TranscriptionLanguageType] = "da" DE: Final[TranscriptionLanguageType] = "de" EL: Final[TranscriptionLanguageType] = "el" EN: Final[TranscriptionLanguageType] = "en" ES: Final[TranscriptionLanguageType] = "es" ET: Final[TranscriptionLanguageType] = "et" FI: Final[TranscriptionLanguageType] = "fi" FR: Final[TranscriptionLanguageType] = "fr" HE: Final[TranscriptionLanguageType] = "he" HI: Final[TranscriptionLanguageType] = "hi" HR: Final[TranscriptionLanguageType] = "hr" HU: Final[TranscriptionLanguageType] = "hu" ID: Final[TranscriptionLanguageType] = "id" IT: Final[TranscriptionLanguageType] = "it" JA: Final[TranscriptionLanguageType] = "ja" KO: Final[TranscriptionLanguageType] = "ko" MS: Final[TranscriptionLanguageType] = "ms" NL: Final[TranscriptionLanguageType] = "nl" NO: Final[TranscriptionLanguageType] = "no" PL: Final[TranscriptionLanguageType] = "pl" PT: Final[TranscriptionLanguageType] = "pt" RO: Final[TranscriptionLanguageType] = "ro" RU: Final[TranscriptionLanguageType] = "ru" SK: Final[TranscriptionLanguageType] = "sk" SL: Final[TranscriptionLanguageType] = "sl" SV: Final[TranscriptionLanguageType] = "sv" TA: Final[TranscriptionLanguageType] = "ta" TH: Final[TranscriptionLanguageType] = "th" TL: Final[TranscriptionLanguageType] = "tl" TR: Final[TranscriptionLanguageType] = "tr" UK: Final[TranscriptionLanguageType] = "uk" ZH: Final[TranscriptionLanguageType] = "zh" @dataclass class TranscriptionSettings(DataClassJsonMixin): # One of: available, disabled, auto-on closed_caption_mode: "FeatureActivationMode" = dc_field( metadata=dc_config(field_name="closed_caption_mode") ) # The language used in this call as a two letter code language: "TranscriptionLanguage" = dc_field( metadata=dc_config(field_name="language") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) speech_segment_config: "Optional[SpeechSegmentConfig]" = dc_field( default=None, metadata=dc_config(field_name="speech_segment_config") ) translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @dataclass class TranscriptionSettingsRequest(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. closed_caption_mode: "Optional[FeatureActivationMode]" = dc_field( default=None, metadata=dc_config(field_name="closed_caption_mode") ) # Language a call is transcribed or captioned in. language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "Optional[FeatureActivationMode]" = dc_field( default=None, metadata=dc_config(field_name="mode") ) speech_segment_config: "Optional[SpeechSegmentConfig]" = dc_field( default=None, metadata=dc_config(field_name="speech_segment_config") ) translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @dataclass class TranscriptionSettingsResponse(DataClassJsonMixin): # Whether a call feature is available, disabled, or turned on automatically. closed_caption_mode: "FeatureActivationMode" = dc_field( metadata=dc_config(field_name="closed_caption_mode") ) # Language a call is transcribed or captioned in. language: "TranscriptionLanguage" = dc_field( metadata=dc_config(field_name="language") ) # Whether a call feature is available, disabled, or turned on automatically. mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) speech_segment_config: "Optional[SpeechSegmentConfig]" = dc_field( default=None, metadata=dc_config(field_name="speech_segment_config") ) translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @dataclass class TranslateActivityRequest(DataClassJsonMixin): # ISO 639-1 language code to translate to language: str = dc_field(metadata=dc_config(field_name="language")) @dataclass class TranslateActivityResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class TranslateCommentRequest(DataClassJsonMixin): # ISO 639-1 language code to translate to language: str = dc_field(metadata=dc_config(field_name="language")) @dataclass class TranslateCommentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class TranslateMessageRequest(DataClassJsonMixin): # Language to translate message to language: str = dc_field(metadata=dc_config(field_name="language")) @dataclass class TranslateMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) @dataclass class TranslationSettings(DataClassJsonMixin): enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) languages: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="languages") ) @dataclass class TriggeredRuleResponse(DataClassJsonMixin): # ID of the moderation rule that triggered rule_id: str = dc_field(metadata=dc_config(field_name="rule_id")) # Action types resolved from the rule's action sequence actions: List[str] = dc_field(metadata=dc_config(field_name="actions")) # Name of the moderation rule that triggered rule_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="rule_name") ) # Type of the moderation rule that triggered (content, user, or call) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # Violation count for action sequence rules (1-based) violation_number: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="violation_number") ) call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) @dataclass class TruncateChannelRequest(DataClassJsonMixin): # Permanently delete channel data (messages, reactions, etc.) hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # When `message` is set disables all push notifications for it skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Truncate channel data up to `truncated_at`. The system message (if provided) creation time is always greater than `truncated_at` truncated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="truncated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of member IDs to hide message history for. If empty, truncates the channel for all members member_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_ids") ) # Message data for creating or updating a message message: "Optional[MessageRequest]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class TruncateChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class TypingIndicatorsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) @dataclass class UnbanActionRequestPayload(DataClassJsonMixin): # Channel CID for channel-specific unban channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Reason for the appeal decision decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) # Also remove the future channels ban for this user remove_future_channels_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="remove_future_channels_ban") ) # When lifting a shadow ban, also restore the messages the user sent during it. Runs asynchronously; ignored for a regular ban restore_shadowed_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_shadowed_messages") ) # Optional: unban user directly without review item target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) @dataclass class UnbanRequest(DataClassJsonMixin): # ID of the user performing the unban Deprecated: not used by the unban flow # Deprecated unbanned_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="unbanned_by_id") ) # User request object # Deprecated unbanned_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="unbanned_by") ) @dataclass class UnbanResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UnblockActionRequestPayload(DataClassJsonMixin): # Reason for the appeal decision decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) @dataclass class UnblockUserRequest(DataClassJsonMixin): # the user to unblock user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class UnblockUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UnblockUsersRequest(DataClassJsonMixin): blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UnblockUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UnblockedUserEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.unblocked_user" in this case type: str = dc_field( default="call.unblocked_user", metadata=dc_config(field_name="type") ) @dataclass class UndeleteMessageRequest(DataClassJsonMixin): # ID of the user who is undeleting the message undeleted_by: str = dc_field(metadata=dc_config(field_name="undeleted_by")) @dataclass class UndeleteMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) @dataclass class UnfollowBatchRequest(DataClassJsonMixin): # List of follow relationships to remove, each with optional keep_history follows: "List[UnfollowPair]" = dc_field(metadata=dc_config(field_name="follows")) # If true, the batch is queued as a background task, paced per app, and the response has empty follows and a task_id. Server-side only. Supported by the get-or-create endpoint (GetOrCreateUnfollows); UnfollowBatch rejects it. Async batches can apply out of order with other follow writes. When unset, server-side batches of at least 10 items run async for apps created on or after 2026-11-05; set false to opt out. _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) # Whether to delete the corresponding notification activity (default: false) delete_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_notification_activity") ) # If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @dataclass class UnfollowBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of follow relationships that were removed follows: "List[FollowResponse]" = dc_field(metadata=dc_config(field_name="follows")) # ID of the background task when the batch ran async task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) @dataclass class UnfollowPair(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) # When true, activities from the unfollowed feed will remain in the source feed's timeline (default: false) keep_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_history") ) @dataclass class UnfollowResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) @dataclass class UnmuteChannelRequest(DataClassJsonMixin): # Duration of mute in milliseconds expiration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="expiration") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Channel CIDs to mute (if multiple channels) channel_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_cids") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UnmuteRequest(DataClassJsonMixin): # User IDs to unmute target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UnmuteResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # A list of users that can't be found. Common cause for this is deleted users non_existing_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="non_existing_users") ) @dataclass class UnpinActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Fully qualified ID of the feed the activity was unpinned from feed: str = dc_field(metadata=dc_config(field_name="feed")) # ID of the user who unpinned the activity user_id: str = dc_field(metadata=dc_config(field_name="user_id")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class UnpinRequest(DataClassJsonMixin): # the session ID of the user who pinned the message session_id: str = dc_field(metadata=dc_config(field_name="session_id")) # the user ID of the user who pinned the message user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class UnpinResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UnreadCountsBatchRequest(DataClassJsonMixin): user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) @dataclass class UnreadCountsBatchResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) counts_by_user: "Dict[str, Optional[UnreadCountsResponse]]" = dc_field( metadata=dc_config(field_name="counts_by_user") ) @dataclass class UnreadCountsChannel(DataClassJsonMixin): # The channel CID (type:id). channel_id: str = dc_field(metadata=dc_config(field_name="channel_id")) # Whether the channel has messages newer than the user's last read. Large channels have no unread_count and only report this. has_unread: bool = dc_field(metadata=dc_config(field_name="has_unread")) # The date which the current user last read the channel. last_read: datetime = dc_field( metadata=dc_config( field_name="last_read", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The number of unread messages inside the channel. unread_count: int = dc_field(metadata=dc_config(field_name="unread_count")) @dataclass class UnreadCountsChannelType(DataClassJsonMixin): # The number of unread channels of this channel type. channel_count: int = dc_field(metadata=dc_config(field_name="channel_count")) # The channel type. channel_type: str = dc_field(metadata=dc_config(field_name="channel_type")) # The number of unread messages of all the channels with this type. unread_count: int = dc_field(metadata=dc_config(field_name="unread_count")) @dataclass class UnreadCountsResponse(DataClassJsonMixin): total_unread_count: int = dc_field( metadata=dc_config(field_name="total_unread_count") ) total_unread_threads_count: int = dc_field( metadata=dc_config(field_name="total_unread_threads_count") ) channel_type: "List[UnreadCountsChannelType]" = dc_field( metadata=dc_config(field_name="channel_type") ) channels: "List[UnreadCountsChannel]" = dc_field( metadata=dc_config(field_name="channels") ) threads: "List[UnreadCountsThread]" = dc_field( metadata=dc_config(field_name="threads") ) total_unread_count_by_team: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="total_unread_count_by_team") ) @dataclass class UnreadCountsThread(DataClassJsonMixin): # The date which the current user last read the thread. last_read: datetime = dc_field( metadata=dc_config( field_name="last_read", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The id of the last reply which the current user read in the thread. last_read_message_id: str = dc_field( metadata=dc_config(field_name="last_read_message_id") ) # The message id of the root of the thread. parent_message_id: str = dc_field( metadata=dc_config(field_name="parent_message_id") ) # The number of unread replies inside the thread. unread_count: int = dc_field(metadata=dc_config(field_name="unread_count")) @dataclass class UpdateActivitiesPartialBatchRequest(DataClassJsonMixin): # List of activity changes to apply. Each change specifies an activity ID and the fields to set/unset changes: "List[UpdateActivityPartialChangeRequest]" = dc_field( metadata=dc_config(field_name="changes") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) @dataclass class UpdateActivitiesPartialBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of successfully updated activities activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) @dataclass class UpdateActivityPartialChangeRequest(DataClassJsonMixin): # ID of the activity to update activity_id: str = dc_field(metadata=dc_config(field_name="activity_id")) # Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # When true and 'mentioned_user_ids' is updated, automatically creates or deletes mention notifications for added/removed users. Only applicable for client-side requests (ignored for server-side requests) handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # List of field names to remove. Supported fields: 'custom', 'location', 'expires_at', 'filter_tags', 'interest_tags', 'attachments', 'poll_id', 'mentioned_user_ids'. Use dot-notation for nested custom fields (e.g., 'custom.field_name') unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Map of field names to new values. Supported fields: 'text', 'attachments', 'custom', 'visibility', 'visibility_tag', 'restrict_replies' (values: 'everyone', 'people_i_follow', 'nobody'), 'location', 'expires_at', 'filter_tags', 'interest_tags', 'poll_id', 'feeds', 'mentioned_user_ids'. For custom fields, use dot-notation (e.g., 'custom.field_name') set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @dataclass class UpdateActivityPartialRequest(DataClassJsonMixin): # Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # If true, enriches the activity's current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # If true, runs activity processors on the updated activity. Processors will only run if the activity text and/or attachments are changed. Defaults to false. run_activity_processors: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="run_activity_processors") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of field names to remove. Supported fields: 'custom', 'visibility_tag', 'location', 'expires_at', 'filter_tags', 'interest_tags', 'attachments', 'poll_id', 'mentioned_user_ids', 'search_data'. Use dot-notation for nested custom fields (e.g., 'custom.field_name') unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Map of field names to new values. Supported fields: 'text', 'attachments', 'custom', 'visibility', 'visibility_tag', 'restrict_replies' (values: 'everyone', 'people_i_follow', 'nobody'), 'location', 'expires_at', 'filter_tags', 'interest_tags', 'poll_id', 'feeds', 'mentioned_user_ids', 'search_data'. For custom fields, use dot-notation (e.g., 'custom.field_name') set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateActivityPartialResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class UpdateActivityRequest(DataClassJsonMixin): # Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # If true, enriches the activity's current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Time when the activity will expire expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # Poll ID poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) # Controls who can add comments/replies to this activity. One of: everyone, people_i_follow, nobody restrict_replies: "Optional[RestrictReplies]" = dc_field( default=None, metadata=dc_config(field_name="restrict_replies") ) # If true, runs activity processors on the updated activity. Processors will only run if the activity text and/or attachments are changed. Defaults to false. run_activity_processors: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="run_activity_processors") ) # Whether to skip URL enrichment for the activity skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # The text content of the activity text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Visibility setting for the activity visibility: "Optional[ActivityVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # If visibility is 'tag', this is the tag name and is required visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references collection_refs: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="collection_refs") ) # List of feeds the activity is present in feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="feeds") ) # Tags used for filtering the activity filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags indicating interest categories interest_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="interest_tags") ) # List of user IDs mentioned in the activity mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateActivityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) activity: "ActivityResponse" = dc_field(metadata=dc_config(field_name="activity")) @dataclass class UpdateAppRequest(DataClassJsonMixin): async_url_enrich_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async_url_enrich_enabled") ) auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) before_message_send_hook_attempt_timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="before_message_send_hook_attempt_timeout_ms"), ) before_message_send_hook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="before_message_send_hook_url") ) cdn_expiration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cdn_expiration_seconds") ) channel_hide_members_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="channel_hide_members_only") ) chat_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_primary_use_case") ) custom_action_handler_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="custom_action_handler_url") ) disable_auth_checks: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_auth_checks") ) disable_permissions_checks: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_permissions_checks") ) enable_hook_payload_compression: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_hook_payload_compression") ) enforce_unique_usernames: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_usernames") ) feed_audit_logs_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="feed_audit_logs_enabled") ) feeds_moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="feeds_moderation_enabled") ) feeds_v2_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_region") ) guest_user_creation_disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="guest_user_creation_disabled") ) image_moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_enabled") ) max_aggregated_activities_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_aggregated_activities_length") ) member_custom_on_mentioned_users_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="member_custom_on_mentioned_users_enabled"), ) member_custom_on_messages_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="member_custom_on_messages_enabled") ) member_custom_on_typing_events_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="member_custom_on_typing_events_enabled"), ) migrate_permissions_to_v2: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="migrate_permissions_to_v2") ) moderation_analytics_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_analytics_enabled") ) moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_enabled") ) moderation_onboarding_complete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_onboarding_complete") ) moderation_s3_image_access_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_s3_image_access_role_arn"), ) moderation_webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_webhook_url") ) multi_tenant_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="multi_tenant_enabled") ) permission_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="permission_version") ) reminders_interval: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_interval") ) reminders_max_members: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_max_members") ) reminders_max_per_user: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_max_per_user") ) # Revokes tokens issued before this date revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) sqs_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_key") ) sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) sqs_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_url") ) two_way_block_effect_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="two_way_block_effect_enabled") ) user_response_time_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_response_time_enabled") ) video_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="video_primary_use_case") ) webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webhook_url") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) event_hooks: "Optional[List[EventHook]]" = dc_field( default=None, metadata=dc_config(field_name="event_hooks") ) image_moderation_block_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_block_labels") ) image_moderation_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_labels") ) user_search_disallowed_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_search_disallowed_roles") ) webhook_events: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="webhook_events") ) activity_metrics_config: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="activity_metrics_config") ) apn_config: "Optional[APNConfig]" = dc_field( default=None, metadata=dc_config(field_name="apn_config") ) async_moderation_config: "Optional[AsyncModerationConfiguration]" = dc_field( default=None, metadata=dc_config(field_name="async_moderation_config") ) datadog_info: "Optional[DataDogInfo]" = dc_field( default=None, metadata=dc_config(field_name="datadog_info") ) file_upload_config: "Optional[FileUploadConfig]" = dc_field( default=None, metadata=dc_config(field_name="file_upload_config") ) firebase_config: "Optional[FirebaseConfig]" = dc_field( default=None, metadata=dc_config(field_name="firebase_config") ) grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) huawei_config: "Optional[HuaweiConfig]" = dc_field( default=None, metadata=dc_config(field_name="huawei_config") ) image_upload_config: "Optional[FileUploadConfig]" = dc_field( default=None, metadata=dc_config(field_name="image_upload_config") ) moderation_dashboard_preferences: "Optional[ModerationDashboardPreferences]" = ( dc_field( default=None, metadata=dc_config(field_name="moderation_dashboard_preferences"), ) ) push_config: "Optional[PushConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_config") ) xiaomi_config: "Optional[XiaomiConfig]" = dc_field( default=None, metadata=dc_config(field_name="xiaomi_config") ) @dataclass class UpdateBlockListRequest(DataClassJsonMixin): is_confusable_folding_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_confusable_folding_enabled") ) is_leet_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_leet_check_enabled") ) is_plural_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_plural_check_enabled") ) is_substring_matching_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_substring_matching_enabled") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of words to block words: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="words") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateBlockListResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Block list contains restricted words blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @dataclass class UpdateBookmarkFolderRequest(DataClassJsonMixin): # Name of the folder name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the folder custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateBookmarkFolderResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark_folder: "BookmarkFolderResponse" = dc_field( metadata=dc_config(field_name="bookmark_folder") ) @dataclass class UpdateBookmarkRequest(DataClassJsonMixin): # ID of the folder containing the bookmark folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) # Move the bookmark to this folder (empty string removes the folder) new_folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_folder_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class UpdateCallMembersRequest(DataClassJsonMixin): # List of userID to remove remove_members: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="remove_members") ) # List of members to update or insert update_members: "Optional[List[MemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="update_members") ) @dataclass class UpdateCallMembersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) @dataclass class UpdateCallRequest(DataClassJsonMixin): # the time the call is scheduled to start starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) settings_override: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings_override") ) @dataclass class UpdateCallResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) members: "List[MemberResponse]" = dc_field(metadata=dc_config(field_name="members")) own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # Represents a call call: "CallResponse" = dc_field(metadata=dc_config(field_name="call")) @dataclass class UpdateCallTypeRequest(DataClassJsonMixin): external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) notification_settings: "Optional[NotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) settings: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @dataclass class UpdateCallTypeResponse(DataClassJsonMixin): # the time the call type was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # the name of the call type name: str = dc_field(metadata=dc_config(field_name="name")) # the time the call type was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # the permissions granted to each role grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) notification_settings: "NotificationSettingsResponse" = dc_field( metadata=dc_config(field_name="notification_settings") ) settings: "CallSettingsResponse" = dc_field( metadata=dc_config(field_name="settings") ) # the external storage for the call type external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @dataclass class UpdateCampaignRequest(DataClassJsonMixin): sender_id: str = dc_field(metadata=dc_config(field_name="sender_id")) message_template: "CampaignMessageTemplate" = dc_field( metadata=dc_config(field_name="message_template") ) create_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_channels") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Whether a campaign includes or excludes its sender. sender_mode: "Optional[CampaignSenderMode]" = dc_field( default=None, metadata=dc_config(field_name="sender_mode") ) # How a campaign appears to its sender. sender_visibility: "Optional[CampaignSenderVisibility]" = dc_field( default=None, metadata=dc_config(field_name="sender_visibility") ) show_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_channels") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) skip_webhook: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_webhook") ) segment_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="segment_ids") ) user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_ids") ) channel_template: "Optional[CampaignChannelTemplate]" = dc_field( default=None, metadata=dc_config(field_name="channel_template") ) @dataclass class UpdateCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @dataclass class UpdateChannelPartialRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateChannelPartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of updated members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @dataclass class UpdateChannelRequest(DataClassJsonMixin): # Set to `true` to accept the invite accept_invite: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="accept_invite") ) # Sets cool down period for the channel in seconds cooldown: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown") ) # Set to `true` to hide channel's history when adding new members hide_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hide_history") ) # If set, hides channel's history before this time when adding new members. Takes precedence over `hide_history` when both are provided. Must be in RFC3339 format (e.g., "2024-01-01T10:00:00Z") and in the past. hide_history_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_history_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Set to `true` to reject the invite reject_invite: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reject_invite") ) # When `message` is set disables all push notifications for it skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of filter tags to add to the channel add_filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="add_filter_tags") ) # List of user IDs to add to the channel add_members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="add_members") ) # List of user IDs to make channel moderators add_moderators: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="add_moderators") ) # List of channel member role assignments. If any specified user is not part of the channel, the request will fail assign_roles: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="assign_roles") ) # List of user IDs to take away moderators status from demote_moderators: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="demote_moderators") ) # List of user IDs to invite to the channel invites: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="invites") ) # List of filter tags to remove from the channel remove_filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="remove_filter_tags") ) # List of user IDs to remove from the channel remove_members: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="remove_members") ) data: "Optional[ChannelInputRequest]" = dc_field( default=None, metadata=dc_config(field_name="data") ) # Message data for creating or updating a message message: "Optional[MessageRequest]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of channel members members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class UpdateChannelTypeRequest(DataClassJsonMixin): # Automod level applied to a channel type. automod: "Optional[AutomodMode]" = dc_field( default=None, metadata=dc_config(field_name="automod") ) # What automod or a blocklist does when it matches. automod_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="automod_behavior") ) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) connect_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="connect_events") ) count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_events") ) delivery_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delivery_events") ) mark_messages_pending: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_message_length") ) message_retention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_retention") ) mutes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mutes") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) polls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="polls") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) push_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) read_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="read_events") ) reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reminders") ) replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="search") ) shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) skip_last_msg_update_for_system_msgs: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs"), ) typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # List of commands that channel supports commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) permissions: "Optional[List[PolicyRequest]]" = dc_field( default=None, metadata=dc_config(field_name="permissions") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class UpdateChannelTypeResponse(DataClassJsonMixin): # Automod level applied to a channel type. automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # What automod or a blocklist does when it matches. automod_behavior: "ChannelModerationBehavior" = dc_field( metadata=dc_config(field_name="automod_behavior") ) connect_events: bool = dc_field(metadata=dc_config(field_name="connect_events")) count_messages: bool = dc_field(metadata=dc_config(field_name="count_messages")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom_events: bool = dc_field(metadata=dc_config(field_name="custom_events")) delivery_events: bool = dc_field(metadata=dc_config(field_name="delivery_events")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) mark_messages_pending: bool = dc_field( metadata=dc_config(field_name="mark_messages_pending") ) max_message_length: int = dc_field( metadata=dc_config(field_name="max_message_length") ) message_retention: str = dc_field( metadata=dc_config(field_name="message_retention") ) mutes: bool = dc_field(metadata=dc_config(field_name="mutes")) name: str = dc_field(metadata=dc_config(field_name="name")) polls: bool = dc_field(metadata=dc_config(field_name="polls")) push_notifications: bool = dc_field( metadata=dc_config(field_name="push_notifications") ) quotes: bool = dc_field(metadata=dc_config(field_name="quotes")) reactions: bool = dc_field(metadata=dc_config(field_name="reactions")) read_events: bool = dc_field(metadata=dc_config(field_name="read_events")) reminders: bool = dc_field(metadata=dc_config(field_name="reminders")) replies: bool = dc_field(metadata=dc_config(field_name="replies")) search: bool = dc_field(metadata=dc_config(field_name="search")) shared_locations: bool = dc_field(metadata=dc_config(field_name="shared_locations")) skip_last_msg_update_for_system_msgs: bool = dc_field( metadata=dc_config(field_name="skip_last_msg_update_for_system_msgs") ) typing_events: bool = dc_field(metadata=dc_config(field_name="typing_events")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) uploads: bool = dc_field(metadata=dc_config(field_name="uploads")) url_enrichment: bool = dc_field(metadata=dc_config(field_name="url_enrichment")) user_message_reminders: bool = dc_field( metadata=dc_config(field_name="user_message_reminders") ) commands: List[str] = dc_field(metadata=dc_config(field_name="commands")) permissions: "List[PolicyRequest]" = dc_field( metadata=dc_config(field_name="permissions") ) grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # What automod or a blocklist does when it matches. blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Sets the push notification level for a channel type push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class UpdateCollectionRequest(DataClassJsonMixin): # Unique identifier for the collection within its name id: str = dc_field(metadata=dc_config(field_name="id")) # Name/type of the collection name: str = dc_field(metadata=dc_config(field_name="name")) # Custom data for the collection (required, must contain at least one key) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) @dataclass class UpdateCollectionsRequest(DataClassJsonMixin): # List of collections to update (only custom data is updatable) collections: "List[UpdateCollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of updated collections collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @dataclass class UpdateCommandRequest(DataClassJsonMixin): # Description, shown in commands auto-completion description: str = dc_field(metadata=dc_config(field_name="description")) # Arguments help text, shown in commands auto-completion args: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="args")) # Set name used for grouping commands set: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="set")) @dataclass class UpdateCommandResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents custom chat command command: "Optional[Command]" = dc_field( default=None, metadata=dc_config(field_name="command") ) @dataclass class UpdateCommentBookmarkRequest(DataClassJsonMixin): # ID of the folder containing the bookmark folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) # Move the bookmark to this folder (empty string removes the folder) new_folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_folder_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateCommentBookmarkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) @dataclass class UpdateCommentPartialRequest(DataClassJsonMixin): # Whether to copy custom data to notification activities Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # Whether to handle mention notification changes handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # Whether to skip URL enrichment skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # Whether to skip push notifications skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # List of field names to remove. Supported fields: 'custom', 'attachments', 'mentioned_user_ids', 'status'. Use dot-notation for nested custom fields (e.g., 'custom.field_name') unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Map of field names to new values. Supported fields: 'text', 'attachments', 'custom', 'mentioned_user_ids', 'status'. Use dot-notation for nested custom fields (e.g., 'custom.field_name') set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateCommentPartialResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class UpdateCommentRequest(DataClassJsonMixin): # Updated text content of the comment comment: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Whether to copy custom data to the notification activity (only applies when handle_mention_notifications creates notifications) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # If true, creates notification activities for newly mentioned users and deletes notifications for users no longer mentioned handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # Whether to skip URL enrichment for this comment skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Updated media attachments for the comment. Providing this field will replace all existing attachments. attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of user IDs mentioned in the comment mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Updated custom data for the comment custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateCommentResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) @dataclass class UpdateExternalStorageRequest(DataClassJsonMixin): # The name of the bucket on the service provider bucket: str = dc_field(metadata=dc_config(field_name="bucket")) # The type of storage to use storage_type: str = dc_field(metadata=dc_config(field_name="storage_type")) gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) # The path prefix to use for storing files path: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="path")) # Config for creating Amazon S3 storage. aws_s3: "Optional[S3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) # Config for creating Azure Blob Storage storage azure_blob: "Optional[AzureRequest]" = dc_field( default=None, metadata=dc_config(field_name="azure_blob") ) @dataclass class UpdateExternalStorageResponse(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) name: str = dc_field(metadata=dc_config(field_name="name")) path: str = dc_field(metadata=dc_config(field_name="path")) type: str = dc_field(metadata=dc_config(field_name="type")) @dataclass class UpdateFeedGroupRequest(DataClassJsonMixin): # Role new followers of feeds in this group are given. Either a built-in (feed_follower, feed_member_viewer) or any role your app has defined. Empty means feed_follower. Applied when the follow is accepted, so a follow that starts pending picks it up on approval default_follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_follower_role") ) # Default visibility for the feed group. One of: public, visible, followers, members, private default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @dataclass class UpdateFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_group: "FeedGroupResponse" = dc_field( metadata=dc_config(field_name="feed_group") ) @dataclass class UpdateFeedMembersRequest(DataClassJsonMixin): # Type of update operation to perform. One of: upsert, remove, set operation: str = dc_field(metadata=dc_config(field_name="operation")) limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="limit") ) next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # List of members to upsert, remove, or set members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @dataclass class UpdateFeedMembersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) added: "List[FeedMemberResponse]" = dc_field(metadata=dc_config(field_name="added")) removed_ids: List[str] = dc_field(metadata=dc_config(field_name="removed_ids")) updated: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="updated") ) @dataclass class UpdateFeedRequest(DataClassJsonMixin): # If true, removes the geographic location from the feed clear_location: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="clear_location") ) # ID of the new feed creator (owner) created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Description of the feed description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # If true, enriches the feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Name of the feed name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Tags used for filtering feeds filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Custom data for the feed custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class UpdateFeedResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) @dataclass class UpdateFeedViewRequest(DataClassJsonMixin): # Updated configuration for selecting activities activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @dataclass class UpdateFeedViewResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_view: "FeedViewResponse" = dc_field(metadata=dc_config(field_name="feed_view")) @dataclass class UpdateFeedVisibilityRequest(DataClassJsonMixin): # Updated permission grants for each role grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class UpdateFeedVisibilityResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) feed_visibility: "FeedVisibilityResponse" = dc_field( metadata=dc_config(field_name="feed_visibility") ) @dataclass class UpdateFollowRequest(DataClassJsonMixin): # Fully qualified ID of the source feed source: str = dc_field(metadata=dc_config(field_name="source")) # Fully qualified ID of the target feed target: str = dc_field(metadata=dc_config(field_name="target")) # Maximum number of historical activities to copy from the target feed when the follow is first materialized. Not set = unlimited (default). 0 = copy nothing. Range: 0-1000. activity_copy_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="activity_copy_limit") ) # Whether to copy custom data to the notification activity (only applies when create_notification_activity is true) Deprecated: use notification_context.trigger.custom and notification_context.target.custom instead # Deprecated copy_custom_to_notification: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="copy_custom_to_notification") ) # Whether to create a notification activity for this follow create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # If true, auto-creates users referenced by the source and target FIDs when they don't already exist. Server-side only. Defaults to false. Use directly on single follow endpoints (Follow, GetOrCreateFollow). On batch endpoints (FollowBatch, GetOrCreateFollows), use the top-level create_users field; per-item follows[i].create_users is rejected. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # If true, enriches the follow's source_feed and target_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Optional role for the follower in the follow relationship. Server-side only. Either a built-in ('feed_follower' (the default) or 'feed_member_viewer') or any role your app has defined; grants are not inspected. follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follower_role") ) # Push preference for the follow relationship push_preference: "Optional[FollowPushPreference]" = dc_field( default=None, metadata=dc_config(field_name="push_preference") ) # Whether to skip push for this follow skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Status of the follow relationship. One of: accepted, pending, rejected status: "Optional[FollowStatus]" = dc_field( default=None, metadata=dc_config(field_name="status") ) # Custom data for the follow relationship custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UpdateFollowResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) follow: "FollowResponse" = dc_field(metadata=dc_config(field_name="follow")) @dataclass class UpdateLiveLocationRequest(DataClassJsonMixin): # Live location ID message_id: str = dc_field(metadata=dc_config(field_name="message_id")) # Time when the live location expires end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Latitude coordinate latitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latitude") ) # Longitude coordinate longitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="longitude") ) @dataclass class UpdateMemberPartialRequest(DataClassJsonMixin): unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @dataclass class UpdateMemberPartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) channel_member: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel_member") ) @dataclass class UpdateMembershipLevelRequest(DataClassJsonMixin): # Optional description of the membership level description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Display name for the membership level name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Priority level (higher numbers = higher priority) priority: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Activity tags this membership level gives access to tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="tags") ) # Custom data for the membership level custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UpdateMembershipLevelResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) membership_level: "MembershipLevelResponse" = dc_field( metadata=dc_config(field_name="membership_level") ) @dataclass class UpdateMessagePartialRequest(DataClassJsonMixin): # Skip enriching the URL in the message skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of field names to unset unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateMessagePartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Pending message metadata pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @dataclass class UpdateMessageRequest(DataClassJsonMixin): # Message data for creating or updating a message message: "MessageRequest" = dc_field(metadata=dc_config(field_name="message")) # Skip enrich URL skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) @dataclass class UpdateMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @dataclass class UpdatePollOptionRequest(DataClassJsonMixin): # Option ID id: str = dc_field(metadata=dc_config(field_name="id")) # Option text text: str = dc_field(metadata=dc_config(field_name="text")) # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdatePollPartialRequest(DataClassJsonMixin): # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of field names to unset unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdatePollRequest(DataClassJsonMixin): # Poll ID id: str = dc_field(metadata=dc_config(field_name="id")) # Poll name name: str = dc_field(metadata=dc_config(field_name="name")) # Allow answers allow_answers: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_answers") ) # Allow user suggested options allow_user_suggested_options: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_user_suggested_options") ) # Key of the moderation configuration to use. Server-side only. config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration. Server-side only. config_team: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_team") ) # Poll description description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Enforce unique vote enforce_unique_vote: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_vote") ) # Is closed is_closed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_closed") ) # Max votes allowed max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Voting visibility voting_visibility: "Optional[VotingVisibility]" = dc_field( default=None, metadata=dc_config(field_name="voting_visibility") ) # Poll options options: "Optional[List[PollOptionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="options") ) # Custom data for this object custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdatePredefinedFilterRequest(DataClassJsonMixin): # The operation this filter is for (e.g., QueryChannels) operation: str = dc_field(metadata=dc_config(field_name="operation")) # Filter to apply to the query filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # The description of the predefined filter description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @dataclass class UpdatePredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class UpdateQueueRequest(DataClassJsonMixin): description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) filters: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filters") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateReminderRequest(DataClassJsonMixin): expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) remind_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="remind_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateReminderResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @dataclass class UpdateSIPInboundRoutingRuleRequest(DataClassJsonMixin): # Name of the SIP Inbound Routing Rule name: str = dc_field(metadata=dc_config(field_name="name")) # List of SIP trunk IDs trunk_ids: List[str] = dc_field(metadata=dc_config(field_name="trunk_ids")) # Configuration for SIP caller settings caller_configs: "SIPCallerConfigsRequest" = dc_field( metadata=dc_config(field_name="caller_configs") ) # List of called numbers called_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="called_numbers") ) # List of caller numbers (optional) caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # Configuration for SIP call settings call_configs: "Optional[SIPCallConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # Configuration for direct routing rule calls direct_routing_configs: "Optional[SIPDirectRoutingRuleCallConfigsRequest]" = ( dc_field(default=None, metadata=dc_config(field_name="direct_routing_configs")) ) # Configuration for PIN protection settings pin_protection_configs: "Optional[SIPPinProtectionConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_protection_configs") ) # Configuration for PIN routing rule calls pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @dataclass class UpdateSIPInboundRoutingRuleResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP Inbound Routing Rule response sip_inbound_routing_rule: "Optional[SIPInboundRoutingRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_inbound_routing_rule") ) @dataclass class UpdateSIPTrunkRequest(DataClassJsonMixin): # Name of the SIP trunk name: str = dc_field(metadata=dc_config(field_name="name")) # Phone numbers associated with this SIP trunk numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) # Optional password for SIP trunk authentication password: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="password") ) # Optional list of allowed IPv4/IPv6 addresses or CIDR blocks allowed_ips: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_ips") ) @dataclass class UpdateSIPTrunkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP trunk information sip_trunk: "Optional[SIPTrunkResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_trunk") ) @dataclass class UpdateScheduledMessageRequest(DataClassJsonMixin): # New send time (UTC). Must be in the future and at most the app's maximum lead time from now. Rounded up to the first whole minute that is at least 1 minute from now, never earlier than requested. Resending the stored time leaves it unchanged scheduled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Message data for creating or updating a message message: "Optional[MessageRequest]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class UpdateScheduledMessageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # A message scheduled to be sent later scheduled_message: "ScheduledMessageResponse" = dc_field( metadata=dc_config(field_name="scheduled_message") ) @dataclass class UpdateSegmentRequest(DataClassJsonMixin): # The description of the segment (max 256 characters) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The name of the segment (max 128 characters) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Filter to apply to the query filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class UpdateSegmentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) segment: "SegmentResponse" = dc_field(metadata=dc_config(field_name="segment")) @dataclass class UpdateThreadPartialRequest(DataClassJsonMixin): user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of field names to unset unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateThreadPartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) thread: "ThreadResponse" = dc_field(metadata=dc_config(field_name="thread")) @dataclass class UpdateUserGroupRequest(DataClassJsonMixin): # The new description for the group description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The new name of the user group name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @dataclass class UpdateUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UpdateUserPartialRequest(DataClassJsonMixin): # User ID to update id: str = dc_field(metadata=dc_config(field_name="id")) unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @dataclass class UpdateUserPermissionsRequest(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) grant_permissions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="grant_permissions") ) revoke_permissions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="revoke_permissions") ) @dataclass class UpdateUserPermissionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UpdateUsersPartialRequest(DataClassJsonMixin): users: "List[UpdateUserPartialRequest]" = dc_field( metadata=dc_config(field_name="users") ) @dataclass class UpdateUsersRequest(DataClassJsonMixin): # Object containing users users: "Dict[str, UserRequest]" = dc_field(metadata=dc_config(field_name="users")) @dataclass class UpdateUsersResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Deprecated: Always empty. Removing a user from a team no longer deletes their memberships in that team's channels, so there is no task to poll. # Deprecated membership_deletion_task_id: str = dc_field( metadata=dc_config(field_name="membership_deletion_task_id") ) # Object containing users users: "Dict[str, FullUserResponse]" = dc_field( metadata=dc_config(field_name="users") ) @dataclass class UpdatedCallPermissionsEvent(DataClassJsonMixin): call_cid: str = dc_field(metadata=dc_config(field_name="call_cid")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The capabilities of the current user own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "call.permissions_updated" in this case type: str = dc_field( default="call.permissions_updated", metadata=dc_config(field_name="type") ) @dataclass class UploadChannelFileRequest(DataClassJsonMixin): # file field file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UploadChannelFileResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # URL to the uploaded asset. Should be used to put to `asset_url` attachment field file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) # URL of the file thumbnail for supported file formats. Should be put to `thumb_url` attachment field thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) @dataclass class UploadChannelRequest(DataClassJsonMixin): file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) # field with JSON-encoded array of image size configurations upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UploadChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) # Array of image size configurations upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) @dataclass class UpsertActionConfigItem(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) order: int = dc_field(metadata=dc_config(field_name="order")) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) icon: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="icon")) id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) queue_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="queue_type") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UpsertActionConfigRequest(DataClassJsonMixin): # The action to perform (e.g. ban, delete_message, custom) action: str = dc_field(metadata=dc_config(field_name="action")) # Type of entity this action applies to (e.g. stream:chat:v1:message) entity_type: str = dc_field(metadata=dc_config(field_name="entity_type")) # Display order in the dashboard (0–100, lower numbers shown first) order: int = dc_field(metadata=dc_config(field_name="order")) # Human-readable label for the dashboard button description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Icon identifier for the dashboard button icon: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="icon")) # UUID of an existing action config to update; omit to create a new record id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Queue this config belongs to; null means the default queue queue_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="queue_type") ) # Optional user ID to associate with the audit log entry user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Action-specific parameters passed to the action handler custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpsertActionConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Configuration for a moderation action action_config: "Optional[ModerationActionConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="action_config") ) @dataclass class UpsertActivitiesRequest(DataClassJsonMixin): # List of activities to create or update activities: "List[ActivityRequest]" = dc_field( metadata=dc_config(field_name="activities") ) # Server-side only. If true, auto-creates users referenced by activity user_id values that don't already exist. Default: false. create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) # If true, enriches the activities' current_feed with own_* fields (own_follows, own_followings, own_capabilities, own_membership). Defaults to false for performance. enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # If true, forces moderation to run for server-side requests. By default, server-side requests skip moderation. Client-side requests always run moderation regardless of this field. force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # Server-side only. If true, activities whose id already exists are left unchanged instead of updated: no write, events or notifications. They are listed in skipped_existing and returned as stored. Soft-deleted activities count as existing and are returned with deleted_at set. Default: false. skip_existing: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_existing") ) @dataclass class UpsertActivitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of created or updated activities activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) # Total number of mention notification activities created for mentioned users across all activities mention_notifications_created: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mention_notifications_created") ) # IDs of activities left unchanged because they already existed. Only set when skip_existing is true. skipped_existing: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="skipped_existing") ) @dataclass class UpsertCollectionsRequest(DataClassJsonMixin): # List of collections to upsert (insert if new, update if existing) collections: "List[CollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) @dataclass class UpsertCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of upserted collections collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @dataclass class UpsertConfigRequest(DataClassJsonMixin): # Unique identifier for the moderation configuration key: str = dc_field(metadata=dc_config(field_name="key")) # Whether moderation should be performed asynchronously _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) # Team associated with the configuration team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Optional user ID to associate with the audit log entry user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) ai_audio_config: "Optional[AIAudioConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="ai_audio_config") ) ai_image_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_config") ) ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) ai_video_config: "Optional[AIVideoConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( dc_field( default=None, metadata=dc_config(field_name="automod_semantic_filters_config"), ) ) automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) aws_rekognition_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="aws_rekognition_config") ) block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) bodyguard_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="bodyguard_config") ) engine: "Optional[ModerationEngineConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="engine") ) flood_config: "Optional[FloodConfig]" = dc_field( default=None, metadata=dc_config(field_name="flood_config") ) google_vision_config: "Optional[GoogleVisionConfig]" = dc_field( default=None, metadata=dc_config(field_name="google_vision_config") ) intent_config: "Optional[IntentConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="intent_config") ) llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) rule_builder_config: "Optional[RuleBuilderConfig]" = dc_field( default=None, metadata=dc_config(field_name="rule_builder_config") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @dataclass class UpsertConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) config: "Optional[ConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @dataclass class UpsertExternalStorageAWSS3Request(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) region: str = dc_field(metadata=dc_config(field_name="region")) role_arn: str = dc_field(metadata=dc_config(field_name="role_arn")) path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @dataclass class UpsertExternalStorageGCSRequest(DataClassJsonMixin): bucket: str = dc_field(metadata=dc_config(field_name="bucket")) credentials: str = dc_field(metadata=dc_config(field_name="credentials")) path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @dataclass class UpsertExternalStorageRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) aws_s3: "Optional[UpsertExternalStorageAWSS3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) gcs: "Optional[UpsertExternalStorageGCSRequest]" = dc_field( default=None, metadata=dc_config(field_name="gcs") ) @dataclass class UpsertExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class UpsertModerationRuleRequest(DataClassJsonMixin): # Unique rule name name: str = dc_field(metadata=dc_config(field_name="name")) # Type of rule: user, content, call, or flood rule_type: str = dc_field(metadata=dc_config(field_name="rule_type")) # Duration before rule can trigger again (e.g. 24h, 7d) cooldown_period: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) # Optional description of the rule description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether the rule is active enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Logical operator between conditions/groups: AND or OR logic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="logic") ) # Team scope for the rule team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Optional user ID to associate with the audit log entry user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Escalation sequences for call rules action_sequences: "Optional[List[CallRuleActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) # Flat list of conditions (legacy) conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) # List of config keys this rule applies to config_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="config_keys") ) # Nested condition groups groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) # User request object user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpsertModerationRuleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) rule: "Optional[ModerationRuleV2Response]" = dc_field( default=None, metadata=dc_config(field_name="rule") ) @dataclass class UpsertModerationTemplateRequest(DataClassJsonMixin): # Name of the moderation template name: str = dc_field(metadata=dc_config(field_name="name")) # Configuration for a feeds moderation template config: "FeedsModerationTemplateConfigPayload" = dc_field( metadata=dc_config(field_name="config") ) @dataclass class UpsertModerationTemplateResponse(DataClassJsonMixin): # When the template was created created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) # Name of the moderation template name: str = dc_field(metadata=dc_config(field_name="name")) # When the template was last updated updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Configuration for a feeds moderation template config: "Optional[FeedsModerationTemplateConfigPayload]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @dataclass class UpsertPushPreferencesRequest(DataClassJsonMixin): # A list of push preferences for channels, calls, or the user. preferences: "List[PushPreferenceInput]" = dc_field( metadata=dc_config(field_name="preferences") ) @dataclass class UpsertPushPreferencesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The channel specific push notification preferences, only returned for channels you've edited. user_channel_preferences: "Dict[str, Dict[str, ChannelPushPreferencesResponse]]" = ( dc_field(metadata=dc_config(field_name="user_channel_preferences")) ) # The user preferences, always returned regardless if you edited it user_preferences: "Dict[str, PushPreferencesResponse]" = dc_field( metadata=dc_config(field_name="user_preferences") ) @dataclass class UpsertPushProviderRequest(DataClassJsonMixin): push_provider: "Optional[PushProviderRequest]" = dc_field( default=None, metadata=dc_config(field_name="push_provider") ) @dataclass class UpsertPushProviderResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) push_provider: "PushProviderResponse" = dc_field( metadata=dc_config(field_name="push_provider") ) @dataclass class UpsertPushTemplateRequest(DataClassJsonMixin): # Event type. One of: message.new, message.updated, reaction.new, notification.reminder_due, feeds.activity.added, feeds.comment.added, feeds.activity.reaction.added, feeds.comment.reaction.added, feeds.follow.created, feeds.notification_feed.updated event_type: str = dc_field(metadata=dc_config(field_name="event_type")) # Push provider type. One of: firebase, apn, huawei, xiaomi push_provider_type: "PushProviderName" = dc_field( metadata=dc_config(field_name="push_provider_type") ) # Whether to send push notification for this event enable_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_push") ) # Push provider name push_provider_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="push_provider_name") ) # Push template template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @dataclass class UpsertPushTemplateResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) template: "Optional[PushTemplateResponse]" = dc_field( default=None, metadata=dc_config(field_name="template") ) @dataclass class UpsertSetupSessionRequest(DataClassJsonMixin): # The current step of the setup wizard. One of: welcome, input, configure, live current_step: "SetupStep" = dc_field(metadata=dc_config(field_name="current_step")) # The status of the setup session. One of: in_progress, completed status: "SetupStatus" = dc_field(metadata=dc_config(field_name="status")) # Per-step data keyed by step name (welcome, input, configure, live) setup_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="setup_data") ) @dataclass class UpsertSetupSessionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) setup_session: "Optional[SetupSession]" = dc_field( default=None, metadata=dc_config(field_name="setup_session") ) @dataclass class UpsertUserInterestsRequest(DataClassJsonMixin): # Interest tags to add or update (1-50) interests: "List[UserInterestRequest]" = dc_field( metadata=dc_config(field_name="interests") ) @dataclass class UpsertUserInterestsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # All interest tags of the user after the write interests: "List[InterestTagResponse]" = dc_field( metadata=dc_config(field_name="interests") ) @dataclass class User(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class UserBannedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.banned" in this case type: str = dc_field(default="user.banned", metadata=dc_config(field_name="type")) # Whether the ban also applies to channels created later by the same creator. Without a channel, check user.banned to tell a global ban from a future-channels-only ban ban_from_future_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ban_from_future_channels") ) # The ID of the channel where the target user was banned channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the target user was banned channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the target user was banned cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The expiration date of the ban expiration: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expiration", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The reason for the ban reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # ID of the review queue item (flagged message) that triggered the ban, if the ban was applied from the moderation review queue review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) # Whether the user was shadow banned shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # The team of the channel where the target user was banned team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) total_bans: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_bans") ) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class UserChannelBanCountRuleParameters(DataClassJsonMixin): banned_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class UserChannelCountRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class UserClaimedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) claimed_by: "UserResponseCommonFields" = dc_field( metadata=dc_config(field_name="claimed_by") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.claimed" in this case type: str = dc_field(default="user.claimed", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class UserCreatedWithinParameters(DataClassJsonMixin): max_age: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="max_age") ) @dataclass class UserCustomEventRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UserCustomPropertyParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @dataclass class UserDeactivatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.deactivated" in this case type: str = dc_field( default="user.deactivated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class UserDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The type of deletion that was used for the user's conversations. One of: hard, soft, pruning, (empty string) delete_conversation: str = dc_field( metadata=dc_config(field_name="delete_conversation") ) # Whether the user's conversation channels were deleted delete_conversation_channels: bool = dc_field( metadata=dc_config(field_name="delete_conversation_channels") ) # The type of deletion that was used for the user's messages. One of: hard, soft, pruning, (empty string) delete_messages: str = dc_field(metadata=dc_config(field_name="delete_messages")) # The type of deletion that was used for the user. One of: hard, soft, pruning, (empty string) delete_user: str = dc_field(metadata=dc_config(field_name="delete_user")) # Whether the user was hard deleted hard_delete: bool = dc_field(metadata=dc_config(field_name="hard_delete")) # Whether the user's messages were marked as deleted mark_messages_deleted: bool = dc_field( metadata=dc_config(field_name="mark_messages_deleted") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.deleted" in this case type: str = dc_field(default="user.deleted", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class UserFeedbackReport(DataClassJsonMixin): unreported_count: int = dc_field(metadata=dc_config(field_name="unreported_count")) count_by_rating: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="count_by_rating") ) @dataclass class UserFeedbackReportResponse(DataClassJsonMixin): daily: "List[DailyAggregateUserFeedbackReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class UserFeedbackResponse(DataClassJsonMixin): cid: str = dc_field(metadata=dc_config(field_name="cid")) rating: int = dc_field(metadata=dc_config(field_name="rating")) reason: str = dc_field(metadata=dc_config(field_name="reason")) sdk: str = dc_field(metadata=dc_config(field_name="sdk")) sdk_version: str = dc_field(metadata=dc_config(field_name="sdk_version")) session_id: str = dc_field(metadata=dc_config(field_name="session_id")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) platform: "PlatformDataResponse" = dc_field( metadata=dc_config(field_name="platform") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UserFlaggedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The reason for the flag reason: str = dc_field(metadata=dc_config(field_name="reason")) # The total number of flags for the user total_flags: int = dc_field(metadata=dc_config(field_name="total_flags")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.flagged" in this case type: str = dc_field(default="user.flagged", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Custom data custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @dataclass class UserGroup(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) members: "Optional[List[UserGroupMember]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @dataclass class UserGroupCreatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "user_group.created" in this case type: str = dc_field( default="user_group.created", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserGroupDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "user_group.deleted" in this case type: str = dc_field( default="user_group.deleted", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserGroupMember(DataClassJsonMixin): app_pk: int = dc_field(metadata=dc_config(field_name="app_pk")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) group_id: str = dc_field(metadata=dc_config(field_name="group_id")) is_admin: bool = dc_field(metadata=dc_config(field_name="is_admin")) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) @dataclass class UserGroupMemberAddedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The user IDs that were added members: List[str] = dc_field(metadata=dc_config(field_name="members")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "user_group.member_added" in this case type: str = dc_field( default="user_group.member_added", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserGroupMemberRemovedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The user IDs that were removed members: List[str] = dc_field(metadata=dc_config(field_name="members")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "user_group.member_removed" in this case type: str = dc_field( default="user_group.member_removed", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserGroupResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) created_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by") ) description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) members: "Optional[List[UserGroupMember]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @dataclass class UserGroupUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # The type of event: "user_group.updated" in this case type: str = dc_field( default="user_group.updated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserIdenticalContentCountParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class UserIdenticalImageCountParameters(DataClassJsonMixin): match: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="match") ) similarity_distance: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="similarity_distance") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class UserInterestRequest(DataClassJsonMixin): # The interest tag; trimmed and lower-cased like activity interest_tags tag: str = dc_field(metadata=dc_config(field_name="tag")) # Ranking weight between -1.0 (dislike) and 1.0 (like). Defaults to 1.0 weight: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="weight") ) @dataclass class UserMessagesDeletedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.messages.deleted" in this case type: str = dc_field( default="user.messages.deleted", metadata=dc_config(field_name="type") ) # The ID of the channel where the target user's messages were deleted channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the target user's messages were deleted channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the target user's messages were deleted cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Whether Messages were hard deleted hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The team of the channel where the target user's messages were deleted team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) @dataclass class UserMuteResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # User response object target: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UserMutedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.muted" in this case type: str = dc_field(default="user.muted", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The target users that were muted target_users: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="target_users") ) target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @dataclass class UserRatingReportResponse(DataClassJsonMixin): average: float = dc_field(metadata=dc_config(field_name="average")) count: int = dc_field(metadata=dc_config(field_name="count")) @dataclass class UserReactionCountRuleParameters(DataClassJsonMixin): count: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="count") ) threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class UserReactivatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.reactivated" in this case type: str = dc_field( default="user.reactivated", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class UserRequest(DataClassJsonMixin): # User ID id: str = dc_field(metadata=dc_config(field_name="id")) # User's profile image URL image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) invisible: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invisible") ) language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) # Optional name of user name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # User's global role role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # List of teams the user belongs to teams: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="teams") ) # Custom user data custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) # Map of team-specific roles for the user teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class UserResponse(DataClassJsonMixin): # Whether a user is banned or not banned: bool = dc_field(metadata=dc_config(field_name="banned")) # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # Unique user identifier id: str = dc_field(metadata=dc_config(field_name="id")) invisible: bool = dc_field(metadata=dc_config(field_name="invisible")) # Preferred language of a user language: str = dc_field(metadata=dc_config(field_name="language")) # Whether a user online or not online: bool = dc_field(metadata=dc_config(field_name="online")) # Determines the set of user permissions role: str = dc_field(metadata=dc_config(field_name="role")) # Whether a user is shadow banned shadow_banned: bool = dc_field(metadata=dc_config(field_name="shadow_banned")) # Date/time of the last update updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) # List of teams user is a part of teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) # Custom data for this object custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) # Date when ban expires ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) bypass_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="bypass_moderation") ) # Date of deactivation deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Date/time of deletion deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) # Date of last activity last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Optional name of user name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Revocation date for tokens revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # List of devices user is using devices: "Optional[List[DeviceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="devices") ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) push_notifications: "Optional[PushNotificationSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class UserResponseCommonFields(DataClassJsonMixin): banned: bool = dc_field(metadata=dc_config(field_name="banned")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) language: str = dc_field(metadata=dc_config(field_name="language")) online: bool = dc_field(metadata=dc_config(field_name="online")) role: str = dc_field(metadata=dc_config(field_name="role")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class UserResponsePrivacyFields(DataClassJsonMixin): banned: bool = dc_field(metadata=dc_config(field_name="banned")) created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) id: str = dc_field(metadata=dc_config(field_name="id")) language: str = dc_field(metadata=dc_config(field_name="language")) online: bool = dc_field(metadata=dc_config(field_name="online")) role: str = dc_field(metadata=dc_config(field_name="role")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) blocked_user_ids: List[str] = dc_field( metadata=dc_config(field_name="blocked_user_ids") ) teams: List[str] = dc_field(metadata=dc_config(field_name="teams")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) avg_response_time: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_response_time") ) deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) image: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image") ) invisible: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invisible") ) last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The privacy settings of the user. privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class UserRoleParameters(DataClassJsonMixin): operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) @dataclass class UserRuleParameters(DataClassJsonMixin): max_age: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="max_age") ) @dataclass class UserUnbannedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.unbanned" in this case type: str = dc_field(default="user.unbanned", metadata=dc_config(field_name="type")) # The ID of the channel where the target user was unbanned channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) channel_message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_message_count") ) # The type of the channel where the target user was unbanned channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel where the target user was unbanned cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # Whether the target user was shadow unbanned shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # The team of the channel where the target user was unbanned team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @dataclass class UserUnmutedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.unmuted" in this case type: str = dc_field(default="user.unmuted", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) # The target users that were unmuted target_users: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="target_users") ) target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @dataclass class UserUnreadReminderEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) # The channels with unread messages channels: "Dict[str, Optional[ChannelMessagesResponse]]" = dc_field( metadata=dc_config(field_name="channels") ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponseCommonFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.unread_message_reminder" in this case type: str = dc_field( default="user.unread_message_reminder", metadata=dc_config(field_name="type") ) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class UserUpdatedEvent(DataClassJsonMixin): # Date/time of creation created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) user: "UserResponsePrivacyFields" = dc_field(metadata=dc_config(field_name="user")) # The type of event: "user.updated" in this case type: str = dc_field(default="user.updated", metadata=dc_config(field_name="type")) received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) @dataclass class ValidateExternalStorageResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass class VelocityFilterConfig(DataClassJsonMixin): _async: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async") ) advanced_filters: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="advanced_filters") ) cascading_actions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="cascading_actions") ) cids_per_user: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cids_per_user") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) first_message_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="first_message_only") ) rules: "Optional[List[VelocityFilterConfigRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class VelocityFilterConfigRule(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) ban_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="ban_duration") ) cascading_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cascading_action") ) cascading_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cascading_threshold") ) check_message_context: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="check_message_context") ) fast_spam_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fast_spam_threshold") ) fast_spam_ttl: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fast_spam_ttl") ) ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) probation_period: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="probation_period") ) shadow_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow_ban") ) slow_spam_ban_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_ban_duration") ) slow_spam_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_threshold") ) slow_spam_ttl: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_ttl") ) url_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_only") ) @dataclass class VideoCallRuleConfig(DataClassJsonMixin): flag_all_labels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="flag_all_labels") ) flagged_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="flagged_labels") ) rules: "Optional[List[HarmConfig]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) VideoCodecType = NewType("VideoCodecType", str) class VideoCodec: H264: Final[VideoCodecType] = "h264" VP8: Final[VideoCodecType] = "vp8" @dataclass class VideoContentParameters(DataClassJsonMixin): label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class VideoReactionOverTimeResponse(DataClassJsonMixin): by_minute: "Optional[List[CountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_minute") ) @dataclass class VideoReactionResponse(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) emoji_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="emoji_code") ) custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class VideoReactionsResponse(DataClassJsonMixin): reaction: str = dc_field(metadata=dc_config(field_name="reaction")) count_over_time: "Optional[VideoReactionOverTimeResponse]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) @dataclass class VideoRuleParameters(DataClassJsonMixin): threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class VideoSettings(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) camera_default_on: bool = dc_field( metadata=dc_config(field_name="camera_default_on") ) # Which camera a call opens with. camera_facing: "CameraFacing" = dc_field( metadata=dc_config(field_name="camera_facing") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) target_resolution: "TargetResolution" = dc_field( metadata=dc_config(field_name="target_resolution") ) @dataclass class VideoSettingsRequest(DataClassJsonMixin): access_request_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="access_request_enabled") ) camera_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="camera_default_on") ) # Which camera a call opens with. camera_facing: "Optional[CameraFacing]" = dc_field( default=None, metadata=dc_config(field_name="camera_facing") ) enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @dataclass class VideoSettingsResponse(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) camera_default_on: bool = dc_field( metadata=dc_config(field_name="camera_default_on") ) # Which camera a call opens with. camera_facing: "CameraFacing" = dc_field( metadata=dc_config(field_name="camera_facing") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) target_resolution: "TargetResolution" = dc_field( metadata=dc_config(field_name="target_resolution") ) @dataclass class ViewerBehavior(DataClassJsonMixin): connection_duration_p50_s: int = dc_field( metadata=dc_config(field_name="connection_duration_p50_s") ) connections_per_viewer_mean: float = dc_field( metadata=dc_config(field_name="connections_per_viewer_mean") ) median_watch_min: float = dc_field( metadata=dc_config(field_name="median_watch_min") ) note: str = dc_field(metadata=dc_config(field_name="note")) p90_watch_min: float = dc_field(metadata=dc_config(field_name="p90_watch_min")) bounce_rate_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="bounce_rate_pct") ) connections_under_30s_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="connections_under_30s_pct") ) return_visit_rate_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="return_visit_rate_pct") ) @dataclass class VoteData(DataClassJsonMixin): answer_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="answer_text") ) option_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="option_id") ) VotingVisibilityType = NewType("VotingVisibilityType", str) class VotingVisibility: ANONYMOUS: Final[VotingVisibilityType] = "anonymous" PUBLIC: Final[VotingVisibilityType] = "public" @dataclass class WHEvent(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) @dataclass class WHIPIngress(DataClassJsonMixin): # URL for a new whip input, every time a new link is created address: str = dc_field(metadata=dc_config(field_name="address")) @dataclass class WSEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ) ) type: str = dc_field(metadata=dc_config(field_name="type")) custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) automoderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="automoderation") ) channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) channel_last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="channel_last_message_at", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) connection_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="connection_id") ) parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reason") ) team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) # Response from AI moderation automoderation_scores: "Optional[ModerationResponse]" = dc_field( default=None, metadata=dc_config(field_name="automoderation_scores") ) # Represents channel in chat channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) me: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="me") ) member: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) # Represents any chat message message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) message_update: "Optional[MessageUpdate]" = dc_field( default=None, metadata=dc_config(field_name="message_update") ) poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) poll_vote: "Optional[PollVoteResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll_vote") ) reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) # User response object user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class WebhookFailoverConfig(DataClassJsonMixin): gcs_bucket: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_bucket") ) gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) gcs_path: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_path") ) s3_api_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_api_key") ) s3_bucket: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_bucket") ) s3_path: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_path") ) s3_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_region") ) s3_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_role_arn") ) s3_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_secret") ) type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) @dataclass class WrappedUnreadCountsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # The total number of unread messages. total_unread_count: int = dc_field( metadata=dc_config(field_name="total_unread_count") ) # The total number of unread threads. total_unread_threads_count: int = dc_field( metadata=dc_config(field_name="total_unread_threads_count") ) # The unread information per channel type. channel_type: "List[UnreadCountsChannelType]" = dc_field( metadata=dc_config(field_name="channel_type") ) # The unread information per channel. channels: "List[UnreadCountsChannel]" = dc_field( metadata=dc_config(field_name="channels") ) # The unread information per thread. threads: "List[UnreadCountsThread]" = dc_field( metadata=dc_config(field_name="threads") ) # The total number of unread messages grouped by team. total_unread_count_by_team: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="total_unread_count_by_team") ) @dataclass class XiaomiConfig(DataClassJsonMixin): disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="package_name") ) secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="secret") ) @dataclass class XiaomiConfigFields(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="package_name") ) secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="secret") )