From d268ebfc645c837e14501a08516c7035eda54444 Mon Sep 17 00:00:00 2001 From: nijeeshjoshy Date: Thu, 5 Nov 2026 13:47:43 +0100 Subject: [PATCH] feat: [CHA-5981] regenerate client with retention rules per channel type Generated from GetStream/chat master 43ce26f51c (v240.5.6, openapi-v240.5.6). Co-Authored-By: Claude Opus 5.5 --- getstream/chat/async_channel.py | 90 + getstream/chat/async_rest_client.py | 465 +- getstream/chat/channel.py | 90 + getstream/chat/rest_client.py | 463 +- getstream/common/async_rest_client.py | 187 +- getstream/common/rest_client.py | 185 +- getstream/feeds/feeds.py | 25 +- getstream/feeds/rest_client.py | 432 +- getstream/models/__init__.py | 15526 ++++++++++------ getstream/moderation/async_rest_client.py | 147 +- getstream/moderation/rest_client.py | 149 +- getstream/tests/test_webhook.py | 134 +- getstream/video/async_call.py | 21 +- getstream/video/async_rest_client.py | 78 +- getstream/video/call.py | 21 +- getstream/video/rest_client.py | 78 +- getstream/webhook.py | 171 +- .../webhooks/_invalid/bad_base64/body.gz | Bin 71 -> 80 bytes .../_invalid/bad_sns_envelope/body.gz | Bin 71 -> 80 bytes .../_invalid/bad_sns_envelope/sqs_body.txt | 2 +- .../webhooks/_invalid/empty_body/body.gz | Bin 23 -> 20 bytes .../_invalid/empty_body/sns_notification.txt | 2 +- .../webhooks/_invalid/empty_body/sqs_body.txt | 2 +- .../webhooks/_invalid/malformed_json/body.gz | Bin 39 -> 40 bytes .../malformed_json/sns_notification.txt | 2 +- .../_invalid/malformed_json/sqs_body.txt | 2 +- .../webhooks/_invalid/missing_type/body.gz | Bin 50 -> 59 bytes .../missing_type/sns_notification.txt | 2 +- .../_invalid/missing_type/sqs_body.txt | 2 +- .../webhooks/_invalid/tampered_body/body.gz | Bin 87 -> 96 bytes .../tampered_body/sns_notification.txt | 2 +- .../_invalid/tampered_body/sqs_body.txt | 2 +- .../webhooks/_invalid/unknown_type/body.gz | Bin 75 -> 84 bytes .../unknown_type/sns_notification.txt | 2 +- .../_invalid/unknown_type/sqs_body.txt | 2 +- .../webhooks/call.session_ended/body.gz | Bin 78 -> 87 bytes .../call.session_ended/sns_notification.txt | 2 +- .../webhooks/call.session_ended/sqs_body.txt | 2 +- .../webhooks/call.session_started/body.gz | Bin 80 -> 89 bytes .../call.session_started/sns_notification.txt | 2 +- .../call.session_started/sqs_body.txt | 2 +- tests/assets/webhooks/channel.created/body.gz | Bin 69 -> 84 bytes .../channel.created/sns_notification.txt | 2 +- .../webhooks/channel.created/sqs_body.txt | 2 +- tests/assets/webhooks/channel.deleted/body.gz | Bin 75 -> 84 bytes .../channel.deleted/sns_notification.txt | 2 +- .../webhooks/channel.deleted/sqs_body.txt | 2 +- tests/assets/webhooks/channel.updated/body.gz | Bin 72 -> 84 bytes .../channel.updated/sns_notification.txt | 2 +- .../webhooks/channel.updated/sqs_body.txt | 2 +- .../webhooks/feeds.activity.added/body.gz | Bin 80 -> 89 bytes .../feeds.activity.added/sns_notification.txt | 2 +- .../feeds.activity.added/sqs_body.txt | 2 +- tests/assets/webhooks/message.deleted/body.gz | Bin 75 -> 84 bytes .../message.deleted/sns_notification.txt | 2 +- .../webhooks/message.deleted/sqs_body.txt | 2 +- tests/assets/webhooks/message.new/body.gz | Bin 71 -> 80 bytes .../webhooks/message.new/sns_notification.txt | 2 +- .../assets/webhooks/message.new/sqs_body.txt | 2 +- tests/assets/webhooks/message.updated/body.gz | Bin 72 -> 84 bytes .../message.updated/sns_notification.txt | 2 +- .../webhooks/message.updated/sqs_body.txt | 2 +- .../webhooks/moderation.flagged/body.gz | Bin 78 -> 87 bytes .../moderation.flagged/sns_notification.txt | 2 +- .../webhooks/moderation.flagged/sqs_body.txt | 2 +- tests/assets/webhooks/reaction.new/body.gz | Bin 72 -> 81 bytes .../reaction.new/sns_notification.txt | 2 +- .../assets/webhooks/reaction.new/sqs_body.txt | 2 +- tests/assets/webhooks/user.banned/body.gz | Bin 71 -> 80 bytes .../webhooks/user.banned/sns_notification.txt | 2 +- .../assets/webhooks/user.banned/sqs_body.txt | 2 +- tests/assets/webhooks/user.unbanned/body.gz | Bin 73 -> 82 bytes .../user.unbanned/sns_notification.txt | 2 +- .../webhooks/user.unbanned/sqs_body.txt | 2 +- 74 files changed, 12223 insertions(+), 6113 deletions(-) diff --git a/getstream/chat/async_channel.py b/getstream/chat/async_channel.py index 15089ab3..af3a7ef7 100644 --- a/getstream/chat/async_channel.py +++ b/getstream/chat/async_channel.py @@ -131,6 +131,33 @@ async def update( self._sync_from_response(response.data) return response + @attach_channel_cid_async + async def query_channel_bans( + self, + exclude_expired_bans: Optional[bool] = None, + include_total: Optional[bool] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + filter_conditions: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryChannelBansResponse]: + response = await self.client.query_channel_bans( + type=self.channel_type, + id=self.channel_id, + exclude_expired_bans=exclude_expired_bans, + include_total=include_total, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + filter_conditions=filter_conditions, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid_async async def delete_draft( self, parent_id: Optional[str] = None, user_id: Optional[str] = None @@ -185,6 +212,44 @@ async def upload_channel_file( self._sync_from_response(response.data) return response + @attach_channel_cid_async + async def fork( + self, + message_id: str, + channel: ForkChannelTarget, + exclude_attachments: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkChannelResponse]: + response = await self.client.fork_channel( + type=self.channel_type, + id=self.channel_id, + message_id=message_id, + channel=channel, + exclude_attachments=exclude_attachments, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + + @attach_channel_cid_async + async def fork_message_i_ds( + self, + source_message_ids: List[str], + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkMessageIDsResponse]: + response = await self.client.fork_message_i_ds( + type=self.channel_type, + id=self.channel_id, + source_message_ids=source_message_ids, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid_async async def hide( self, @@ -255,6 +320,7 @@ async def send_message( include_mentioned_members: Optional[bool] = None, keep_channel_hidden: Optional[bool] = None, pending: Optional[bool] = None, + scheduled_at: Optional[datetime] = None, skip_enrich_url: Optional[bool] = None, skip_push: Optional[bool] = None, pending_message_metadata: Optional[Dict[str, str]] = None, @@ -268,6 +334,7 @@ async def send_message( include_mentioned_members=include_mentioned_members, keep_channel_hidden=keep_channel_hidden, pending=pending, + scheduled_at=scheduled_at, skip_enrich_url=skip_enrich_url, skip_push=skip_push, pending_message_metadata=pending_message_metadata, @@ -333,6 +400,7 @@ async def get_pinned_messages( async def get_or_create( self, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -345,6 +413,7 @@ async def get_or_create( type=self.channel_type, id=self.channel_id, hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -375,6 +444,27 @@ async def mark_read( self._sync_from_response(response.data) return response + @attach_channel_cid_async + async def rewind( + self, + expected_last_message_id: str, + message_id: str, + inclusive: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RewindChannelResponse]: + response = await self.client.rewind_channel( + type=self.channel_type, + id=self.channel_id, + expected_last_message_id=expected_last_message_id, + message_id=message_id, + inclusive=inclusive, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid_async async def show( self, user_id: Optional[str] = None, user: Optional[UserRequest] = None diff --git a/getstream/chat/async_rest_client.py b/getstream/chat/async_rest_client.py index 5f89a2ba..7b5b3f80 100644 --- a/getstream/chat/async_rest_client.py +++ b/getstream/chat/async_rest_client.py @@ -40,8 +40,8 @@ async def create_campaign( description: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, - sender_mode: Optional[str] = None, - sender_visibility: Optional[str] = None, + sender_mode: Optional[CampaignSenderMode] = None, + sender_visibility: Optional[CampaignSenderVisibility] = None, show_channels: Optional[bool] = None, skip_push: Optional[bool] = None, skip_webhook: Optional[bool] = None, @@ -110,7 +110,7 @@ async def get_campaign( next: Optional[str] = None, limit: Optional[int] = None, ) -> StreamResponse[GetCampaignResponse]: - query_params = build_query_param(prev=prev, next=next, limit=limit) + query_params = build_query_param(**{"prev": prev, "next": next, "limit": limit}) path_params = { "id": id, } @@ -131,15 +131,15 @@ async def update_campaign( description: Optional[str] = None, id_: Optional[str] = None, name: Optional[str] = None, - sender_mode: Optional[str] = None, - sender_visibility: Optional[str] = None, + sender_mode: Optional[CampaignSenderMode] = None, + sender_visibility: Optional[CampaignSenderVisibility] = None, show_channels: Optional[bool] = None, skip_push: Optional[bool] = None, skip_webhook: Optional[bool] = None, segment_ids: Optional[List[str]] = None, user_ids: Optional[List[str]] = None, channel_template: Optional[CampaignChannelTemplate] = None, - ) -> StreamResponse[CampaignResponse]: + ) -> StreamResponse[UpdateCampaignResponse]: path_params = { "id": id, } @@ -161,7 +161,7 @@ async def update_campaign( ).to_dict() return await self.put( "/api/v2/chat/campaigns/{id}", - CampaignResponse, + UpdateCampaignResponse, path_params=path_params, json=json, ) @@ -187,24 +187,20 @@ async def start_campaign( ) @telemetry.operation_name("getstream.api.chat.stop_campaign") - async def stop_campaign( - self, - id: str, - ) -> StreamResponse[CampaignResponse]: + async def stop_campaign(self, id: str) -> StreamResponse[StopCampaignResponse]: path_params = { "id": id, } - json = StopCampaignRequest().to_dict() return await self.post( "/api/v2/chat/campaigns/{id}/stop", - CampaignResponse, + StopCampaignResponse, path_params=path_params, - json=json, ) @telemetry.operation_name("getstream.api.chat.query_channels") async def query_channels( self, + include_active_member_count: Optional[bool] = None, limit: Optional[int] = None, member_limit: Optional[int] = None, message_limit: Optional[int] = None, @@ -220,6 +216,7 @@ async def query_channels( user: Optional[UserRequest] = None, ) -> StreamResponse[QueryChannelsResponse]: json = QueryChannelsRequest( + include_active_member_count=include_active_member_count, limit=limit, member_limit=member_limit, message_limit=message_limit, @@ -244,6 +241,7 @@ async def channel_batch_update( operation: str, filter: Dict[str, object], hide_history_before: Optional[datetime] = None, + synchronous: Optional[bool] = None, custom_unset: Optional[List[str]] = None, members: Optional[List[ChannelBatchMemberRequest]] = None, custom_set: Optional[Dict[str, object]] = None, @@ -253,6 +251,7 @@ async def channel_batch_update( operation=operation, filter=filter, hide_history_before=hide_history_before, + synchronous=synchronous, custom_unset=custom_unset, members=members, custom_set=custom_set, @@ -276,13 +275,33 @@ async def delete_channels( "/api/v2/chat/channels/delete", DeleteChannelsResponse, json=json ) + @telemetry.operation_name("getstream.api.chat.query_deleted_channels") + async def query_deleted_channels( + self, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter_conditions: Optional[Dict[str, object]] = None, + ) -> StreamResponse[QueryDeletedChannelsResponse]: + json = QueryDeletedChannelsRequest( + limit=limit, + next=next, + prev=prev, + sort=sort, + filter_conditions=filter_conditions, + ).to_dict() + return await self.post( + "/api/v2/chat/channels/deleted", QueryDeletedChannelsResponse, json=json + ) + @telemetry.operation_name("getstream.api.chat.mark_delivered") async def mark_delivered( self, user_id: Optional[str] = None, latest_delivered_messages: Optional[List[DeliveredMessagePayload]] = None, ) -> StreamResponse[MarkDeliveredResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = MarkDeliveredRequest( latest_delivered_messages=latest_delivered_messages ).to_dict() @@ -298,11 +317,12 @@ async def grouped_query_channels( self, limit: Optional[int] = None, user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, groups: Optional[Dict[str, GroupedChannelsGroupRequest]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[GroupedQueryChannelsResponse]: json = GroupedQueryChannelsRequest( - limit=limit, user_id=user_id, groups=groups, user=user + limit=limit, user_id=user_id, sort=sort, groups=groups, user=user ).to_dict() return await self.post( "/api/v2/chat/channels/grouped", GroupedQueryChannelsResponse, json=json @@ -327,6 +347,7 @@ async def get_or_create_distinct_channel( self, type: str, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -340,6 +361,7 @@ async def get_or_create_distinct_channel( } json = ChannelGetOrCreateRequest( hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -364,7 +386,7 @@ async def delete_channel( skip_truncate: Optional[bool] = None, ) -> StreamResponse[DeleteChannelResponse]: query_params = build_query_param( - hard_delete=hard_delete, skip_truncate=skip_truncate + **{"hard_delete": hard_delete, "skip_truncate": skip_truncate} ) path_params = { "type": type, @@ -394,16 +416,18 @@ async def get_channel( user_id: Optional[str] = None, ) -> StreamResponse[ChannelStateResponse]: query_params = build_query_param( - state=state, - messages_limit=messages_limit, - members_limit=members_limit, - watchers_limit=watchers_limit, - messages_id_lt=messages_id_lt, - messages_id_lte=messages_id_lte, - messages_id_gt=messages_id_gt, - messages_id_gte=messages_id_gte, - messages_id_around=messages_id_around, - user_id=user_id, + **{ + "state": state, + "messages_limit": messages_limit, + "members_limit": members_limit, + "watchers_limit": watchers_limit, + "messages_id_lt": messages_id_lt, + "messages_id_lte": messages_id_lte, + "messages_id_gt": messages_id_gt, + "messages_id_gte": messages_id_gte, + "messages_id_around": messages_id_around, + "user_id": user_id, + } ) path_params = { "type": type, @@ -495,6 +519,41 @@ async def update_channel( json=json, ) + @telemetry.operation_name("getstream.api.chat.query_channel_bans") + async def query_channel_bans( + self, + type: str, + id: str, + exclude_expired_bans: Optional[bool] = None, + include_total: Optional[bool] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + filter_conditions: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryChannelBansResponse]: + path_params = { + "type": type, + "id": id, + } + json = QueryChannelBansRequest( + exclude_expired_bans=exclude_expired_bans, + include_total=include_total, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + filter_conditions=filter_conditions, + user=user, + ).to_dict() + return await self.post( + "/api/v2/chat/channels/{type}/{id}/bans/query", + QueryChannelBansResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.delete_draft") async def delete_draft( self, @@ -503,7 +562,7 @@ async def delete_draft( parent_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[Response]: - query_params = build_query_param(parent_id=parent_id, user_id=user_id) + query_params = build_query_param(**{"parent_id": parent_id, "user_id": user_id}) path_params = { "type": type, "id": id, @@ -523,7 +582,7 @@ async def get_draft( parent_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[GetDraftResponse]: - query_params = build_query_param(parent_id=parent_id, user_id=user_id) + query_params = build_query_param(**{"parent_id": parent_id, "user_id": user_id}) path_params = { "type": type, "id": id, @@ -555,7 +614,7 @@ async def send_event( async def delete_channel_file( self, type: str, id: str, url: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) path_params = { "type": type, "id": id, @@ -580,13 +639,65 @@ async def upload_channel_file( "id": id, } json = UploadChannelFileRequest(file=file, user=user).to_dict() - return await self.post( + return await self._upload_multipart( "/api/v2/chat/channels/{type}/{id}/file", UploadChannelFileResponse, path_params=path_params, json=json, ) + @telemetry.operation_name("getstream.api.chat.fork_channel") + async def fork_channel( + self, + type: str, + id: str, + message_id: str, + channel: ForkChannelTarget, + exclude_attachments: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkChannelResponse]: + path_params = { + "type": type, + "id": id, + } + json = ForkChannelRequest( + message_id=message_id, + channel=channel, + exclude_attachments=exclude_attachments, + user_id=user_id, + user=user, + ).to_dict() + return await self.post( + "/api/v2/chat/channels/{type}/{id}/fork", + ForkChannelResponse, + path_params=path_params, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.fork_message_i_ds") + async def fork_message_i_ds( + self, + type: str, + id: str, + source_message_ids: List[str], + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkMessageIDsResponse]: + path_params = { + "type": type, + "id": id, + } + json = ForkMessageIDsRequest( + source_message_ids=source_message_ids, user_id=user_id, user=user + ).to_dict() + return await self.post( + "/api/v2/chat/channels/{type}/{id}/fork/message_ids", + ForkMessageIDsResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.hide_channel") async def hide_channel( self, @@ -614,7 +725,7 @@ async def hide_channel( async def delete_channel_image( self, type: str, id: str, url: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) path_params = { "type": type, "id": id, @@ -642,7 +753,7 @@ async def upload_channel_image( json = UploadChannelRequest( file=file, upload_sizes=upload_sizes, user=user ).to_dict() - return await self.post( + return await self._upload_multipart( "/api/v2/chat/channels/{type}/{id}/image", UploadChannelResponse, path_params=path_params, @@ -658,7 +769,7 @@ async def update_member_partial( unset: Optional[List[str]] = None, set: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpdateMemberPartialResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "type": type, "id": id, @@ -683,6 +794,7 @@ async def send_message( include_mentioned_members: Optional[bool] = None, keep_channel_hidden: Optional[bool] = None, pending: Optional[bool] = None, + scheduled_at: Optional[datetime] = None, skip_enrich_url: Optional[bool] = None, skip_push: Optional[bool] = None, pending_message_metadata: Optional[Dict[str, str]] = None, @@ -698,6 +810,7 @@ async def send_message( include_mentioned_members=include_mentioned_members, keep_channel_hidden=keep_channel_hidden, pending=pending, + scheduled_at=scheduled_at, skip_enrich_url=skip_enrich_url, skip_push=skip_push, pending_message_metadata=pending_message_metadata, @@ -718,7 +831,7 @@ async def get_many_messages( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetManyMessagesResponse]: query_params = build_query_param( - ids=ids, member_custom_include=member_custom_include + **{"ids": ids, "member_custom_include": member_custom_include} ) path_params = { "type": type, @@ -753,21 +866,23 @@ async def get_pinned_messages( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetPinnedMessagesResponse]: query_params = build_query_param( - limit=limit, - offset=offset, - id_gte=id_gte, - id_gt=id_gt, - id_lte=id_lte, - id_lt=id_lt, - pinned_at_after_or_equal=pinned_at_after_or_equal, - pinned_at_after=pinned_at_after, - pinned_at_before_or_equal=pinned_at_before_or_equal, - pinned_at_before=pinned_at_before, - id_around=id_around, - pinned_at_around=pinned_at_around, - user_id=user_id, - sort=sort, - member_custom_include=member_custom_include, + **{ + "limit": limit, + "offset": offset, + "id_gte": id_gte, + "id_gt": id_gt, + "id_lte": id_lte, + "id_lt": id_lt, + "pinned_at_after_or_equal": pinned_at_after_or_equal, + "pinned_at_after": pinned_at_after, + "pinned_at_before_or_equal": pinned_at_before_or_equal, + "pinned_at_before": pinned_at_before, + "id_around": id_around, + "pinned_at_around": pinned_at_around, + "user_id": user_id, + "sort": sort, + "member_custom_include": member_custom_include, + } ) path_params = { "type": type, @@ -786,6 +901,7 @@ async def get_or_create_channel( type: str, id: str, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -800,6 +916,7 @@ async def get_or_create_channel( } json = ChannelGetOrCreateRequest( hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -839,6 +956,35 @@ async def mark_read( json=json, ) + @telemetry.operation_name("getstream.api.chat.rewind_channel") + async def rewind_channel( + self, + type: str, + id: str, + expected_last_message_id: str, + message_id: str, + inclusive: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RewindChannelResponse]: + path_params = { + "type": type, + "id": id, + } + json = RewindChannelRequest( + expected_last_message_id=expected_last_message_id, + message_id=message_id, + inclusive=inclusive, + user_id=user_id, + user=user, + ).to_dict() + return await self.post( + "/api/v2/chat/channels/{type}/{id}/rewind", + RewindChannelResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.show_channel") async def show_channel( self, @@ -928,12 +1074,12 @@ async def list_channel_types(self) -> StreamResponse[ListChannelTypesResponse]: @telemetry.operation_name("getstream.api.chat.create_channel_type") async def create_channel_type( self, - automod: str, - automod_behavior: str, + automod: AutomodMode, + automod_behavior: BlocklistBehavior, max_message_length: int, name: str, blocklist: Optional[str] = None, - blocklist_behavior: Optional[str] = None, + blocklist_behavior: Optional[ChannelModerationBehavior] = None, connect_events: Optional[bool] = None, count_messages: Optional[bool] = None, custom_events: Optional[bool] = None, @@ -944,10 +1090,12 @@ async def create_channel_type( partition_size: Optional[int] = None, partition_ttl: Optional[str] = None, polls: Optional[bool] = None, - push_level: Optional[str] = None, + push_level: Optional[PushLevel] = None, push_notifications: Optional[bool] = None, + quotes: Optional[bool] = None, reactions: Optional[bool] = None, read_events: Optional[bool] = None, + reminders: Optional[bool] = None, replies: Optional[bool] = None, search: Optional[bool] = None, shared_locations: Optional[bool] = None, @@ -959,6 +1107,7 @@ async def create_channel_type( blocklists: Optional[List[BlockListOptions]] = None, commands: Optional[List[str]] = None, permissions: Optional[List[PolicyRequest]] = None, + automod_thresholds: Optional[Thresholds] = None, chat_preferences: Optional[ChatPreferences] = None, grants: Optional[Dict[str, List[str]]] = None, ) -> StreamResponse[CreateChannelTypeResponse]: @@ -981,8 +1130,10 @@ async def create_channel_type( polls=polls, push_level=push_level, push_notifications=push_notifications, + quotes=quotes, reactions=reactions, read_events=read_events, + reminders=reminders, replies=replies, search=search, shared_locations=shared_locations, @@ -994,6 +1145,7 @@ async def create_channel_type( blocklists=blocklists, commands=commands, permissions=permissions, + automod_thresholds=automod_thresholds, chat_preferences=chat_preferences, grants=grants, ).to_dict() @@ -1027,22 +1179,22 @@ async def get_channel_type( async def update_channel_type( self, name: str, - automod: str, - automod_behavior: str, - max_message_length: int, + automod: Optional[AutomodMode] = None, + automod_behavior: Optional[ChannelModerationBehavior] = None, blocklist: Optional[str] = None, - blocklist_behavior: Optional[str] = None, + blocklist_behavior: Optional[ChannelModerationBehavior] = None, connect_events: Optional[bool] = None, count_messages: Optional[bool] = None, custom_events: Optional[bool] = None, delivery_events: Optional[bool] = None, mark_messages_pending: Optional[bool] = None, + max_message_length: Optional[int] = None, message_retention: Optional[str] = None, mutes: Optional[bool] = None, partition_size: Optional[int] = None, partition_ttl: Optional[str] = None, polls: Optional[bool] = None, - push_level: Optional[str] = None, + push_level: Optional[PushLevel] = None, push_notifications: Optional[bool] = None, quotes: Optional[bool] = None, reactions: Optional[bool] = None, @@ -1070,7 +1222,6 @@ async def update_channel_type( json = UpdateChannelTypeRequest( automod=automod, automod_behavior=automod_behavior, - max_message_length=max_message_length, blocklist=blocklist, blocklist_behavior=blocklist_behavior, connect_events=connect_events, @@ -1078,6 +1229,7 @@ async def update_channel_type( custom_events=custom_events, delivery_events=delivery_events, mark_messages_pending=mark_messages_pending, + max_message_length=max_message_length, message_retention=message_retention, mutes=mutes, partition_size=partition_size, @@ -1222,11 +1374,41 @@ async def export_channels( "/api/v2/chat/export_channels", ExportChannelsResponse, json=json ) + @telemetry.operation_name("getstream.api.chat.get_history_window_teams") + async def get_history_window_teams( + self, + ) -> StreamResponse[GetHistoryWindowTeamsResponse]: + return await self.get( + "/api/v2/chat/history_window/teams", GetHistoryWindowTeamsResponse + ) + + @telemetry.operation_name("getstream.api.chat.set_history_window_teams") + async def set_history_window_teams( + self, teams: List[str] + ) -> StreamResponse[SetHistoryWindowTeamsResponse]: + json = SetHistoryWindowTeamsRequest(teams=teams).to_dict() + return await self.post( + "/api/v2/chat/history_window/teams", + SetHistoryWindowTeamsResponse, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.delete_history_window_teams") + async def delete_history_window_teams( + self, teams: List[str] + ) -> StreamResponse[DeleteHistoryWindowTeamsResponse]: + json = DeleteHistoryWindowTeamsRequest(teams=teams).to_dict() + return await self.post( + "/api/v2/chat/history_window/teams/delete", + DeleteHistoryWindowTeamsResponse, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.query_members") async def query_members( self, payload: Optional[QueryMembersPayload] = None ) -> StreamResponse[MembersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/chat/members", MembersResponse, query_params=query_params ) @@ -1256,7 +1438,7 @@ async def delete_message( delete_for_me: Optional[bool] = None, ) -> StreamResponse[DeleteMessageResponse]: query_params = build_query_param( - hard=hard, deleted_by=deleted_by, delete_for_me=delete_for_me + **{"hard": hard, "deleted_by": deleted_by, "delete_for_me": delete_for_me} ) path_params = { "id": id, @@ -1272,7 +1454,9 @@ async def delete_message( async def get_message( self, id: str, show_deleted_message: Optional[bool] = None ) -> StreamResponse[GetMessageResponse]: - query_params = build_query_param(show_deleted_message=show_deleted_message) + query_params = build_query_param( + **{"show_deleted_message": show_deleted_message} + ) path_params = { "id": id, } @@ -1355,19 +1539,14 @@ async def run_message_action( ) @telemetry.operation_name("getstream.api.chat.commit_message") - async def commit_message( - self, - id: str, - ) -> StreamResponse[MessageActionResponse]: + async def commit_message(self, id: str) -> StreamResponse[MessageActionResponse]: path_params = { "id": id, } - json = CommitMessageRequest().to_dict() return await self.post( "/api/v2/chat/messages/{id}/commit", MessageActionResponse, path_params=path_params, - json=json, ) @telemetry.operation_name("getstream.api.chat.ephemeral_message_update") @@ -1424,7 +1603,7 @@ async def send_reaction( async def delete_reaction( self, id: str, type: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteReactionResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, "type": type, @@ -1440,7 +1619,7 @@ async def delete_reaction( async def get_reactions( self, id: str, limit: Optional[int] = None, offset: Optional[int] = None ) -> StreamResponse[GetReactionsResponse]: - query_params = build_query_param(limit=limit, offset=offset) + query_params = build_query_param(**{"limit": limit, "offset": offset}) path_params = { "id": id, } @@ -1517,6 +1696,8 @@ async def cast_poll_vote( self, message_id: str, poll_id: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, vote: Optional[VoteData] = None, @@ -1525,7 +1706,13 @@ async def cast_poll_vote( "message_id": message_id, "poll_id": poll_id, } - json = CastPollVoteRequest(user_id=user_id, user=user, vote=vote).to_dict() + json = CastPollVoteRequest( + config_key=config_key, + config_team=config_team, + user_id=user_id, + user=user, + vote=vote, + ).to_dict() return await self.post( "/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote", PollVoteResponse, @@ -1537,7 +1724,7 @@ async def cast_poll_vote( async def delete_poll_vote( self, message_id: str, poll_id: str, vote_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollVoteResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "message_id": message_id, "poll_id": poll_id, @@ -1554,7 +1741,7 @@ async def delete_poll_vote( async def delete_reminder( self, message_id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteReminderResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "message_id": message_id, } @@ -1569,6 +1756,7 @@ async def delete_reminder( async def update_reminder( self, message_id: str, + expires_at: Optional[datetime] = None, remind_at: Optional[datetime] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -1577,7 +1765,7 @@ async def update_reminder( "message_id": message_id, } json = UpdateReminderRequest( - remind_at=remind_at, user_id=user_id, user=user + expires_at=expires_at, remind_at=remind_at, user_id=user_id, user=user ).to_dict() return await self.patch( "/api/v2/chat/messages/{message_id}/reminders", @@ -1590,6 +1778,7 @@ async def update_reminder( async def create_reminder( self, message_id: str, + expires_at: Optional[datetime] = None, remind_at: Optional[datetime] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -1598,7 +1787,7 @@ async def create_reminder( "message_id": message_id, } json = CreateReminderRequest( - remind_at=remind_at, user_id=user_id, user=user + expires_at=expires_at, remind_at=remind_at, user_id=user_id, user=user ).to_dict() return await self.post( "/api/v2/chat/messages/{message_id}/reminders", @@ -1621,14 +1810,16 @@ async def get_replies( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetRepliesResponse]: query_params = build_query_param( - limit=limit, - id_gte=id_gte, - id_gt=id_gt, - id_lte=id_lte, - id_lt=id_lt, - id_around=id_around, - sort=sort, - member_custom_include=member_custom_include, + **{ + "limit": limit, + "id_gte": id_gte, + "id_gt": id_gt, + "id_lte": id_lte, + "id_lt": id_lt, + "id_around": id_around, + "sort": sort, + "member_custom_include": member_custom_include, + } ) path_params = { "parent_id": parent_id, @@ -1644,7 +1835,7 @@ async def get_replies( async def query_message_flags( self, payload: Optional[QueryMessageFlagsPayload] = None ) -> StreamResponse[QueryMessageFlagsResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/chat/moderation/flags/message", QueryMessageFlagsResponse, @@ -1687,7 +1878,9 @@ async def get_predefined_filters( include_stats: Optional[bool] = None, sort: Optional[List[SortParamRequest]] = None, ) -> StreamResponse[QueryPredefinedFiltersResponse]: - query_params = build_query_param(include_stats=include_stats, sort=sort) + query_params = build_query_param( + **{"include_stats": include_stats, "sort": sort} + ) return await self.get( "/api/v2/chat/predefined_filters", QueryPredefinedFiltersResponse, @@ -1762,7 +1955,7 @@ async def update_predefined_filter( async def query_banned_users( self, payload: Optional[QueryBannedUsersPayload] = None ) -> StreamResponse[QueryBannedUsersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/chat/query_banned_users", QueryBannedUsersResponse, @@ -1773,7 +1966,7 @@ async def query_banned_users( async def query_future_channel_bans( self, payload: Optional[QueryFutureChannelBansPayload] = None ) -> StreamResponse[QueryFutureChannelBansResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/chat/query_future_channel_bans", QueryFutureChannelBansResponse, @@ -1812,10 +2005,13 @@ async def get_retention_policy(self) -> StreamResponse[GetRetentionPolicyRespons @telemetry.operation_name("getstream.api.chat.set_retention_policy") async def set_retention_policy( - self, max_age_hours: int, policy: str + self, + max_age_hours: int, + policy: RetentionPolicyType, + channel_type: Optional[str] = None, ) -> StreamResponse[SetRetentionPolicyResponse]: json = SetRetentionPolicyRequest( - max_age_hours=max_age_hours, policy=policy + max_age_hours=max_age_hours, policy=policy, channel_type=channel_type ).to_dict() return await self.post( "/api/v2/chat/retention_policy", SetRetentionPolicyResponse, json=json @@ -1823,9 +2019,11 @@ async def set_retention_policy( @telemetry.operation_name("getstream.api.chat.delete_retention_policy") async def delete_retention_policy( - self, policy: str + self, policy: RetentionPolicyType, channel_type: Optional[str] = None ) -> StreamResponse[DeleteRetentionPolicyResponse]: - json = DeleteRetentionPolicyRequest(policy=policy).to_dict() + json = DeleteRetentionPolicyRequest( + policy=policy, channel_type=channel_type + ).to_dict() return await self.post( "/api/v2/chat/retention_policy/delete", DeleteRetentionPolicyResponse, @@ -1854,11 +2052,76 @@ async def get_retention_policy_runs( json=json, ) + @telemetry.operation_name("getstream.api.chat.query_scheduled_messages") + async def query_scheduled_messages( + self, + limit: Optional[int] = None, + next: Optional[str] = None, + user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter: Optional[ScheduledMessagesFilter] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryScheduledMessagesResponse]: + json = QueryScheduledMessagesRequest( + limit=limit, next=next, user_id=user_id, sort=sort, filter=filter, user=user + ).to_dict() + return await self.post( + "/api/v2/chat/scheduled_messages/query", + QueryScheduledMessagesResponse, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.delete_scheduled_message") + async def delete_scheduled_message( + self, id: str + ) -> StreamResponse[DeleteScheduledMessageResponse]: + path_params = { + "id": id, + } + return await self.delete( + "/api/v2/chat/scheduled_messages/{id}", + DeleteScheduledMessageResponse, + path_params=path_params, + ) + + @telemetry.operation_name("getstream.api.chat.update_scheduled_message") + async def update_scheduled_message( + self, + id: str, + scheduled_at: Optional[datetime] = None, + message: Optional[MessageRequest] = None, + ) -> StreamResponse[UpdateScheduledMessageResponse]: + path_params = { + "id": id, + } + json = UpdateScheduledMessageRequest( + scheduled_at=scheduled_at, message=message + ).to_dict() + return await self.patch( + "/api/v2/chat/scheduled_messages/{id}", + UpdateScheduledMessageResponse, + path_params=path_params, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.send_scheduled_message_now") + async def send_scheduled_message_now( + self, id: str + ) -> StreamResponse[SendScheduledMessageNowResponse]: + path_params = { + "id": id, + } + return await self.post( + "/api/v2/chat/scheduled_messages/{id}/send_now", + SendScheduledMessageNowResponse, + path_params=path_params, + ) + @telemetry.operation_name("getstream.api.chat.search") async def search( self, payload: Optional[SearchPayload] = None ) -> StreamResponse[SearchResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/chat/search", SearchResponse, query_params=query_params ) @@ -2068,9 +2331,11 @@ async def get_thread( member_limit: Optional[int] = None, ) -> StreamResponse[GetThreadResponse]: query_params = build_query_param( - reply_limit=reply_limit, - participant_limit=participant_limit, - member_limit=member_limit, + **{ + "reply_limit": reply_limit, + "participant_limit": participant_limit, + "member_limit": member_limit, + } ) path_params = { "message_id": message_id, @@ -2106,9 +2371,13 @@ async def update_thread_partial( @telemetry.operation_name("getstream.api.chat.unread_counts") async def unread_counts( - self, user_id: Optional[str] = None + self, + user_id: Optional[str] = None, + include_large_channels: Optional[bool] = None, ) -> StreamResponse[WrappedUnreadCountsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param( + **{"user_id": user_id, "include_large_channels": include_large_channels} + ) return await self.get( "/api/v2/chat/unread", WrappedUnreadCountsResponse, diff --git a/getstream/chat/channel.py b/getstream/chat/channel.py index da454a14..eb4872d0 100644 --- a/getstream/chat/channel.py +++ b/getstream/chat/channel.py @@ -131,6 +131,33 @@ def update( self._sync_from_response(response.data) return response + @attach_channel_cid + def query_channel_bans( + self, + exclude_expired_bans: Optional[bool] = None, + include_total: Optional[bool] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + filter_conditions: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryChannelBansResponse]: + response = self.client.query_channel_bans( + type=self.channel_type, + id=self.channel_id, + exclude_expired_bans=exclude_expired_bans, + include_total=include_total, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + filter_conditions=filter_conditions, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid def delete_draft( self, parent_id: Optional[str] = None, user_id: Optional[str] = None @@ -185,6 +212,44 @@ def upload_channel_file( self._sync_from_response(response.data) return response + @attach_channel_cid + def fork( + self, + message_id: str, + channel: ForkChannelTarget, + exclude_attachments: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkChannelResponse]: + response = self.client.fork_channel( + type=self.channel_type, + id=self.channel_id, + message_id=message_id, + channel=channel, + exclude_attachments=exclude_attachments, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + + @attach_channel_cid + def fork_message_i_ds( + self, + source_message_ids: List[str], + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkMessageIDsResponse]: + response = self.client.fork_message_i_ds( + type=self.channel_type, + id=self.channel_id, + source_message_ids=source_message_ids, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid def hide( self, @@ -255,6 +320,7 @@ def send_message( include_mentioned_members: Optional[bool] = None, keep_channel_hidden: Optional[bool] = None, pending: Optional[bool] = None, + scheduled_at: Optional[datetime] = None, skip_enrich_url: Optional[bool] = None, skip_push: Optional[bool] = None, pending_message_metadata: Optional[Dict[str, str]] = None, @@ -268,6 +334,7 @@ def send_message( include_mentioned_members=include_mentioned_members, keep_channel_hidden=keep_channel_hidden, pending=pending, + scheduled_at=scheduled_at, skip_enrich_url=skip_enrich_url, skip_push=skip_push, pending_message_metadata=pending_message_metadata, @@ -333,6 +400,7 @@ def get_pinned_messages( def get_or_create( self, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -345,6 +413,7 @@ def get_or_create( type=self.channel_type, id=self.channel_id, hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -375,6 +444,27 @@ def mark_read( self._sync_from_response(response.data) return response + @attach_channel_cid + def rewind( + self, + expected_last_message_id: str, + message_id: str, + inclusive: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RewindChannelResponse]: + response = self.client.rewind_channel( + type=self.channel_type, + id=self.channel_id, + expected_last_message_id=expected_last_message_id, + message_id=message_id, + inclusive=inclusive, + user_id=user_id, + user=user, + ) + self._sync_from_response(response.data) + return response + @attach_channel_cid def show( self, user_id: Optional[str] = None, user: Optional[UserRequest] = None diff --git a/getstream/chat/rest_client.py b/getstream/chat/rest_client.py index 9c7d6ce0..1b88952c 100644 --- a/getstream/chat/rest_client.py +++ b/getstream/chat/rest_client.py @@ -40,8 +40,8 @@ def create_campaign( description: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, - sender_mode: Optional[str] = None, - sender_visibility: Optional[str] = None, + sender_mode: Optional[CampaignSenderMode] = None, + sender_visibility: Optional[CampaignSenderVisibility] = None, show_channels: Optional[bool] = None, skip_push: Optional[bool] = None, skip_webhook: Optional[bool] = None, @@ -108,7 +108,7 @@ def get_campaign( next: Optional[str] = None, limit: Optional[int] = None, ) -> StreamResponse[GetCampaignResponse]: - query_params = build_query_param(prev=prev, next=next, limit=limit) + query_params = build_query_param(**{"prev": prev, "next": next, "limit": limit}) path_params = { "id": id, } @@ -129,15 +129,15 @@ def update_campaign( description: Optional[str] = None, id_: Optional[str] = None, name: Optional[str] = None, - sender_mode: Optional[str] = None, - sender_visibility: Optional[str] = None, + sender_mode: Optional[CampaignSenderMode] = None, + sender_visibility: Optional[CampaignSenderVisibility] = None, show_channels: Optional[bool] = None, skip_push: Optional[bool] = None, skip_webhook: Optional[bool] = None, segment_ids: Optional[List[str]] = None, user_ids: Optional[List[str]] = None, channel_template: Optional[CampaignChannelTemplate] = None, - ) -> StreamResponse[CampaignResponse]: + ) -> StreamResponse[UpdateCampaignResponse]: path_params = { "id": id, } @@ -159,7 +159,7 @@ def update_campaign( ).to_dict() return self.put( "/api/v2/chat/campaigns/{id}", - CampaignResponse, + UpdateCampaignResponse, path_params=path_params, json=json, ) @@ -185,24 +185,20 @@ def start_campaign( ) @telemetry.operation_name("getstream.api.chat.stop_campaign") - def stop_campaign( - self, - id: str, - ) -> StreamResponse[CampaignResponse]: + def stop_campaign(self, id: str) -> StreamResponse[StopCampaignResponse]: path_params = { "id": id, } - json = StopCampaignRequest().to_dict() return self.post( "/api/v2/chat/campaigns/{id}/stop", - CampaignResponse, + StopCampaignResponse, path_params=path_params, - json=json, ) @telemetry.operation_name("getstream.api.chat.query_channels") def query_channels( self, + include_active_member_count: Optional[bool] = None, limit: Optional[int] = None, member_limit: Optional[int] = None, message_limit: Optional[int] = None, @@ -218,6 +214,7 @@ def query_channels( user: Optional[UserRequest] = None, ) -> StreamResponse[QueryChannelsResponse]: json = QueryChannelsRequest( + include_active_member_count=include_active_member_count, limit=limit, member_limit=member_limit, message_limit=message_limit, @@ -240,6 +237,7 @@ def channel_batch_update( operation: str, filter: Dict[str, object], hide_history_before: Optional[datetime] = None, + synchronous: Optional[bool] = None, custom_unset: Optional[List[str]] = None, members: Optional[List[ChannelBatchMemberRequest]] = None, custom_set: Optional[Dict[str, object]] = None, @@ -249,6 +247,7 @@ def channel_batch_update( operation=operation, filter=filter, hide_history_before=hide_history_before, + synchronous=synchronous, custom_unset=custom_unset, members=members, custom_set=custom_set, @@ -272,13 +271,33 @@ def delete_channels( "/api/v2/chat/channels/delete", DeleteChannelsResponse, json=json ) + @telemetry.operation_name("getstream.api.chat.query_deleted_channels") + def query_deleted_channels( + self, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter_conditions: Optional[Dict[str, object]] = None, + ) -> StreamResponse[QueryDeletedChannelsResponse]: + json = QueryDeletedChannelsRequest( + limit=limit, + next=next, + prev=prev, + sort=sort, + filter_conditions=filter_conditions, + ).to_dict() + return self.post( + "/api/v2/chat/channels/deleted", QueryDeletedChannelsResponse, json=json + ) + @telemetry.operation_name("getstream.api.chat.mark_delivered") def mark_delivered( self, user_id: Optional[str] = None, latest_delivered_messages: Optional[List[DeliveredMessagePayload]] = None, ) -> StreamResponse[MarkDeliveredResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = MarkDeliveredRequest( latest_delivered_messages=latest_delivered_messages ).to_dict() @@ -294,11 +313,12 @@ def grouped_query_channels( self, limit: Optional[int] = None, user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, groups: Optional[Dict[str, GroupedChannelsGroupRequest]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[GroupedQueryChannelsResponse]: json = GroupedQueryChannelsRequest( - limit=limit, user_id=user_id, groups=groups, user=user + limit=limit, user_id=user_id, sort=sort, groups=groups, user=user ).to_dict() return self.post( "/api/v2/chat/channels/grouped", GroupedQueryChannelsResponse, json=json @@ -321,6 +341,7 @@ def get_or_create_distinct_channel( self, type: str, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -334,6 +355,7 @@ def get_or_create_distinct_channel( } json = ChannelGetOrCreateRequest( hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -358,7 +380,7 @@ def delete_channel( skip_truncate: Optional[bool] = None, ) -> StreamResponse[DeleteChannelResponse]: query_params = build_query_param( - hard_delete=hard_delete, skip_truncate=skip_truncate + **{"hard_delete": hard_delete, "skip_truncate": skip_truncate} ) path_params = { "type": type, @@ -388,16 +410,18 @@ def get_channel( user_id: Optional[str] = None, ) -> StreamResponse[ChannelStateResponse]: query_params = build_query_param( - state=state, - messages_limit=messages_limit, - members_limit=members_limit, - watchers_limit=watchers_limit, - messages_id_lt=messages_id_lt, - messages_id_lte=messages_id_lte, - messages_id_gt=messages_id_gt, - messages_id_gte=messages_id_gte, - messages_id_around=messages_id_around, - user_id=user_id, + **{ + "state": state, + "messages_limit": messages_limit, + "members_limit": members_limit, + "watchers_limit": watchers_limit, + "messages_id_lt": messages_id_lt, + "messages_id_lte": messages_id_lte, + "messages_id_gt": messages_id_gt, + "messages_id_gte": messages_id_gte, + "messages_id_around": messages_id_around, + "user_id": user_id, + } ) path_params = { "type": type, @@ -489,6 +513,41 @@ def update_channel( json=json, ) + @telemetry.operation_name("getstream.api.chat.query_channel_bans") + def query_channel_bans( + self, + type: str, + id: str, + exclude_expired_bans: Optional[bool] = None, + include_total: Optional[bool] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + filter_conditions: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryChannelBansResponse]: + path_params = { + "type": type, + "id": id, + } + json = QueryChannelBansRequest( + exclude_expired_bans=exclude_expired_bans, + include_total=include_total, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + filter_conditions=filter_conditions, + user=user, + ).to_dict() + return self.post( + "/api/v2/chat/channels/{type}/{id}/bans/query", + QueryChannelBansResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.delete_draft") def delete_draft( self, @@ -497,7 +556,7 @@ def delete_draft( parent_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[Response]: - query_params = build_query_param(parent_id=parent_id, user_id=user_id) + query_params = build_query_param(**{"parent_id": parent_id, "user_id": user_id}) path_params = { "type": type, "id": id, @@ -517,7 +576,7 @@ def get_draft( parent_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[GetDraftResponse]: - query_params = build_query_param(parent_id=parent_id, user_id=user_id) + query_params = build_query_param(**{"parent_id": parent_id, "user_id": user_id}) path_params = { "type": type, "id": id, @@ -549,7 +608,7 @@ def send_event( def delete_channel_file( self, type: str, id: str, url: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) path_params = { "type": type, "id": id, @@ -574,13 +633,65 @@ def upload_channel_file( "id": id, } json = UploadChannelFileRequest(file=file, user=user).to_dict() - return self.post( + return self._upload_multipart( "/api/v2/chat/channels/{type}/{id}/file", UploadChannelFileResponse, path_params=path_params, json=json, ) + @telemetry.operation_name("getstream.api.chat.fork_channel") + def fork_channel( + self, + type: str, + id: str, + message_id: str, + channel: ForkChannelTarget, + exclude_attachments: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkChannelResponse]: + path_params = { + "type": type, + "id": id, + } + json = ForkChannelRequest( + message_id=message_id, + channel=channel, + exclude_attachments=exclude_attachments, + user_id=user_id, + user=user, + ).to_dict() + return self.post( + "/api/v2/chat/channels/{type}/{id}/fork", + ForkChannelResponse, + path_params=path_params, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.fork_message_i_ds") + def fork_message_i_ds( + self, + type: str, + id: str, + source_message_ids: List[str], + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[ForkMessageIDsResponse]: + path_params = { + "type": type, + "id": id, + } + json = ForkMessageIDsRequest( + source_message_ids=source_message_ids, user_id=user_id, user=user + ).to_dict() + return self.post( + "/api/v2/chat/channels/{type}/{id}/fork/message_ids", + ForkMessageIDsResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.hide_channel") def hide_channel( self, @@ -608,7 +719,7 @@ def hide_channel( def delete_channel_image( self, type: str, id: str, url: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) path_params = { "type": type, "id": id, @@ -636,7 +747,7 @@ def upload_channel_image( json = UploadChannelRequest( file=file, upload_sizes=upload_sizes, user=user ).to_dict() - return self.post( + return self._upload_multipart( "/api/v2/chat/channels/{type}/{id}/image", UploadChannelResponse, path_params=path_params, @@ -652,7 +763,7 @@ def update_member_partial( unset: Optional[List[str]] = None, set: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpdateMemberPartialResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "type": type, "id": id, @@ -677,6 +788,7 @@ def send_message( include_mentioned_members: Optional[bool] = None, keep_channel_hidden: Optional[bool] = None, pending: Optional[bool] = None, + scheduled_at: Optional[datetime] = None, skip_enrich_url: Optional[bool] = None, skip_push: Optional[bool] = None, pending_message_metadata: Optional[Dict[str, str]] = None, @@ -692,6 +804,7 @@ def send_message( include_mentioned_members=include_mentioned_members, keep_channel_hidden=keep_channel_hidden, pending=pending, + scheduled_at=scheduled_at, skip_enrich_url=skip_enrich_url, skip_push=skip_push, pending_message_metadata=pending_message_metadata, @@ -712,7 +825,7 @@ def get_many_messages( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetManyMessagesResponse]: query_params = build_query_param( - ids=ids, member_custom_include=member_custom_include + **{"ids": ids, "member_custom_include": member_custom_include} ) path_params = { "type": type, @@ -747,21 +860,23 @@ def get_pinned_messages( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetPinnedMessagesResponse]: query_params = build_query_param( - limit=limit, - offset=offset, - id_gte=id_gte, - id_gt=id_gt, - id_lte=id_lte, - id_lt=id_lt, - pinned_at_after_or_equal=pinned_at_after_or_equal, - pinned_at_after=pinned_at_after, - pinned_at_before_or_equal=pinned_at_before_or_equal, - pinned_at_before=pinned_at_before, - id_around=id_around, - pinned_at_around=pinned_at_around, - user_id=user_id, - sort=sort, - member_custom_include=member_custom_include, + **{ + "limit": limit, + "offset": offset, + "id_gte": id_gte, + "id_gt": id_gt, + "id_lte": id_lte, + "id_lt": id_lt, + "pinned_at_after_or_equal": pinned_at_after_or_equal, + "pinned_at_after": pinned_at_after, + "pinned_at_before_or_equal": pinned_at_before_or_equal, + "pinned_at_before": pinned_at_before, + "id_around": id_around, + "pinned_at_around": pinned_at_around, + "user_id": user_id, + "sort": sort, + "member_custom_include": member_custom_include, + } ) path_params = { "type": type, @@ -780,6 +895,7 @@ def get_or_create_channel( type: str, id: str, hide_for_creator: Optional[bool] = None, + include_scheduled_messages: Optional[bool] = None, state: Optional[bool] = None, thread_unread_counts: Optional[bool] = None, member_custom_include: Optional[List[str]] = None, @@ -794,6 +910,7 @@ def get_or_create_channel( } json = ChannelGetOrCreateRequest( hide_for_creator=hide_for_creator, + include_scheduled_messages=include_scheduled_messages, state=state, thread_unread_counts=thread_unread_counts, member_custom_include=member_custom_include, @@ -833,6 +950,35 @@ def mark_read( json=json, ) + @telemetry.operation_name("getstream.api.chat.rewind_channel") + def rewind_channel( + self, + type: str, + id: str, + expected_last_message_id: str, + message_id: str, + inclusive: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RewindChannelResponse]: + path_params = { + "type": type, + "id": id, + } + json = RewindChannelRequest( + expected_last_message_id=expected_last_message_id, + message_id=message_id, + inclusive=inclusive, + user_id=user_id, + user=user, + ).to_dict() + return self.post( + "/api/v2/chat/channels/{type}/{id}/rewind", + RewindChannelResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.show_channel") def show_channel( self, @@ -922,12 +1068,12 @@ def list_channel_types(self) -> StreamResponse[ListChannelTypesResponse]: @telemetry.operation_name("getstream.api.chat.create_channel_type") def create_channel_type( self, - automod: str, - automod_behavior: str, + automod: AutomodMode, + automod_behavior: BlocklistBehavior, max_message_length: int, name: str, blocklist: Optional[str] = None, - blocklist_behavior: Optional[str] = None, + blocklist_behavior: Optional[ChannelModerationBehavior] = None, connect_events: Optional[bool] = None, count_messages: Optional[bool] = None, custom_events: Optional[bool] = None, @@ -938,10 +1084,12 @@ def create_channel_type( partition_size: Optional[int] = None, partition_ttl: Optional[str] = None, polls: Optional[bool] = None, - push_level: Optional[str] = None, + push_level: Optional[PushLevel] = None, push_notifications: Optional[bool] = None, + quotes: Optional[bool] = None, reactions: Optional[bool] = None, read_events: Optional[bool] = None, + reminders: Optional[bool] = None, replies: Optional[bool] = None, search: Optional[bool] = None, shared_locations: Optional[bool] = None, @@ -953,6 +1101,7 @@ def create_channel_type( blocklists: Optional[List[BlockListOptions]] = None, commands: Optional[List[str]] = None, permissions: Optional[List[PolicyRequest]] = None, + automod_thresholds: Optional[Thresholds] = None, chat_preferences: Optional[ChatPreferences] = None, grants: Optional[Dict[str, List[str]]] = None, ) -> StreamResponse[CreateChannelTypeResponse]: @@ -975,8 +1124,10 @@ def create_channel_type( polls=polls, push_level=push_level, push_notifications=push_notifications, + quotes=quotes, reactions=reactions, read_events=read_events, + reminders=reminders, replies=replies, search=search, shared_locations=shared_locations, @@ -988,6 +1139,7 @@ def create_channel_type( blocklists=blocklists, commands=commands, permissions=permissions, + automod_thresholds=automod_thresholds, chat_preferences=chat_preferences, grants=grants, ).to_dict() @@ -1019,22 +1171,22 @@ def get_channel_type(self, name: str) -> StreamResponse[GetChannelTypeResponse]: def update_channel_type( self, name: str, - automod: str, - automod_behavior: str, - max_message_length: int, + automod: Optional[AutomodMode] = None, + automod_behavior: Optional[ChannelModerationBehavior] = None, blocklist: Optional[str] = None, - blocklist_behavior: Optional[str] = None, + blocklist_behavior: Optional[ChannelModerationBehavior] = None, connect_events: Optional[bool] = None, count_messages: Optional[bool] = None, custom_events: Optional[bool] = None, delivery_events: Optional[bool] = None, mark_messages_pending: Optional[bool] = None, + max_message_length: Optional[int] = None, message_retention: Optional[str] = None, mutes: Optional[bool] = None, partition_size: Optional[int] = None, partition_ttl: Optional[str] = None, polls: Optional[bool] = None, - push_level: Optional[str] = None, + push_level: Optional[PushLevel] = None, push_notifications: Optional[bool] = None, quotes: Optional[bool] = None, reactions: Optional[bool] = None, @@ -1062,7 +1214,6 @@ def update_channel_type( json = UpdateChannelTypeRequest( automod=automod, automod_behavior=automod_behavior, - max_message_length=max_message_length, blocklist=blocklist, blocklist_behavior=blocklist_behavior, connect_events=connect_events, @@ -1070,6 +1221,7 @@ def update_channel_type( custom_events=custom_events, delivery_events=delivery_events, mark_messages_pending=mark_messages_pending, + max_message_length=max_message_length, message_retention=message_retention, mutes=mutes, partition_size=partition_size, @@ -1210,11 +1362,39 @@ def export_channels( "/api/v2/chat/export_channels", ExportChannelsResponse, json=json ) + @telemetry.operation_name("getstream.api.chat.get_history_window_teams") + def get_history_window_teams(self) -> StreamResponse[GetHistoryWindowTeamsResponse]: + return self.get( + "/api/v2/chat/history_window/teams", GetHistoryWindowTeamsResponse + ) + + @telemetry.operation_name("getstream.api.chat.set_history_window_teams") + def set_history_window_teams( + self, teams: List[str] + ) -> StreamResponse[SetHistoryWindowTeamsResponse]: + json = SetHistoryWindowTeamsRequest(teams=teams).to_dict() + return self.post( + "/api/v2/chat/history_window/teams", + SetHistoryWindowTeamsResponse, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.delete_history_window_teams") + def delete_history_window_teams( + self, teams: List[str] + ) -> StreamResponse[DeleteHistoryWindowTeamsResponse]: + json = DeleteHistoryWindowTeamsRequest(teams=teams).to_dict() + return self.post( + "/api/v2/chat/history_window/teams/delete", + DeleteHistoryWindowTeamsResponse, + json=json, + ) + @telemetry.operation_name("getstream.api.chat.query_members") def query_members( self, payload: Optional[QueryMembersPayload] = None ) -> StreamResponse[MembersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get( "/api/v2/chat/members", MembersResponse, query_params=query_params ) @@ -1244,7 +1424,7 @@ def delete_message( delete_for_me: Optional[bool] = None, ) -> StreamResponse[DeleteMessageResponse]: query_params = build_query_param( - hard=hard, deleted_by=deleted_by, delete_for_me=delete_for_me + **{"hard": hard, "deleted_by": deleted_by, "delete_for_me": delete_for_me} ) path_params = { "id": id, @@ -1260,7 +1440,9 @@ def delete_message( def get_message( self, id: str, show_deleted_message: Optional[bool] = None ) -> StreamResponse[GetMessageResponse]: - query_params = build_query_param(show_deleted_message=show_deleted_message) + query_params = build_query_param( + **{"show_deleted_message": show_deleted_message} + ) path_params = { "id": id, } @@ -1343,19 +1525,14 @@ def run_message_action( ) @telemetry.operation_name("getstream.api.chat.commit_message") - def commit_message( - self, - id: str, - ) -> StreamResponse[MessageActionResponse]: + def commit_message(self, id: str) -> StreamResponse[MessageActionResponse]: path_params = { "id": id, } - json = CommitMessageRequest().to_dict() return self.post( "/api/v2/chat/messages/{id}/commit", MessageActionResponse, path_params=path_params, - json=json, ) @telemetry.operation_name("getstream.api.chat.ephemeral_message_update") @@ -1412,7 +1589,7 @@ def send_reaction( def delete_reaction( self, id: str, type: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteReactionResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, "type": type, @@ -1428,7 +1605,7 @@ def delete_reaction( def get_reactions( self, id: str, limit: Optional[int] = None, offset: Optional[int] = None ) -> StreamResponse[GetReactionsResponse]: - query_params = build_query_param(limit=limit, offset=offset) + query_params = build_query_param(**{"limit": limit, "offset": offset}) path_params = { "id": id, } @@ -1505,6 +1682,8 @@ def cast_poll_vote( self, message_id: str, poll_id: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, vote: Optional[VoteData] = None, @@ -1513,7 +1692,13 @@ def cast_poll_vote( "message_id": message_id, "poll_id": poll_id, } - json = CastPollVoteRequest(user_id=user_id, user=user, vote=vote).to_dict() + json = CastPollVoteRequest( + config_key=config_key, + config_team=config_team, + user_id=user_id, + user=user, + vote=vote, + ).to_dict() return self.post( "/api/v2/chat/messages/{message_id}/polls/{poll_id}/vote", PollVoteResponse, @@ -1525,7 +1710,7 @@ def cast_poll_vote( def delete_poll_vote( self, message_id: str, poll_id: str, vote_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollVoteResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "message_id": message_id, "poll_id": poll_id, @@ -1542,7 +1727,7 @@ def delete_poll_vote( def delete_reminder( self, message_id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteReminderResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "message_id": message_id, } @@ -1557,6 +1742,7 @@ def delete_reminder( def update_reminder( self, message_id: str, + expires_at: Optional[datetime] = None, remind_at: Optional[datetime] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -1565,7 +1751,7 @@ def update_reminder( "message_id": message_id, } json = UpdateReminderRequest( - remind_at=remind_at, user_id=user_id, user=user + expires_at=expires_at, remind_at=remind_at, user_id=user_id, user=user ).to_dict() return self.patch( "/api/v2/chat/messages/{message_id}/reminders", @@ -1578,6 +1764,7 @@ def update_reminder( def create_reminder( self, message_id: str, + expires_at: Optional[datetime] = None, remind_at: Optional[datetime] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -1586,7 +1773,7 @@ def create_reminder( "message_id": message_id, } json = CreateReminderRequest( - remind_at=remind_at, user_id=user_id, user=user + expires_at=expires_at, remind_at=remind_at, user_id=user_id, user=user ).to_dict() return self.post( "/api/v2/chat/messages/{message_id}/reminders", @@ -1609,14 +1796,16 @@ def get_replies( member_custom_include: Optional[List[str]] = None, ) -> StreamResponse[GetRepliesResponse]: query_params = build_query_param( - limit=limit, - id_gte=id_gte, - id_gt=id_gt, - id_lte=id_lte, - id_lt=id_lt, - id_around=id_around, - sort=sort, - member_custom_include=member_custom_include, + **{ + "limit": limit, + "id_gte": id_gte, + "id_gt": id_gt, + "id_lte": id_lte, + "id_lt": id_lt, + "id_around": id_around, + "sort": sort, + "member_custom_include": member_custom_include, + } ) path_params = { "parent_id": parent_id, @@ -1632,7 +1821,7 @@ def get_replies( def query_message_flags( self, payload: Optional[QueryMessageFlagsPayload] = None ) -> StreamResponse[QueryMessageFlagsResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get( "/api/v2/chat/moderation/flags/message", QueryMessageFlagsResponse, @@ -1675,7 +1864,9 @@ def get_predefined_filters( include_stats: Optional[bool] = None, sort: Optional[List[SortParamRequest]] = None, ) -> StreamResponse[QueryPredefinedFiltersResponse]: - query_params = build_query_param(include_stats=include_stats, sort=sort) + query_params = build_query_param( + **{"include_stats": include_stats, "sort": sort} + ) return self.get( "/api/v2/chat/predefined_filters", QueryPredefinedFiltersResponse, @@ -1750,7 +1941,7 @@ def update_predefined_filter( def query_banned_users( self, payload: Optional[QueryBannedUsersPayload] = None ) -> StreamResponse[QueryBannedUsersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get( "/api/v2/chat/query_banned_users", QueryBannedUsersResponse, @@ -1761,7 +1952,7 @@ def query_banned_users( def query_future_channel_bans( self, payload: Optional[QueryFutureChannelBansPayload] = None ) -> StreamResponse[QueryFutureChannelBansResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get( "/api/v2/chat/query_future_channel_bans", QueryFutureChannelBansResponse, @@ -1798,10 +1989,13 @@ def get_retention_policy(self) -> StreamResponse[GetRetentionPolicyResponse]: @telemetry.operation_name("getstream.api.chat.set_retention_policy") def set_retention_policy( - self, max_age_hours: int, policy: str + self, + max_age_hours: int, + policy: RetentionPolicyType, + channel_type: Optional[str] = None, ) -> StreamResponse[SetRetentionPolicyResponse]: json = SetRetentionPolicyRequest( - max_age_hours=max_age_hours, policy=policy + max_age_hours=max_age_hours, policy=policy, channel_type=channel_type ).to_dict() return self.post( "/api/v2/chat/retention_policy", SetRetentionPolicyResponse, json=json @@ -1809,9 +2003,11 @@ def set_retention_policy( @telemetry.operation_name("getstream.api.chat.delete_retention_policy") def delete_retention_policy( - self, policy: str + self, policy: RetentionPolicyType, channel_type: Optional[str] = None ) -> StreamResponse[DeleteRetentionPolicyResponse]: - json = DeleteRetentionPolicyRequest(policy=policy).to_dict() + json = DeleteRetentionPolicyRequest( + policy=policy, channel_type=channel_type + ).to_dict() return self.post( "/api/v2/chat/retention_policy/delete", DeleteRetentionPolicyResponse, @@ -1840,11 +2036,76 @@ def get_retention_policy_runs( json=json, ) + @telemetry.operation_name("getstream.api.chat.query_scheduled_messages") + def query_scheduled_messages( + self, + limit: Optional[int] = None, + next: Optional[str] = None, + user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter: Optional[ScheduledMessagesFilter] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryScheduledMessagesResponse]: + json = QueryScheduledMessagesRequest( + limit=limit, next=next, user_id=user_id, sort=sort, filter=filter, user=user + ).to_dict() + return self.post( + "/api/v2/chat/scheduled_messages/query", + QueryScheduledMessagesResponse, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.delete_scheduled_message") + def delete_scheduled_message( + self, id: str + ) -> StreamResponse[DeleteScheduledMessageResponse]: + path_params = { + "id": id, + } + return self.delete( + "/api/v2/chat/scheduled_messages/{id}", + DeleteScheduledMessageResponse, + path_params=path_params, + ) + + @telemetry.operation_name("getstream.api.chat.update_scheduled_message") + def update_scheduled_message( + self, + id: str, + scheduled_at: Optional[datetime] = None, + message: Optional[MessageRequest] = None, + ) -> StreamResponse[UpdateScheduledMessageResponse]: + path_params = { + "id": id, + } + json = UpdateScheduledMessageRequest( + scheduled_at=scheduled_at, message=message + ).to_dict() + return self.patch( + "/api/v2/chat/scheduled_messages/{id}", + UpdateScheduledMessageResponse, + path_params=path_params, + json=json, + ) + + @telemetry.operation_name("getstream.api.chat.send_scheduled_message_now") + def send_scheduled_message_now( + self, id: str + ) -> StreamResponse[SendScheduledMessageNowResponse]: + path_params = { + "id": id, + } + return self.post( + "/api/v2/chat/scheduled_messages/{id}/send_now", + SendScheduledMessageNowResponse, + path_params=path_params, + ) + @telemetry.operation_name("getstream.api.chat.search") def search( self, payload: Optional[SearchPayload] = None ) -> StreamResponse[SearchResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get( "/api/v2/chat/search", SearchResponse, query_params=query_params ) @@ -2052,9 +2313,11 @@ def get_thread( member_limit: Optional[int] = None, ) -> StreamResponse[GetThreadResponse]: query_params = build_query_param( - reply_limit=reply_limit, - participant_limit=participant_limit, - member_limit=member_limit, + **{ + "reply_limit": reply_limit, + "participant_limit": participant_limit, + "member_limit": member_limit, + } ) path_params = { "message_id": message_id, @@ -2090,9 +2353,13 @@ def update_thread_partial( @telemetry.operation_name("getstream.api.chat.unread_counts") def unread_counts( - self, user_id: Optional[str] = None + self, + user_id: Optional[str] = None, + include_large_channels: Optional[bool] = None, ) -> StreamResponse[WrappedUnreadCountsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param( + **{"user_id": user_id, "include_large_channels": include_large_channels} + ) return self.get( "/api/v2/chat/unread", WrappedUnreadCountsResponse, diff --git a/getstream/common/async_rest_client.py b/getstream/common/async_rest_client.py index 20967244..1a428f42 100644 --- a/getstream/common/async_rest_client.py +++ b/getstream/common/async_rest_client.py @@ -77,6 +77,7 @@ async def update_app( sqs_key: Optional[str] = None, sqs_secret: Optional[str] = None, sqs_url: Optional[str] = None, + two_way_block_effect_enabled: Optional[bool] = None, user_response_time_enabled: Optional[bool] = None, video_primary_use_case: Optional[str] = None, webhook_url: Optional[str] = None, @@ -141,6 +142,7 @@ async def update_app( sqs_key=sqs_key, sqs_secret=sqs_secret, sqs_url=sqs_url, + two_way_block_effect_enabled=two_way_block_effect_enabled, user_response_time_enabled=user_response_time_enabled, video_primary_use_case=video_primary_use_case, webhook_url=webhook_url, @@ -172,7 +174,9 @@ async def list_block_lists( cursor: Optional[str] = None, limit: Optional[int] = None, ) -> StreamResponse[ListBlockListResponse]: - query_params = build_query_param(team=team, cursor=cursor, limit=limit) + query_params = build_query_param( + **{"team": team, "cursor": cursor, "limit": limit} + ) return await self.get( "/api/v2/blocklists", ListBlockListResponse, query_params=query_params ) @@ -224,7 +228,7 @@ async def import_block_list( async def delete_block_list( self, name: str, team: Optional[str] = None, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(team=team, user_id=user_id) + query_params = build_query_param(**{"team": team, "user_id": user_id}) path_params = { "name": name, } @@ -239,7 +243,7 @@ async def delete_block_list( async def get_block_list( self, name: str, team: Optional[str] = None ) -> StreamResponse[GetBlockListResponse]: - query_params = build_query_param(team=team) + query_params = build_query_param(**{"team": team}) path_params = { "name": name, } @@ -283,6 +287,22 @@ async def update_block_list( json=json, ) + @telemetry.operation_name("getstream.api.common.check_gcp_pub_sub") + async def check_gcp_pub_sub( + self, + gcp_pubsub_event_based_ordering_key_enabled: Optional[bool] = None, + gcp_pubsub_region: Optional[str] = None, + gcp_pubsub_topic: Optional[str] = None, + ) -> StreamResponse[CheckGCPPubSubResponse]: + json = CheckGCPPubSubRequest( + gcp_pubsub_event_based_ordering_key_enabled=gcp_pubsub_event_based_ordering_key_enabled, + gcp_pubsub_region=gcp_pubsub_region, + gcp_pubsub_topic=gcp_pubsub_topic, + ).to_dict() + return await self.post( + "/api/v2/check_gcp_pubsub", CheckGCPPubSubResponse, json=json + ) + @telemetry.operation_name("getstream.api.common.check_push") async def check_push( self, @@ -292,7 +312,7 @@ async def check_push( firebase_template: Optional[str] = None, message_id: Optional[str] = None, push_provider_name: Optional[str] = None, - push_provider_type: Optional[str] = None, + push_provider_type: Optional[PushProviderName] = None, skip_devices: Optional[bool] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -339,14 +359,14 @@ async def check_sqs( async def delete_device( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(id=id, user_id=user_id) + query_params = build_query_param(**{"id": id, "user_id": user_id}) return await self.delete("/api/v2/devices", Response, query_params=query_params) @telemetry.operation_name("getstream.api.common.list_devices") async def list_devices( self, user_id: Optional[str] = None ) -> StreamResponse[ListDevicesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return await self.get( "/api/v2/devices", ListDevicesResponse, query_params=query_params ) @@ -355,7 +375,7 @@ async def list_devices( async def create_device( self, id: str, - push_provider: str, + push_provider: PushProviderName, hardware_id: Optional[str] = None, push_provider_name: Optional[str] = None, user_id: Optional[str] = None, @@ -498,7 +518,7 @@ async def create_import( async def list_import_v2_tasks( self, state: Optional[int] = None ) -> StreamResponse[ListImportV2TasksResponse]: - query_params = build_query_param(state=state) + query_params = build_query_param(**{"state": state}) return await self.get( "/api/v2/imports/v2", ListImportV2TasksResponse, query_params=query_params ) @@ -605,7 +625,7 @@ async def get_import(self, id: str) -> StreamResponse[GetImportResponse]: @telemetry.operation_name("getstream.api.common.get_og") async def get_og(self, url: str) -> StreamResponse[GetOGResponse]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return await self.get("/api/v2/og", GetOGResponse, query_params=query_params) @telemetry.operation_name("getstream.api.common.list_permissions") @@ -688,13 +708,16 @@ async def create_poll( name: str, allow_answers: Optional[bool] = None, allow_user_suggested_options: Optional[bool] = None, + config_key: Optional[str] = None, + config_team: Optional[str] = None, description: Optional[str] = None, enforce_unique_vote: Optional[bool] = None, id: Optional[str] = None, is_closed: Optional[bool] = None, max_votes_allowed: Optional[int] = None, + team: Optional[str] = None, user_id: Optional[str] = None, - voting_visibility: Optional[str] = None, + voting_visibility: Optional[VotingVisibility] = None, options: Optional[List[PollOptionInput]] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -703,11 +726,14 @@ async def create_poll( name=name, allow_answers=allow_answers, allow_user_suggested_options=allow_user_suggested_options, + config_key=config_key, + config_team=config_team, description=description, enforce_unique_vote=enforce_unique_vote, id=id, is_closed=is_closed, max_votes_allowed=max_votes_allowed, + team=team, user_id=user_id, voting_visibility=voting_visibility, options=options, @@ -723,12 +749,14 @@ async def update_poll( name: str, allow_answers: Optional[bool] = None, allow_user_suggested_options: Optional[bool] = None, + config_key: Optional[str] = None, + config_team: Optional[str] = None, description: Optional[str] = None, enforce_unique_vote: Optional[bool] = None, is_closed: Optional[bool] = None, max_votes_allowed: Optional[int] = None, user_id: Optional[str] = None, - voting_visibility: Optional[str] = None, + voting_visibility: Optional[VotingVisibility] = None, options: Optional[List[PollOptionRequest]] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -738,6 +766,8 @@ async def update_poll( name=name, allow_answers=allow_answers, allow_user_suggested_options=allow_user_suggested_options, + config_key=config_key, + config_team=config_team, description=description, enforce_unique_vote=enforce_unique_vote, is_closed=is_closed, @@ -760,7 +790,7 @@ async def query_polls( sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryPollsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = QueryPollsRequest( limit=limit, next=next, prev=prev, sort=sort, filter=filter ).to_dict() @@ -775,7 +805,7 @@ async def query_polls( async def delete_poll( self, poll_id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -790,7 +820,7 @@ async def delete_poll( async def get_poll( self, poll_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -805,6 +835,8 @@ async def get_poll( async def update_poll_partial( self, poll_id: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, unset: Optional[List[str]] = None, set: Optional[Dict[str, object]] = None, @@ -814,7 +846,12 @@ async def update_poll_partial( "poll_id": poll_id, } json = UpdatePollPartialRequest( - user_id=user_id, unset=unset, set=set, user=user + config_key=config_key, + config_team=config_team, + user_id=user_id, + unset=unset, + set=set, + user=user, ).to_dict() return await self.patch( "/api/v2/polls/{poll_id}", PollResponse, path_params=path_params, json=json @@ -825,6 +862,8 @@ async def create_poll_option( self, poll_id: str, text: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -833,7 +872,12 @@ async def create_poll_option( "poll_id": poll_id, } json = CreatePollOptionRequest( - text=text, user_id=user_id, custom=custom, user=user + text=text, + config_key=config_key, + config_team=config_team, + user_id=user_id, + custom=custom, + user=user, ).to_dict() return await self.post( "/api/v2/polls/{poll_id}/options", @@ -848,6 +892,8 @@ async def update_poll_option( poll_id: str, id: str, text: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -856,7 +902,13 @@ async def update_poll_option( "poll_id": poll_id, } json = UpdatePollOptionRequest( - id=id, text=text, user_id=user_id, custom=custom, user=user + id=id, + text=text, + config_key=config_key, + config_team=config_team, + user_id=user_id, + custom=custom, + user=user, ).to_dict() return await self.put( "/api/v2/polls/{poll_id}/options", @@ -869,7 +921,7 @@ async def update_poll_option( async def delete_poll_option( self, poll_id: str, option_id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, "option_id": option_id, @@ -883,8 +935,9 @@ async def delete_poll_option( @telemetry.operation_name("getstream.api.common.get_poll_option") async def get_poll_option( - self, poll_id: str, option_id: str + self, poll_id: str, option_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollOptionResponse]: + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, "option_id": option_id, @@ -892,6 +945,7 @@ async def get_poll_option( return await self.get( "/api/v2/polls/{poll_id}/options/{option_id}", PollOptionResponse, + query_params=query_params, path_params=path_params, ) @@ -906,7 +960,7 @@ async def query_poll_votes( sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[PollVotesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -947,7 +1001,7 @@ async def upsert_push_provider( @telemetry.operation_name("getstream.api.common.delete_push_provider") async def delete_push_provider( - self, type: str, name: str + self, type: PushProviderName, name: str ) -> StreamResponse[Response]: path_params = { "type": type, @@ -959,10 +1013,15 @@ async def delete_push_provider( @telemetry.operation_name("getstream.api.common.get_push_templates") async def get_push_templates( - self, push_provider_type: str, push_provider_name: Optional[str] = None + self, + push_provider_type: PushProviderName, + push_provider_name: Optional[str] = None, ) -> StreamResponse[GetPushTemplatesResponse]: query_params = build_query_param( - push_provider_type=push_provider_type, push_provider_name=push_provider_name + **{ + "push_provider_type": push_provider_type, + "push_provider_name": push_provider_name, + } ) return await self.get( "/api/v2/push_templates", @@ -974,7 +1033,7 @@ async def get_push_templates( async def upsert_push_template( self, event_type: str, - push_provider_type: str, + push_provider_type: PushProviderName, enable_push: Optional[bool] = None, push_provider_name: Optional[str] = None, template: Optional[str] = None, @@ -1003,14 +1062,16 @@ async def get_rate_limits( endpoints: Optional[str] = None, ) -> StreamResponse[GetRateLimitsResponse]: query_params = build_query_param( - server_side=server_side, - android=android, - ios=ios, - web=web, - unity=unity, - unity_desktop=unity_desktop, - unity_console=unity_console, - endpoints=endpoints, + **{ + "server_side": server_side, + "android": android, + "ios": ios, + "web": web, + "unity": unity, + "unity_desktop": unity_desktop, + "unity_console": unity_console, + "endpoints": endpoints, + } ) return await self.get( "/api/v2/rate_limits", GetRateLimitsResponse, query_params=query_params @@ -1035,11 +1096,13 @@ async def search_roles( include_global_roles: Optional[bool] = None, ) -> StreamResponse[SearchRolesResponse]: query_params = build_query_param( - query=query, - limit=limit, - name_gt=name_gt, - role_type=role_type, - include_global_roles=include_global_roles, + **{ + "query": query, + "limit": limit, + "name_gt": name_gt, + "role_type": role_type, + "include_global_roles": include_global_roles, + } ) return await self.get( "/api/v2/roles/search", SearchRolesResponse, query_params=query_params @@ -1065,7 +1128,7 @@ async def get_task(self, id: str) -> StreamResponse[GetTaskResponse]: @telemetry.operation_name("getstream.api.common.delete_file") async def delete_file(self, url: Optional[str] = None) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return await self.delete( "/api/v2/uploads/file", Response, query_params=query_params ) @@ -1075,11 +1138,13 @@ async def upload_file( self, file: Optional[str] = None, user: Optional[OnlyUserID] = None ) -> StreamResponse[FileUploadResponse]: json = FileUploadRequest(file=file, user=user).to_dict() - return await self.post("/api/v2/uploads/file", FileUploadResponse, json=json) + return await self._upload_multipart( + "/api/v2/uploads/file", FileUploadResponse, json=json + ) @telemetry.operation_name("getstream.api.common.delete_image") async def delete_image(self, url: Optional[str] = None) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return await self.delete( "/api/v2/uploads/image", Response, query_params=query_params ) @@ -1094,7 +1159,9 @@ async def upload_image( json = ImageUploadRequest( file=file, upload_sizes=upload_sizes, user=user ).to_dict() - return await self.post("/api/v2/uploads/image", ImageUploadResponse, json=json) + return await self._upload_multipart( + "/api/v2/uploads/image", ImageUploadResponse, json=json + ) @telemetry.operation_name("getstream.api.common.list_user_groups") async def list_user_groups( @@ -1105,7 +1172,12 @@ async def list_user_groups( team_id: Optional[str] = None, ) -> StreamResponse[ListUserGroupsResponse]: query_params = build_query_param( - limit=limit, id_gt=id_gt, created_at_gt=created_at_gt, team_id=team_id + **{ + "limit": limit, + "id_gt": id_gt, + "created_at_gt": created_at_gt, + "team_id": team_id, + } ) return await self.get( "/api/v2/usergroups", ListUserGroupsResponse, query_params=query_params @@ -1139,7 +1211,13 @@ async def search_user_groups( team_id: Optional[str] = None, ) -> StreamResponse[SearchUserGroupsResponse]: query_params = build_query_param( - query=query, limit=limit, name_gt=name_gt, id_gt=id_gt, team_id=team_id + **{ + "query": query, + "limit": limit, + "name_gt": name_gt, + "id_gt": id_gt, + "team_id": team_id, + } ) return await self.get( "/api/v2/usergroups/search", @@ -1151,7 +1229,7 @@ async def search_user_groups( async def delete_user_group( self, id: str, team_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(team_id=team_id) + query_params = build_query_param(**{"team_id": team_id}) path_params = { "id": id, } @@ -1166,7 +1244,7 @@ async def delete_user_group( async def get_user_group( self, id: str, team_id: Optional[str] = None ) -> StreamResponse[GetUserGroupResponse]: - query_params = build_query_param(team_id=team_id) + query_params = build_query_param(**{"team_id": team_id}) path_params = { "id": id, } @@ -1240,7 +1318,7 @@ async def remove_user_group_members( async def query_users( self, payload: Optional[QueryUsersPayload] = None ) -> StreamResponse[QueryUsersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return await self.get( "/api/v2/users", QueryUsersResponse, query_params=query_params ) @@ -1263,7 +1341,7 @@ async def update_users( async def get_blocked_users( self, user_id: Optional[str] = None ) -> StreamResponse[GetBlockedUsersResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return await self.get( "/api/v2/users/block", GetBlockedUsersResponse, query_params=query_params ) @@ -1280,6 +1358,17 @@ async def block_users( ).to_dict() return await self.post("/api/v2/users/block", BlockUsersResponse, json=json) + @telemetry.operation_name("getstream.api.common.claim_guest_user") + async def claim_guest_user( + self, guest_user_id: str, user_id: str + ) -> StreamResponse[ClaimGuestUserResponse]: + json = ClaimGuestUserRequest( + guest_user_id=guest_user_id, user_id=user_id + ).to_dict() + return await self.post( + "/api/v2/users/claim_guest", ClaimGuestUserResponse, json=json + ) + @telemetry.operation_name("getstream.api.common.deactivate_users") async def deactivate_users( self, @@ -1326,7 +1415,7 @@ async def delete_users( async def get_user_live_locations( self, user_id: Optional[str] = None ) -> StreamResponse[SharedLocationsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return await self.get( "/api/v2/users/live_locations", SharedLocationsResponse, @@ -1342,7 +1431,7 @@ async def update_live_location( longitude: Optional[float] = None, user_id: Optional[str] = None, ) -> StreamResponse[SharedLocationResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = UpdateLiveLocationRequest( message_id=message_id, end_at=end_at, latitude=latitude, longitude=longitude ).to_dict() diff --git a/getstream/common/rest_client.py b/getstream/common/rest_client.py index 06405a58..9c2c0e28 100644 --- a/getstream/common/rest_client.py +++ b/getstream/common/rest_client.py @@ -77,6 +77,7 @@ def update_app( sqs_key: Optional[str] = None, sqs_secret: Optional[str] = None, sqs_url: Optional[str] = None, + two_way_block_effect_enabled: Optional[bool] = None, user_response_time_enabled: Optional[bool] = None, video_primary_use_case: Optional[str] = None, webhook_url: Optional[str] = None, @@ -141,6 +142,7 @@ def update_app( sqs_key=sqs_key, sqs_secret=sqs_secret, sqs_url=sqs_url, + two_way_block_effect_enabled=two_way_block_effect_enabled, user_response_time_enabled=user_response_time_enabled, video_primary_use_case=video_primary_use_case, webhook_url=webhook_url, @@ -172,7 +174,9 @@ def list_block_lists( cursor: Optional[str] = None, limit: Optional[int] = None, ) -> StreamResponse[ListBlockListResponse]: - query_params = build_query_param(team=team, cursor=cursor, limit=limit) + query_params = build_query_param( + **{"team": team, "cursor": cursor, "limit": limit} + ) return self.get( "/api/v2/blocklists", ListBlockListResponse, query_params=query_params ) @@ -224,7 +228,7 @@ def import_block_list( def delete_block_list( self, name: str, team: Optional[str] = None, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(team=team, user_id=user_id) + query_params = build_query_param(**{"team": team, "user_id": user_id}) path_params = { "name": name, } @@ -239,7 +243,7 @@ def delete_block_list( def get_block_list( self, name: str, team: Optional[str] = None ) -> StreamResponse[GetBlockListResponse]: - query_params = build_query_param(team=team) + query_params = build_query_param(**{"team": team}) path_params = { "name": name, } @@ -283,6 +287,20 @@ def update_block_list( json=json, ) + @telemetry.operation_name("getstream.api.common.check_gcp_pub_sub") + def check_gcp_pub_sub( + self, + gcp_pubsub_event_based_ordering_key_enabled: Optional[bool] = None, + gcp_pubsub_region: Optional[str] = None, + gcp_pubsub_topic: Optional[str] = None, + ) -> StreamResponse[CheckGCPPubSubResponse]: + json = CheckGCPPubSubRequest( + gcp_pubsub_event_based_ordering_key_enabled=gcp_pubsub_event_based_ordering_key_enabled, + gcp_pubsub_region=gcp_pubsub_region, + gcp_pubsub_topic=gcp_pubsub_topic, + ).to_dict() + return self.post("/api/v2/check_gcp_pubsub", CheckGCPPubSubResponse, json=json) + @telemetry.operation_name("getstream.api.common.check_push") def check_push( self, @@ -292,7 +310,7 @@ def check_push( firebase_template: Optional[str] = None, message_id: Optional[str] = None, push_provider_name: Optional[str] = None, - push_provider_type: Optional[str] = None, + push_provider_type: Optional[PushProviderName] = None, skip_devices: Optional[bool] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, @@ -339,14 +357,14 @@ def check_sqs( def delete_device( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(id=id, user_id=user_id) + query_params = build_query_param(**{"id": id, "user_id": user_id}) return self.delete("/api/v2/devices", Response, query_params=query_params) @telemetry.operation_name("getstream.api.common.list_devices") def list_devices( self, user_id: Optional[str] = None ) -> StreamResponse[ListDevicesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return self.get( "/api/v2/devices", ListDevicesResponse, query_params=query_params ) @@ -355,7 +373,7 @@ def list_devices( def create_device( self, id: str, - push_provider: str, + push_provider: PushProviderName, hardware_id: Optional[str] = None, push_provider_name: Optional[str] = None, user_id: Optional[str] = None, @@ -490,7 +508,7 @@ def create_import( def list_import_v2_tasks( self, state: Optional[int] = None ) -> StreamResponse[ListImportV2TasksResponse]: - query_params = build_query_param(state=state) + query_params = build_query_param(**{"state": state}) return self.get( "/api/v2/imports/v2", ListImportV2TasksResponse, query_params=query_params ) @@ -593,7 +611,7 @@ def get_import(self, id: str) -> StreamResponse[GetImportResponse]: @telemetry.operation_name("getstream.api.common.get_og") def get_og(self, url: str) -> StreamResponse[GetOGResponse]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return self.get("/api/v2/og", GetOGResponse, query_params=query_params) @telemetry.operation_name("getstream.api.common.list_permissions") @@ -674,13 +692,16 @@ def create_poll( name: str, allow_answers: Optional[bool] = None, allow_user_suggested_options: Optional[bool] = None, + config_key: Optional[str] = None, + config_team: Optional[str] = None, description: Optional[str] = None, enforce_unique_vote: Optional[bool] = None, id: Optional[str] = None, is_closed: Optional[bool] = None, max_votes_allowed: Optional[int] = None, + team: Optional[str] = None, user_id: Optional[str] = None, - voting_visibility: Optional[str] = None, + voting_visibility: Optional[VotingVisibility] = None, options: Optional[List[PollOptionInput]] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -689,11 +710,14 @@ def create_poll( name=name, allow_answers=allow_answers, allow_user_suggested_options=allow_user_suggested_options, + config_key=config_key, + config_team=config_team, description=description, enforce_unique_vote=enforce_unique_vote, id=id, is_closed=is_closed, max_votes_allowed=max_votes_allowed, + team=team, user_id=user_id, voting_visibility=voting_visibility, options=options, @@ -709,12 +733,14 @@ def update_poll( name: str, allow_answers: Optional[bool] = None, allow_user_suggested_options: Optional[bool] = None, + config_key: Optional[str] = None, + config_team: Optional[str] = None, description: Optional[str] = None, enforce_unique_vote: Optional[bool] = None, is_closed: Optional[bool] = None, max_votes_allowed: Optional[int] = None, user_id: Optional[str] = None, - voting_visibility: Optional[str] = None, + voting_visibility: Optional[VotingVisibility] = None, options: Optional[List[PollOptionRequest]] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -724,6 +750,8 @@ def update_poll( name=name, allow_answers=allow_answers, allow_user_suggested_options=allow_user_suggested_options, + config_key=config_key, + config_team=config_team, description=description, enforce_unique_vote=enforce_unique_vote, is_closed=is_closed, @@ -746,7 +774,7 @@ def query_polls( sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryPollsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = QueryPollsRequest( limit=limit, next=next, prev=prev, sort=sort, filter=filter ).to_dict() @@ -761,7 +789,7 @@ def query_polls( def delete_poll( self, poll_id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -776,7 +804,7 @@ def delete_poll( def get_poll( self, poll_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -791,6 +819,8 @@ def get_poll( def update_poll_partial( self, poll_id: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, unset: Optional[List[str]] = None, set: Optional[Dict[str, object]] = None, @@ -800,7 +830,12 @@ def update_poll_partial( "poll_id": poll_id, } json = UpdatePollPartialRequest( - user_id=user_id, unset=unset, set=set, user=user + config_key=config_key, + config_team=config_team, + user_id=user_id, + unset=unset, + set=set, + user=user, ).to_dict() return self.patch( "/api/v2/polls/{poll_id}", PollResponse, path_params=path_params, json=json @@ -811,6 +846,8 @@ def create_poll_option( self, poll_id: str, text: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -819,7 +856,12 @@ def create_poll_option( "poll_id": poll_id, } json = CreatePollOptionRequest( - text=text, user_id=user_id, custom=custom, user=user + text=text, + config_key=config_key, + config_team=config_team, + user_id=user_id, + custom=custom, + user=user, ).to_dict() return self.post( "/api/v2/polls/{poll_id}/options", @@ -834,6 +876,8 @@ def update_poll_option( poll_id: str, id: str, text: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, @@ -842,7 +886,13 @@ def update_poll_option( "poll_id": poll_id, } json = UpdatePollOptionRequest( - id=id, text=text, user_id=user_id, custom=custom, user=user + id=id, + text=text, + config_key=config_key, + config_team=config_team, + user_id=user_id, + custom=custom, + user=user, ).to_dict() return self.put( "/api/v2/polls/{poll_id}/options", @@ -855,7 +905,7 @@ def update_poll_option( def delete_poll_option( self, poll_id: str, option_id: str, user_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, "option_id": option_id, @@ -869,8 +919,9 @@ def delete_poll_option( @telemetry.operation_name("getstream.api.common.get_poll_option") def get_poll_option( - self, poll_id: str, option_id: str + self, poll_id: str, option_id: str, user_id: Optional[str] = None ) -> StreamResponse[PollOptionResponse]: + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, "option_id": option_id, @@ -878,6 +929,7 @@ def get_poll_option( return self.get( "/api/v2/polls/{poll_id}/options/{option_id}", PollOptionResponse, + query_params=query_params, path_params=path_params, ) @@ -892,7 +944,7 @@ def query_poll_votes( sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[PollVotesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "poll_id": poll_id, } @@ -932,7 +984,9 @@ def upsert_push_provider( ) @telemetry.operation_name("getstream.api.common.delete_push_provider") - def delete_push_provider(self, type: str, name: str) -> StreamResponse[Response]: + def delete_push_provider( + self, type: PushProviderName, name: str + ) -> StreamResponse[Response]: path_params = { "type": type, "name": name, @@ -943,10 +997,15 @@ def delete_push_provider(self, type: str, name: str) -> StreamResponse[Response] @telemetry.operation_name("getstream.api.common.get_push_templates") def get_push_templates( - self, push_provider_type: str, push_provider_name: Optional[str] = None + self, + push_provider_type: PushProviderName, + push_provider_name: Optional[str] = None, ) -> StreamResponse[GetPushTemplatesResponse]: query_params = build_query_param( - push_provider_type=push_provider_type, push_provider_name=push_provider_name + **{ + "push_provider_type": push_provider_type, + "push_provider_name": push_provider_name, + } ) return self.get( "/api/v2/push_templates", @@ -958,7 +1017,7 @@ def get_push_templates( def upsert_push_template( self, event_type: str, - push_provider_type: str, + push_provider_type: PushProviderName, enable_push: Optional[bool] = None, push_provider_name: Optional[str] = None, template: Optional[str] = None, @@ -987,14 +1046,16 @@ def get_rate_limits( endpoints: Optional[str] = None, ) -> StreamResponse[GetRateLimitsResponse]: query_params = build_query_param( - server_side=server_side, - android=android, - ios=ios, - web=web, - unity=unity, - unity_desktop=unity_desktop, - unity_console=unity_console, - endpoints=endpoints, + **{ + "server_side": server_side, + "android": android, + "ios": ios, + "web": web, + "unity": unity, + "unity_desktop": unity_desktop, + "unity_console": unity_console, + "endpoints": endpoints, + } ) return self.get( "/api/v2/rate_limits", GetRateLimitsResponse, query_params=query_params @@ -1019,11 +1080,13 @@ def search_roles( include_global_roles: Optional[bool] = None, ) -> StreamResponse[SearchRolesResponse]: query_params = build_query_param( - query=query, - limit=limit, - name_gt=name_gt, - role_type=role_type, - include_global_roles=include_global_roles, + **{ + "query": query, + "limit": limit, + "name_gt": name_gt, + "role_type": role_type, + "include_global_roles": include_global_roles, + } ) return self.get( "/api/v2/roles/search", SearchRolesResponse, query_params=query_params @@ -1045,7 +1108,7 @@ def get_task(self, id: str) -> StreamResponse[GetTaskResponse]: @telemetry.operation_name("getstream.api.common.delete_file") def delete_file(self, url: Optional[str] = None) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return self.delete("/api/v2/uploads/file", Response, query_params=query_params) @telemetry.operation_name("getstream.api.common.upload_file") @@ -1053,11 +1116,13 @@ def upload_file( self, file: Optional[str] = None, user: Optional[OnlyUserID] = None ) -> StreamResponse[FileUploadResponse]: json = FileUploadRequest(file=file, user=user).to_dict() - return self.post("/api/v2/uploads/file", FileUploadResponse, json=json) + return self._upload_multipart( + "/api/v2/uploads/file", FileUploadResponse, json=json + ) @telemetry.operation_name("getstream.api.common.delete_image") def delete_image(self, url: Optional[str] = None) -> StreamResponse[Response]: - query_params = build_query_param(url=url) + query_params = build_query_param(**{"url": url}) return self.delete("/api/v2/uploads/image", Response, query_params=query_params) @telemetry.operation_name("getstream.api.common.upload_image") @@ -1070,7 +1135,9 @@ def upload_image( json = ImageUploadRequest( file=file, upload_sizes=upload_sizes, user=user ).to_dict() - return self.post("/api/v2/uploads/image", ImageUploadResponse, json=json) + return self._upload_multipart( + "/api/v2/uploads/image", ImageUploadResponse, json=json + ) @telemetry.operation_name("getstream.api.common.list_user_groups") def list_user_groups( @@ -1081,7 +1148,12 @@ def list_user_groups( team_id: Optional[str] = None, ) -> StreamResponse[ListUserGroupsResponse]: query_params = build_query_param( - limit=limit, id_gt=id_gt, created_at_gt=created_at_gt, team_id=team_id + **{ + "limit": limit, + "id_gt": id_gt, + "created_at_gt": created_at_gt, + "team_id": team_id, + } ) return self.get( "/api/v2/usergroups", ListUserGroupsResponse, query_params=query_params @@ -1115,7 +1187,13 @@ def search_user_groups( team_id: Optional[str] = None, ) -> StreamResponse[SearchUserGroupsResponse]: query_params = build_query_param( - query=query, limit=limit, name_gt=name_gt, id_gt=id_gt, team_id=team_id + **{ + "query": query, + "limit": limit, + "name_gt": name_gt, + "id_gt": id_gt, + "team_id": team_id, + } ) return self.get( "/api/v2/usergroups/search", @@ -1127,7 +1205,7 @@ def search_user_groups( def delete_user_group( self, id: str, team_id: Optional[str] = None ) -> StreamResponse[Response]: - query_params = build_query_param(team_id=team_id) + query_params = build_query_param(**{"team_id": team_id}) path_params = { "id": id, } @@ -1142,7 +1220,7 @@ def delete_user_group( def get_user_group( self, id: str, team_id: Optional[str] = None ) -> StreamResponse[GetUserGroupResponse]: - query_params = build_query_param(team_id=team_id) + query_params = build_query_param(**{"team_id": team_id}) path_params = { "id": id, } @@ -1216,7 +1294,7 @@ def remove_user_group_members( def query_users( self, payload: Optional[QueryUsersPayload] = None ) -> StreamResponse[QueryUsersResponse]: - query_params = build_query_param(payload=payload) + query_params = build_query_param(**{"payload": payload}) return self.get("/api/v2/users", QueryUsersResponse, query_params=query_params) @telemetry.operation_name("getstream.api.common.update_users_partial") @@ -1237,7 +1315,7 @@ def update_users( def get_blocked_users( self, user_id: Optional[str] = None ) -> StreamResponse[GetBlockedUsersResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return self.get( "/api/v2/users/block", GetBlockedUsersResponse, query_params=query_params ) @@ -1254,6 +1332,15 @@ def block_users( ).to_dict() return self.post("/api/v2/users/block", BlockUsersResponse, json=json) + @telemetry.operation_name("getstream.api.common.claim_guest_user") + def claim_guest_user( + self, guest_user_id: str, user_id: str + ) -> StreamResponse[ClaimGuestUserResponse]: + json = ClaimGuestUserRequest( + guest_user_id=guest_user_id, user_id=user_id + ).to_dict() + return self.post("/api/v2/users/claim_guest", ClaimGuestUserResponse, json=json) + @telemetry.operation_name("getstream.api.common.deactivate_users") def deactivate_users( self, @@ -1298,7 +1385,7 @@ def delete_users( def get_user_live_locations( self, user_id: Optional[str] = None ) -> StreamResponse[SharedLocationsResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return self.get( "/api/v2/users/live_locations", SharedLocationsResponse, @@ -1314,7 +1401,7 @@ def update_live_location( longitude: Optional[float] = None, user_id: Optional[str] = None, ) -> StreamResponse[SharedLocationResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) json = UpdateLiveLocationRequest( message_id=message_id, end_at=end_at, latitude=latitude, longitude=longitude ).to_dict() diff --git a/getstream/feeds/feeds.py b/getstream/feeds/feeds.py index 3ad3d7b5..6fa22b27 100644 --- a/getstream/feeds/feeds.py +++ b/getstream/feeds/feeds.py @@ -40,6 +40,7 @@ def get_or_create( user_id: Optional[str] = None, view: Optional[str] = None, watch: Optional[bool] = None, + discard_actors: Optional[List[str]] = None, data: Optional[FeedInput] = None, enrichment_options: Optional[EnrichmentOptions] = None, external_ranking: Optional[Dict[str, object]] = None, @@ -50,6 +51,7 @@ def get_or_create( interest_weights: Optional[Dict[str, float]] = None, member_pagination: Optional[PagerRequest] = None, user: Optional[UserRequest] = None, + viewer_location: Optional[Location] = None, ) -> StreamResponse[GetOrCreateFeedResponse]: response = self.client.get_or_create_feed( feed_group_id=self.feed_group, @@ -64,6 +66,7 @@ def get_or_create( user_id=user_id, view=view, watch=watch, + discard_actors=discard_actors, data=data, enrichment_options=enrichment_options, external_ranking=external_ranking, @@ -74,6 +77,7 @@ def get_or_create( interest_weights=interest_weights, member_pagination=member_pagination, user=user, + viewer_location=viewer_location, ) self._sync_from_response(response.data) return response @@ -163,7 +167,7 @@ def pin_activity( return response def change_feed_visibility( - self, visibility: str, pending_follows_action: Optional[str] = None + self, visibility: FeedVisibility, pending_follows_action: Optional[str] = None ) -> StreamResponse[ChangeFeedVisibilityResponse]: response = self.client.change_feed_visibility( feed_group_id=self.feed_group, @@ -239,16 +243,30 @@ def reject_feed_member_invite( self._sync_from_response(response.data) return response + def get_notification_status( + self, view: Optional[str] = None, user_id: Optional[str] = None + ) -> StreamResponse[GetNotificationStatusResponse]: + response = self.client.get_notification_status( + feed_group_id=self.feed_group, feed_id=self.id, view=view, user_id=user_id + ) + self._sync_from_response(response.data) + return response + def query_pinned_activities( self, language: Optional[str] = None, translate_text: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, + include_expired_activities: Optional[bool] = None, + include_moderated_activities: Optional[bool] = None, + include_soft_deleted_activities: Optional[bool] = None, limit: Optional[int] = None, next: Optional[str] = None, prev: Optional[str] = None, + user_id: Optional[str] = None, sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, ) -> StreamResponse[QueryPinnedActivitiesResponse]: response = self.client.query_pinned_activities( feed_group_id=self.feed_group, @@ -256,11 +274,16 @@ def query_pinned_activities( language=language, translate_text=translate_text, enrich_own_fields=enrich_own_fields, + include_expired_activities=include_expired_activities, + include_moderated_activities=include_moderated_activities, + include_soft_deleted_activities=include_soft_deleted_activities, limit=limit, next=next, prev=prev, + user_id=user_id, sort=sort, filter=filter, + user=user, ) self._sync_from_response(response.data) return response diff --git a/getstream/feeds/rest_client.py b/getstream/feeds/rest_client.py index cd5c6b47..f797aca1 100644 --- a/getstream/feeds/rest_client.py +++ b/getstream/feeds/rest_client.py @@ -45,12 +45,13 @@ def add_activity( id: Optional[str] = None, parent_id: Optional[str] = None, poll_id: Optional[str] = None, - restrict_replies: Optional[str] = None, + restrict_replies: Optional[RestrictReplies] = None, skip_enrich_url: Optional[bool] = None, + skip_existing: Optional[bool] = None, skip_push: Optional[bool] = None, text: Optional[str] = None, user_id: Optional[str] = None, - visibility: Optional[str] = None, + visibility: Optional[ActivityVisibility] = None, visibility_tag: Optional[str] = None, attachments: Optional[List[Attachment]] = None, collection_refs: Optional[List[str]] = None, @@ -76,6 +77,7 @@ def add_activity( poll_id=poll_id, restrict_replies=restrict_replies, skip_enrich_url=skip_enrich_url, + skip_existing=skip_existing, skip_push=skip_push, text=text, user_id=user_id, @@ -100,12 +102,14 @@ def upsert_activities( create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, force_moderation: Optional[bool] = None, + skip_existing: Optional[bool] = None, ) -> StreamResponse[UpsertActivitiesResponse]: json = UpsertActivitiesRequest( activities=activities, create_users=create_users, enrich_own_fields=enrich_own_fields, force_moderation=force_moderation, + skip_existing=skip_existing, ).to_dict() return self.post( "/api/v2/feeds/activities/batch", UpsertActivitiesResponse, json=json @@ -169,6 +173,7 @@ def query_activities( translate_text: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, include_expired_activities: Optional[bool] = None, + include_moderated_activities: Optional[bool] = None, include_private_activities: Optional[bool] = None, include_soft_deleted_activities: Optional[bool] = None, limit: Optional[int] = None, @@ -180,11 +185,12 @@ def query_activities( user: Optional[UserRequest] = None, ) -> StreamResponse[QueryActivitiesResponse]: query_params = build_query_param( - language=language, translate_text=translate_text + **{"language": language, "translate_text": translate_text} ) json = QueryActivitiesRequest( enrich_own_fields=enrich_own_fields, include_expired_activities=include_expired_activities, + include_moderated_activities=include_moderated_activities, include_private_activities=include_private_activities, include_soft_deleted_activities=include_soft_deleted_activities, limit=limit, @@ -237,7 +243,7 @@ def delete_bookmark( folder_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[DeleteBookmarkResponse]: - query_params = build_query_param(folder_id=folder_id, user_id=user_id) + query_params = build_query_param(**{"folder_id": folder_id, "user_id": user_id}) path_params = { "activity_id": activity_id, } @@ -336,6 +342,8 @@ def cast_poll_vote( self, activity_id: str, poll_id: str, + config_key: Optional[str] = None, + config_team: Optional[str] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, vote: Optional[VoteData] = None, @@ -344,7 +352,13 @@ def cast_poll_vote( "activity_id": activity_id, "poll_id": poll_id, } - json = CastPollVoteRequest(user_id=user_id, user=user, vote=vote).to_dict() + json = CastPollVoteRequest( + config_key=config_key, + config_team=config_team, + user_id=user_id, + user=user, + vote=vote, + ).to_dict() return self.post( "/api/v2/feeds/activities/{activity_id}/polls/{poll_id}/vote", PollVoteResponse, @@ -360,7 +374,7 @@ def delete_poll_vote( vote_id: str, user_id: Optional[str] = None, ) -> StreamResponse[PollVoteResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "activity_id": activity_id, "poll_id": poll_id, @@ -442,7 +456,10 @@ def delete_activity_reaction( user_id: Optional[str] = None, ) -> StreamResponse[DeleteActivityReactionResponse]: query_params = build_query_param( - delete_notification_activity=delete_notification_activity, user_id=user_id + **{ + "delete_notification_activity": delete_notification_activity, + "user_id": user_id, + } ) path_params = { "activity_id": activity_id, @@ -463,7 +480,7 @@ def query_activity_shares( prev: Optional[str] = None, next: Optional[str] = None, ) -> StreamResponse[QueryActivitySharesResponse]: - query_params = build_query_param(limit=limit, prev=prev, next=next) + query_params = build_query_param(**{"limit": limit, "prev": prev, "next": next}) path_params = { "activity_id": activity_id, } @@ -482,8 +499,10 @@ def delete_activity( delete_notification_activity: Optional[bool] = None, ) -> StreamResponse[DeleteActivityResponse]: query_params = build_query_param( - hard_delete=hard_delete, - delete_notification_activity=delete_notification_activity, + **{ + "hard_delete": hard_delete, + "delete_notification_activity": delete_notification_activity, + } ) path_params = { "id": id, @@ -501,16 +520,26 @@ def get_activity( id: str, comment_sort: Optional[str] = None, comment_limit: Optional[int] = None, + skip_own_followings: Optional[bool] = None, user_id: Optional[str] = None, language: Optional[str] = None, translate_text: Optional[bool] = None, + include_top_level_comment_count: Optional[bool] = None, + include_soft_deleted_activities: Optional[bool] = None, + include_moderated_activities: Optional[bool] = None, ) -> StreamResponse[GetActivityResponse]: query_params = build_query_param( - comment_sort=comment_sort, - comment_limit=comment_limit, - user_id=user_id, - language=language, - translate_text=translate_text, + **{ + "comment_sort": comment_sort, + "comment_limit": comment_limit, + "skip_own_followings": skip_own_followings, + "user_id": user_id, + "language": language, + "translate_text": translate_text, + "include_top_level_comment_count": include_top_level_comment_count, + "include_soft_deleted_activities": include_soft_deleted_activities, + "include_moderated_activities": include_moderated_activities, + } ) path_params = { "id": id, @@ -567,12 +596,12 @@ def update_activity( force_moderation: Optional[bool] = None, handle_mention_notifications: Optional[bool] = None, poll_id: Optional[str] = None, - restrict_replies: Optional[str] = None, + restrict_replies: Optional[RestrictReplies] = None, run_activity_processors: Optional[bool] = None, skip_enrich_url: Optional[bool] = None, text: Optional[str] = None, user_id: Optional[str] = None, - visibility: Optional[str] = None, + visibility: Optional[ActivityVisibility] = None, visibility_tag: Optional[str] = None, attachments: Optional[List[Attachment]] = None, collection_refs: Optional[List[str]] = None, @@ -628,7 +657,7 @@ def restore_activity( user_id: Optional[str] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[RestoreActivityResponse]: - query_params = build_query_param(enrich_own_fields=enrich_own_fields) + query_params = build_query_param(**{"enrich_own_fields": enrich_own_fields}) path_params = { "id": id, } @@ -724,7 +753,7 @@ def query_bookmarks( user: Optional[UserRequest] = None, ) -> StreamResponse[QueryBookmarksResponse]: query_params = build_query_param( - language=language, translate_text=translate_text + **{"language": language, "translate_text": translate_text} ) json = QueryBookmarksRequest( enrich_own_fields=enrich_own_fields, @@ -745,9 +774,11 @@ def query_bookmarks( @telemetry.operation_name("getstream.api.feeds.delete_collections") def delete_collections( - self, collection_refs: List[str] + self, collection_refs: List[str], hard_delete: Optional[bool] = None ) -> StreamResponse[DeleteCollectionsResponse]: - query_params = build_query_param(collection_refs=collection_refs) + query_params = build_query_param( + **{"collection_refs": collection_refs, "hard_delete": hard_delete} + ) return self.delete( "/api/v2/feeds/collections", DeleteCollectionsResponse, @@ -759,7 +790,7 @@ def read_collections( self, user_id: Optional[str] = None, collection_refs: Optional[List[str]] = None ) -> StreamResponse[ReadCollectionsResponse]: query_params = build_query_param( - user_id=user_id, collection_refs=collection_refs + **{"user_id": user_id, "collection_refs": collection_refs} ) return self.get( "/api/v2/feeds/collections", @@ -843,20 +874,24 @@ def get_comments( limit: Optional[int] = None, prev: Optional[str] = None, next: Optional[str] = None, + include_top_level_comment_count: Optional[bool] = None, ) -> StreamResponse[GetCommentsResponse]: query_params = build_query_param( - object_id=object_id, - object_type=object_type, - depth=depth, - sort=sort, - replies_limit=replies_limit, - id_around=id_around, - language=language, - translate_text=translate_text, - user_id=user_id, - limit=limit, - prev=prev, - next=next, + **{ + "object_id": object_id, + "object_type": object_type, + "depth": depth, + "sort": sort, + "replies_limit": replies_limit, + "id_around": id_around, + "language": language, + "translate_text": translate_text, + "user_id": user_id, + "limit": limit, + "prev": prev, + "next": next, + "include_top_level_comment_count": include_top_level_comment_count, + } ) return self.get( "/api/v2/feeds/comments", GetCommentsResponse, query_params=query_params @@ -914,6 +949,7 @@ def query_comments( self, filter: Dict[str, object], id_around: Optional[str] = None, + include_soft_deleted_comments: Optional[bool] = None, limit: Optional[int] = None, next: Optional[str] = None, prev: Optional[str] = None, @@ -924,11 +960,12 @@ def query_comments( translate_text: Optional[bool] = None, ) -> StreamResponse[QueryCommentsResponse]: query_params = build_query_param( - language=language, translate_text=translate_text + **{"language": language, "translate_text": translate_text} ) json = QueryCommentsRequest( filter=filter, id_around=id_around, + include_soft_deleted_comments=include_soft_deleted_comments, limit=limit, next=next, prev=prev, @@ -978,7 +1015,7 @@ def delete_comment_bookmark( folder_id: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[DeleteCommentBookmarkResponse]: - query_params = build_query_param(folder_id=folder_id, user_id=user_id) + query_params = build_query_param(**{"folder_id": folder_id, "user_id": user_id}) path_params = { "comment_id": comment_id, } @@ -1053,8 +1090,10 @@ def delete_comment( delete_notification_activity: Optional[bool] = None, ) -> StreamResponse[DeleteCommentResponse]: query_params = build_query_param( - hard_delete=hard_delete, - delete_notification_activity=delete_notification_activity, + **{ + "hard_delete": hard_delete, + "delete_notification_activity": delete_notification_activity, + } ) path_params = { "id": id, @@ -1075,7 +1114,11 @@ def get_comment( translate_text: Optional[bool] = None, ) -> StreamResponse[GetCommentResponse]: query_params = build_query_param( - user_id=user_id, language=language, translate_text=translate_text + **{ + "user_id": user_id, + "language": language, + "translate_text": translate_text, + } ) path_params = { "id": id, @@ -1126,6 +1169,25 @@ def update_comment( json=json, ) + @telemetry.operation_name("getstream.api.feeds.comment_feedback") + def comment_feedback( + self, + id: str, + hide: Optional[bool] = None, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[CommentFeedbackResponse]: + path_params = { + "id": id, + } + json = CommentFeedbackRequest(hide=hide, user_id=user_id, user=user).to_dict() + return self.post( + "/api/v2/feeds/comments/{id}/feedback", + CommentFeedbackResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.feeds.update_comment_partial") def update_comment_partial( self, @@ -1228,7 +1290,10 @@ def delete_comment_reaction( user_id: Optional[str] = None, ) -> StreamResponse[DeleteCommentReactionResponse]: query_params = build_query_param( - delete_notification_activity=delete_notification_activity, user_id=user_id + **{ + "delete_notification_activity": delete_notification_activity, + "user_id": user_id, + } ) path_params = { "id": id, @@ -1257,16 +1322,18 @@ def get_comment_replies( next: Optional[str] = None, ) -> StreamResponse[GetCommentRepliesResponse]: query_params = build_query_param( - depth=depth, - sort=sort, - replies_limit=replies_limit, - id_around=id_around, - language=language, - translate_text=translate_text, - user_id=user_id, - limit=limit, - prev=prev, - next=next, + **{ + "depth": depth, + "sort": sort, + "replies_limit": replies_limit, + "id_around": id_around, + "language": language, + "translate_text": translate_text, + "user_id": user_id, + "limit": limit, + "prev": prev, + "next": next, + } ) path_params = { "id": id, @@ -1308,11 +1375,62 @@ def translate_comment( json=json, ) + @telemetry.operation_name("getstream.api.feeds.export_feeds_app") + def export_feeds_app( + self, include_deleted: Optional[bool] = None, types: Optional[List[str]] = None + ) -> StreamResponse[ExportFeedsResponse]: + json = ExportFeedsAppRequest( + include_deleted=include_deleted, types=types + ).to_dict() + return self.post("/api/v2/feeds/export/app", ExportFeedsResponse, json=json) + + @telemetry.operation_name("getstream.api.feeds.cancel_export_feeds") + def cancel_export_feeds( + self, task_id: str + ) -> StreamResponse[CancelExportFeedsResponse]: + path_params = { + "task_id": task_id, + } + return self.post( + "/api/v2/feeds/export/{task_id}/cancel", + CancelExportFeedsResponse, + path_params=path_params, + ) + + @telemetry.operation_name("getstream.api.feeds.export_feeds_by_type") + def export_feeds_by_type( + self, + type: str, + created_at_from: Optional[datetime] = None, + created_at_to: Optional[datetime] = None, + include_deleted: Optional[bool] = None, + user_id: Optional[str] = None, + activity_ids: Optional[List[str]] = None, + ) -> StreamResponse[ExportFeedsResponse]: + path_params = { + "type": type, + } + json = ExportFeedsByTypeRequest( + created_at_from=created_at_from, + created_at_to=created_at_to, + include_deleted=include_deleted, + user_id=user_id, + activity_ids=activity_ids, + ).to_dict() + return self.post( + "/api/v2/feeds/export/{type}", + ExportFeedsResponse, + path_params=path_params, + json=json, + ) + @telemetry.operation_name("getstream.api.feeds.list_feed_groups") def list_feed_groups( self, include_soft_deleted: Optional[bool] = None ) -> StreamResponse[ListFeedGroupsResponse]: - query_params = build_query_param(include_soft_deleted=include_soft_deleted) + query_params = build_query_param( + **{"include_soft_deleted": include_soft_deleted} + ) return self.get( "/api/v2/feeds/feed_groups", ListFeedGroupsResponse, @@ -1324,7 +1442,7 @@ def create_feed_group( self, id: str, default_follower_role: Optional[str] = None, - default_visibility: Optional[str] = None, + default_visibility: Optional[FeedVisibility] = None, activity_processors: Optional[List[ActivityProcessorConfig]] = None, activity_selectors: Optional[List[ActivitySelectorConfig]] = None, activity_filter: Optional[ActivityFilterConfig] = None, @@ -1366,7 +1484,10 @@ def delete_feed( purge_user_activities: Optional[bool] = None, ) -> StreamResponse[DeleteFeedResponse]: query_params = build_query_param( - hard_delete=hard_delete, purge_user_activities=purge_user_activities + **{ + "hard_delete": hard_delete, + "purge_user_activities": purge_user_activities, + } ) path_params = { "feed_group_id": feed_group_id, @@ -1394,6 +1515,7 @@ def get_or_create_feed( user_id: Optional[str] = None, view: Optional[str] = None, watch: Optional[bool] = None, + discard_actors: Optional[List[str]] = None, data: Optional[FeedInput] = None, enrichment_options: Optional[EnrichmentOptions] = None, external_ranking: Optional[Dict[str, object]] = None, @@ -1404,9 +1526,10 @@ def get_or_create_feed( interest_weights: Optional[Dict[str, float]] = None, member_pagination: Optional[PagerRequest] = None, user: Optional[UserRequest] = None, + viewer_location: Optional[Location] = None, ) -> StreamResponse[GetOrCreateFeedResponse]: query_params = build_query_param( - language=language, translate_text=translate_text + **{"language": language, "translate_text": translate_text} ) path_params = { "feed_group_id": feed_group_id, @@ -1421,6 +1544,7 @@ def get_or_create_feed( user_id=user_id, view=view, watch=watch, + discard_actors=discard_actors, data=data, enrichment_options=enrichment_options, external_ranking=external_ranking, @@ -1431,6 +1555,7 @@ def get_or_create_feed( interest_weights=interest_weights, member_pagination=member_pagination, user=user, + viewer_location=viewer_location, ).to_dict() return self.post( "/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}", @@ -1518,7 +1643,7 @@ def unpin_activity( user_id: Optional[str] = None, ) -> StreamResponse[UnpinActivityResponse]: query_params = build_query_param( - enrich_own_fields=enrich_own_fields, user_id=user_id + **{"enrich_own_fields": enrich_own_fields, "user_id": user_id} ) path_params = { "feed_group_id": feed_group_id, @@ -1562,7 +1687,7 @@ def change_feed_visibility( self, feed_group_id: str, feed_id: str, - visibility: str, + visibility: FeedVisibility, pending_follows_action: Optional[str] = None, ) -> StreamResponse[ChangeFeedVisibilityResponse]: path_params = { @@ -1683,6 +1808,26 @@ def reject_feed_member_invite( json=json, ) + @telemetry.operation_name("getstream.api.feeds.get_notification_status") + def get_notification_status( + self, + feed_group_id: str, + feed_id: str, + view: Optional[str] = None, + user_id: Optional[str] = None, + ) -> StreamResponse[GetNotificationStatusResponse]: + query_params = build_query_param(**{"view": view, "user_id": user_id}) + path_params = { + "feed_group_id": feed_group_id, + "feed_id": feed_id, + } + return self.get( + "/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/notification_status", + GetNotificationStatusResponse, + query_params=query_params, + path_params=path_params, + ) + @telemetry.operation_name("getstream.api.feeds.query_pinned_activities") def query_pinned_activities( self, @@ -1691,14 +1836,19 @@ def query_pinned_activities( language: Optional[str] = None, translate_text: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, + include_expired_activities: Optional[bool] = None, + include_moderated_activities: Optional[bool] = None, + include_soft_deleted_activities: Optional[bool] = None, limit: Optional[int] = None, next: Optional[str] = None, prev: Optional[str] = None, + user_id: Optional[str] = None, sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, ) -> StreamResponse[QueryPinnedActivitiesResponse]: query_params = build_query_param( - language=language, translate_text=translate_text + **{"language": language, "translate_text": translate_text} ) path_params = { "feed_group_id": feed_group_id, @@ -1706,11 +1856,16 @@ def query_pinned_activities( } json = QueryPinnedActivitiesRequest( enrich_own_fields=enrich_own_fields, + include_expired_activities=include_expired_activities, + include_moderated_activities=include_moderated_activities, + include_soft_deleted_activities=include_soft_deleted_activities, limit=limit, next=next, prev=prev, + user_id=user_id, sort=sort, filter=filter, + user=user, ).to_dict() return self.post( "/api/v2/feeds/feed_groups/{feed_group_id}/feeds/{feed_id}/pinned_activities/query", @@ -1727,7 +1882,7 @@ def get_follow_suggestions( limit: Optional[int] = None, user_id: Optional[str] = None, ) -> StreamResponse[GetFollowSuggestionsResponse]: - query_params = build_query_param(limit=limit, user_id=user_id) + query_params = build_query_param(**{"limit": limit, "user_id": user_id}) path_params = { "feed_group_id": feed_group_id, } @@ -1755,7 +1910,7 @@ def restore_feed_group( def delete_feed_group( self, id: str, hard_delete: Optional[bool] = None ) -> StreamResponse[DeleteFeedGroupResponse]: - query_params = build_query_param(hard_delete=hard_delete) + query_params = build_query_param(**{"hard_delete": hard_delete}) path_params = { "id": id, } @@ -1770,7 +1925,9 @@ def delete_feed_group( def get_feed_group( self, id: str, include_soft_deleted: Optional[bool] = None ) -> StreamResponse[GetFeedGroupResponse]: - query_params = build_query_param(include_soft_deleted=include_soft_deleted) + query_params = build_query_param( + **{"include_soft_deleted": include_soft_deleted} + ) path_params = { "id": id, } @@ -1786,7 +1943,7 @@ def get_or_create_feed_group( self, id: str, default_follower_role: Optional[str] = None, - default_visibility: Optional[str] = None, + default_visibility: Optional[FeedVisibility] = None, activity_processors: Optional[List[ActivityProcessorConfig]] = None, activity_selectors: Optional[List[ActivitySelectorConfig]] = None, activity_filter: Optional[ActivityFilterConfig] = None, @@ -1829,7 +1986,7 @@ def update_feed_group( self, id: str, default_follower_role: Optional[str] = None, - default_visibility: Optional[str] = None, + default_visibility: Optional[FeedVisibility] = None, activity_processors: Optional[List[ActivityProcessorConfig]] = None, activity_selectors: Optional[List[ActivitySelectorConfig]] = None, activity_filter: Optional[ActivityFilterConfig] = None, @@ -1961,7 +2118,7 @@ def list_feed_visibilities(self) -> StreamResponse[ListFeedVisibilitiesResponse] @telemetry.operation_name("getstream.api.feeds.get_feed_visibility") def get_feed_visibility( - self, name: str + self, name: FeedVisibility ) -> StreamResponse[GetFeedVisibilityResponse]: path_params = { "name": name, @@ -1974,7 +2131,7 @@ def get_feed_visibility( @telemetry.operation_name("getstream.api.feeds.update_feed_visibility") def update_feed_visibility( - self, name: str, grants: Optional[Dict[str, List[str]]] = None + self, name: FeedVisibility, grants: Optional[Dict[str, List[str]]] = None ) -> StreamResponse[UpdateFeedVisibilityResponse]: path_params = { "name": name, @@ -2065,14 +2222,16 @@ def get_feeds_rate_limits( server_side: Optional[bool] = None, ) -> StreamResponse[GetFeedsRateLimitsResponse]: query_params = build_query_param( - endpoints=endpoints, - android=android, - ios=ios, - web=web, - unity=unity, - unity_desktop=unity_desktop, - unity_console=unity_console, - server_side=server_side, + **{ + "endpoints": endpoints, + "android": android, + "ios": ios, + "web": web, + "unity": unity, + "unity_desktop": unity_desktop, + "unity_console": unity_console, + "server_side": server_side, + } ) return self.get( "/api/v2/feeds/feeds/rate_limits", @@ -2091,9 +2250,9 @@ def update_follow( create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, follower_role: Optional[str] = None, - push_preference: Optional[str] = None, + push_preference: Optional[FollowPushPreference] = None, skip_push: Optional[bool] = None, - status: Optional[str] = None, + status: Optional[FollowStatus] = None, custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpdateFollowResponse]: json = UpdateFollowRequest( @@ -2122,9 +2281,9 @@ def follow( create_notification_activity: Optional[bool] = None, create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, - push_preference: Optional[str] = None, + push_preference: Optional[FollowPushPreference] = None, skip_push: Optional[bool] = None, - status: Optional[str] = None, + status: Optional[FollowStatus] = None, custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[SingleFollowResponse]: json = FollowRequest( @@ -2153,15 +2312,18 @@ def accept_follow( "/api/v2/feeds/follows/accept", AcceptFollowResponse, json=json ) + # Deprecated: this endpoint is deprecated. @telemetry.operation_name("getstream.api.feeds.follow_batch") def follow_batch( self, follows: List[FollowRequest], + _async: Optional[bool] = None, create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, ) -> StreamResponse[FollowBatchResponse]: json = FollowBatchRequest( follows=follows, + _async=_async, create_users=create_users, enrich_own_fields=enrich_own_fields, ).to_dict() @@ -2171,11 +2333,13 @@ def follow_batch( def get_or_create_follows( self, follows: List[FollowRequest], + _async: Optional[bool] = None, create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, ) -> StreamResponse[FollowBatchResponse]: json = FollowBatchRequest( follows=follows, + _async=_async, create_users=create_users, enrich_own_fields=enrich_own_fields, ).to_dict() @@ -2186,6 +2350,7 @@ def get_or_create_follows( @telemetry.operation_name("getstream.api.feeds.query_follows") def query_follows( self, + include_group_counts: Optional[bool] = None, limit: Optional[int] = None, next: Optional[str] = None, prev: Optional[str] = None, @@ -2193,7 +2358,12 @@ def query_follows( filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryFollowsResponse]: json = QueryFollowsRequest( - limit=limit, next=next, prev=prev, sort=sort, filter=filter + include_group_counts=include_group_counts, + limit=limit, + next=next, + prev=prev, + sort=sort, + filter=filter, ).to_dict() return self.post("/api/v2/feeds/follows/query", QueryFollowsResponse, json=json) @@ -2216,9 +2386,9 @@ def get_or_create_follow( create_notification_activity: Optional[bool] = None, create_users: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, - push_preference: Optional[str] = None, + push_preference: Optional[FollowPushPreference] = None, skip_push: Optional[bool] = None, - status: Optional[str] = None, + status: Optional[FollowStatus] = None, custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[GetOrCreateFollowResponse]: json = FollowRequest( @@ -2248,9 +2418,11 @@ def unfollow( enrich_own_fields: Optional[bool] = None, ) -> StreamResponse[UnfollowResponse]: query_params = build_query_param( - delete_notification_activity=delete_notification_activity, - keep_history=keep_history, - enrich_own_fields=enrich_own_fields, + **{ + "delete_notification_activity": delete_notification_activity, + "keep_history": keep_history, + "enrich_own_fields": enrich_own_fields, + } ) path_params = { "source": source, @@ -2339,6 +2511,65 @@ def update_membership_level( json=json, ) + @telemetry.operation_name("getstream.api.feeds.feeds_get_retention_policy") + def feeds_get_retention_policy( + self, + ) -> StreamResponse[GetFeedsRetentionPolicyResponse]: + return self.get( + "/api/v2/feeds/retention_policy", GetFeedsRetentionPolicyResponse + ) + + @telemetry.operation_name("getstream.api.feeds.feeds_set_retention_policy") + def feeds_set_retention_policy( + self, + max_age_hours: int, + policy: str, + enabled: Optional[bool] = None, + feed_groups: Optional[List[str]] = None, + ) -> StreamResponse[SetFeedsRetentionPolicyResponse]: + json = SetFeedsRetentionPolicyRequest( + max_age_hours=max_age_hours, + policy=policy, + enabled=enabled, + feed_groups=feed_groups, + ).to_dict() + return self.post( + "/api/v2/feeds/retention_policy", SetFeedsRetentionPolicyResponse, json=json + ) + + @telemetry.operation_name("getstream.api.feeds.feeds_delete_retention_policy") + def feeds_delete_retention_policy( + self, policy: str + ) -> StreamResponse[DeleteFeedsRetentionPolicyResponse]: + json = DeleteFeedsRetentionPolicyRequest(policy=policy).to_dict() + return self.post( + "/api/v2/feeds/retention_policy/delete", + DeleteFeedsRetentionPolicyResponse, + json=json, + ) + + @telemetry.operation_name("getstream.api.feeds.feeds_get_retention_policy_runs") + def feeds_get_retention_policy_runs( + self, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter_conditions: Optional[Dict[str, object]] = None, + ) -> StreamResponse[GetFeedsRetentionPolicyRunsResponse]: + json = GetFeedsRetentionPolicyRunsRequest( + limit=limit, + next=next, + prev=prev, + sort=sort, + filter_conditions=filter_conditions, + ).to_dict() + return self.post( + "/api/v2/feeds/retention_policy/runs", + GetFeedsRetentionPolicyRunsResponse, + json=json, + ) + @telemetry.operation_name("getstream.api.feeds.query_revision_history") def query_revision_history( self, @@ -2364,15 +2595,18 @@ def query_feeds_usage_stats( "/api/v2/feeds/stats/usage", QueryFeedsUsageStatsResponse, json=json ) + # Deprecated: this endpoint is deprecated. @telemetry.operation_name("getstream.api.feeds.unfollow_batch") def unfollow_batch( self, follows: List[UnfollowPair], + _async: Optional[bool] = None, delete_notification_activity: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, ) -> StreamResponse[UnfollowBatchResponse]: json = UnfollowBatchRequest( follows=follows, + _async=_async, delete_notification_activity=delete_notification_activity, enrich_own_fields=enrich_own_fields, ).to_dict() @@ -2384,11 +2618,13 @@ def unfollow_batch( def get_or_create_unfollows( self, follows: List[UnfollowPair], + _async: Optional[bool] = None, delete_notification_activity: Optional[bool] = None, enrich_own_fields: Optional[bool] = None, ) -> StreamResponse[UnfollowBatchResponse]: json = UnfollowBatchRequest( follows=follows, + _async=_async, delete_notification_activity=delete_notification_activity, enrich_own_fields=enrich_own_fields, ).to_dict() @@ -2444,11 +2680,26 @@ def export_feed_user_data( path_params=path_params, ) + @telemetry.operation_name("getstream.api.feeds.delete_user_interests") + def delete_user_interests( + self, user_id: str, tags: List[str] + ) -> StreamResponse[DeleteUserInterestsResponse]: + query_params = build_query_param(**{"tags": tags}) + path_params = { + "user_id": user_id, + } + return self.delete( + "/api/v2/feeds/users/{user_id}/interests", + DeleteUserInterestsResponse, + query_params=query_params, + path_params=path_params, + ) + @telemetry.operation_name("getstream.api.feeds.get_user_interests") def get_user_interests( self, user_id: str, limit: Optional[int] = None ) -> StreamResponse[GetUserInterestsResponse]: - query_params = build_query_param(limit=limit) + query_params = build_query_param(**{"limit": limit}) path_params = { "user_id": user_id, } @@ -2458,3 +2709,18 @@ def get_user_interests( query_params=query_params, path_params=path_params, ) + + @telemetry.operation_name("getstream.api.feeds.upsert_user_interests") + def upsert_user_interests( + self, user_id: str, interests: List[UserInterestRequest] + ) -> StreamResponse[UpsertUserInterestsResponse]: + path_params = { + "user_id": user_id, + } + json = UpsertUserInterestsRequest(interests=interests).to_dict() + return self.put( + "/api/v2/feeds/users/{user_id}/interests", + UpsertUserInterestsResponse, + path_params=path_params, + json=json, + ) diff --git a/getstream/models/__init__.py b/getstream/models/__init__.py index 12d28cd4..232ef882 100644 --- a/getstream/models/__init__.py +++ b/getstream/models/__init__.py @@ -1,43 +1,63 @@ # Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT. from dataclasses import dataclass from dataclasses import field as dc_field -from datetime import datetime -from typing import Dict, Final, List, NewType, Optional - from dataclasses_json import DataClassJsonMixin from dataclasses_json import config as dc_config +from datetime import datetime from marshmallow import fields - -from getstream.utils import datetime_from_unix_ns, encode_datetime +from typing import List, Dict, Optional, Final, NewType +from getstream.utils import encode_datetime, datetime_from_unix_ns @dataclass class AIAudioConfigRequest(DataClassJsonMixin): - profile: str | None = dc_field( + # 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") ) - rules: "list[BodyguardRule] | None" = dc_field( + # 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")) - rules: "list[BodyguardRule]" = dc_field(metadata=dc_config(field_name="rules")) + # 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: "list[OCRRule] | None" = dc_field( + ocr_rules: "Optional[List[OCRRule]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_rules") ) - rules: "list[AWSRekognitionRule] | None" = dc_field( + 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") ) @@ -52,42 +72,45 @@ class AIImageLabelDefinition(DataClassJsonMixin): @dataclass class AITextConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: str | None = dc_field( + profile: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="profile") ) - rules: "list[BodyguardRule] | None" = dc_field( + rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) - severity_rules: "list[BodyguardSeverityRule] | None" = dc_field( + severity_rules: "Optional[List[BodyguardSeverityRule]]" = dc_field( default=None, metadata=dc_config(field_name="severity_rules") ) @dataclass class AIVideoConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( - default=None, metadata=dc_config(field_name="enabled") + _async: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="async") ) - provider: str | None = dc_field( - default=None, metadata=dc_config(field_name="provider") + enabled: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="enabled") ) - rules: "list[AWSRekognitionRule] | None" = dc_field( + rules: "Optional[List[AWSRekognitionRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AIVideoConfigRequest(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: "list[AWSRekognitionRule] | None" = dc_field( + rules: "Optional[List[AWSRekognitionRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @@ -95,8 +118,10 @@ class AIVideoConfigRequest(DataClassJsonMixin): @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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) + 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 @@ -112,43 +137,49 @@ class APIError(DataClassJsonMixin): # 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")) + 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: bool | None = dc_field( + unrecoverable: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="unrecoverable") ) # Additional error info - exception_fields: "dict[str, str] | None" = dc_field( + exception_fields: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="exception_fields") ) @dataclass class APNConfig(DataClassJsonMixin): - auth_key: str | None = dc_field( + auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_key") ) - auth_type: str | None = dc_field( + auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_type") ) - bundle_id: str | None = dc_field( + bundle_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bundle_id") ) - development: bool | None = dc_field( + development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="development") ) - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) - host: str | None = dc_field(default=None, metadata=dc_config(field_name="host")) - key_id: str | None = dc_field(default=None, metadata=dc_config(field_name="key_id")) - notification_template: str | None = dc_field( + 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: str | None = dc_field( + p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="p12_cert") ) - team_id: str | None = dc_field( + team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @@ -157,24 +188,26 @@ class APNConfig(DataClassJsonMixin): 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: str | None = dc_field( + auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_key") ) - auth_type: str | None = dc_field( + auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auth_type") ) - bundle_id: str | None = dc_field( + bundle_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="bundle_id") ) - host: str | None = dc_field(default=None, metadata=dc_config(field_name="host")) - key_id: str | None = dc_field(default=None, metadata=dc_config(field_name="key_id")) - notification_template: str | None = dc_field( + 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: str | None = dc_field( + p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="p12_cert") ) - team_id: str | None = dc_field( + team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @@ -183,40 +216,47 @@ class APNConfigFields(DataClassJsonMixin): 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: int | None = dc_field( + content_available: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="content-available") ) - mutable_content: int | None = dc_field( + mutable_content: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mutable-content") ) - sound: str | None = dc_field(default=None, metadata=dc_config(field_name="sound")) - data: dict[str, object] | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="body")) - content_available: int | None = dc_field( + 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: int | None = dc_field( + mutable_content: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="mutable-content") ) - sound: str | None = dc_field(default=None, metadata=dc_config(field_name="sound")) - title: str | None = dc_field(default=None, metadata=dc_config(field_name="title")) - data: dict[str, object] | None = dc_field( + 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): - action: str = dc_field(metadata=dc_config(field_name="action")) + # 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: dict[str, object] | None = dc_field( + subclassifications: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="subclassifications") ) @@ -229,11 +269,11 @@ class AbsentMetric(DataClassJsonMixin): @dataclass class AcceptFeedMemberInviteRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -251,7 +291,7 @@ class AcceptFollowRequest(DataClassJsonMixin): # 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: str | None = dc_field( + follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follower_role") ) @@ -267,8 +307,12 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="style")) - value: str | None = dc_field(default=None, metadata=dc_config(field_name="value")) + 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 @@ -294,39 +338,41 @@ class ActionLogResponse(DataClassJsonMixin): 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")) + 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: "ReviewQueueItemResponse | None" = dc_field( + 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: "UserResponse | None" = dc_field( + target_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ActionSequence(DataClassJsonMixin): - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - blur: bool | None = dc_field(default=None, metadata=dc_config(field_name="blur")) - cooldown_period: int | None = dc_field( + 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: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: int | None = dc_field( + time_window: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - warning: bool | None = dc_field( + warning: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="warning") ) - warning_text: str | None = dc_field( + warning_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="warning_text") ) @@ -353,13 +399,13 @@ class ActiveCallsLatencyStats(DataClassJsonMixin): @dataclass class ActiveCallsMetrics(DataClassJsonMixin): - join_call_api: "JoinCallAPIMetrics | None" = dc_field( + join_call_api: "Optional[JoinCallAPIMetrics]" = dc_field( default=None, metadata=dc_config(field_name="join_call_api") ) - publishers: "PublishersMetrics | None" = dc_field( + publishers: "Optional[PublishersMetrics]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) - subscribers: "SubscribersMetrics | None" = dc_field( + subscribers: "Optional[SubscribersMetrics]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @@ -395,15 +441,16 @@ class ActivityAddedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -412,7 +459,7 @@ class ActivityAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -430,15 +477,16 @@ class ActivityDeletedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -447,7 +495,7 @@ class ActivityDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -466,12 +514,12 @@ class ActivityFeedbackEvent(DataClassJsonMixin): activity_feedback: "ActivityFeedbackEventPayload" = dc_field( metadata=dc_config(field_name="activity_feedback") ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -480,7 +528,7 @@ class ActivityFeedbackEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -518,20 +566,20 @@ class ActivityFeedbackEventPayload(DataClassJsonMixin): @dataclass class ActivityFeedbackRequest(DataClassJsonMixin): # Whether to hide this activity - hide: bool | None = dc_field(default=None, metadata=dc_config(field_name="hide")) + hide: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="hide")) # Whether to show less content like this - show_less: bool | None = dc_field( + show_less: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_less") ) # Whether to show more content like this - show_more: bool | None = dc_field( + show_more: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_more") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -546,7 +594,7 @@ class ActivityFeedbackResponse(DataClassJsonMixin): @dataclass class ActivityFilterConfig(DataClassJsonMixin): # When true, activities authored by the feed owner are excluded from feed reads - exclude_owner_activities: bool | None = dc_field( + exclude_owner_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_owner_activities") ) @@ -563,23 +611,24 @@ class ActivityMarkEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # 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: bool | None = dc_field( + 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: bool | None = dc_field( + mark_all_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_seen") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -589,18 +638,18 @@ class ActivityMarkEvent(DataClassJsonMixin): ), ) # The IDs of activities marked as read - mark_read: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + mark_watched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_watched") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -608,11 +657,11 @@ class ActivityMarkEvent(DataClassJsonMixin): @dataclass class ActivityMarksConfig(DataClassJsonMixin): # Whether to return per-activity read status on content feeds - track_read: bool | None = dc_field( + 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: bool | None = dc_field( + track_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_seen") ) @@ -657,7 +706,7 @@ class ActivityPinnedEvent(DataClassJsonMixin): ) # 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) pinned_activity: "PinActivityResponse" = dc_field( metadata=dc_config(field_name="pinned_activity") ) @@ -665,10 +714,11 @@ class ActivityPinnedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.activity.pinned", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -677,7 +727,7 @@ class ActivityPinnedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -685,15 +735,15 @@ class ActivityPinnedEvent(DataClassJsonMixin): @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: bool | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + blocked_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_tags") ) @@ -703,11 +753,11 @@ 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: int | None = dc_field( + 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: int | None = dc_field( + min_word_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_word_count") ) @@ -725,7 +775,7 @@ class ActivityReactionAddedEvent(DataClassJsonMixin): ) 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -733,10 +783,11 @@ class ActivityReactionAddedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.activity.reaction.added", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -745,7 +796,7 @@ class ActivityReactionAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -763,7 +814,7 @@ class ActivityReactionDeletedEvent(DataClassJsonMixin): ) 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -771,10 +822,11 @@ class ActivityReactionDeletedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.activity.reaction.deleted", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -783,7 +835,7 @@ class ActivityReactionDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -801,7 +853,7 @@ class ActivityReactionUpdatedEvent(DataClassJsonMixin): ) 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -809,10 +861,11 @@ class ActivityReactionUpdatedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.activity.reaction.updated", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -821,7 +874,7 @@ class ActivityReactionUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -839,16 +892,17 @@ class ActivityRemovedFromFeedEvent(DataClassJsonMixin): ) 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")) + 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"), ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -857,7 +911,7 @@ class ActivityRemovedFromFeedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -867,89 +921,89 @@ 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")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) # Expiration time for the activity - expires_at: str | None = dc_field( + expires_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expires_at") ) # Optional ID for the activity - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of parent activity for replies/comments - parent_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # Whether to skip push notifications - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Text content of the activity - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # ID of the user creating the activity - user_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references - collection_refs: list[str] | None = dc_field( + 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: "list[CollectionRequest] | None" = dc_field( + collections: "Optional[List[CollectionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="collections") ) # Tags for filtering activities - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags for indicating user interests - interest_tags: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing - search_data: dict[str, object] | None = dc_field( + search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) @@ -980,7 +1034,9 @@ class ActivityResponse(DataClassJsonMixin): # 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: str = dc_field(metadata=dc_config(field_name="restrict_replies")) + 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 @@ -997,55 +1053,57 @@ class ActivityResponse(DataClassJsonMixin): ) ) # Visibility setting for the activity. One of: public, private, tag - visibility: str = dc_field(metadata=dc_config(field_name="visibility")) + visibility: "ActivityVisibility" = dc_field( + metadata=dc_config(field_name="visibility") + ) # Media attachments for the activity - attachments: "list[Attachment]" = dc_field( + 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( + 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")) + 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")) + 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")) + interest_tags: List[str] = dc_field(metadata=dc_config(field_name="interest_tags")) # Recent reactions to the activity - latest_reactions: "list[FeedsReactionResponse]" = dc_field( + latest_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # Users mentioned in the activity - mentioned_users: "list[UserResponse]" = dc_field( + 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( + 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( + 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( + 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Grouped reactions by type - reaction_groups: "dict[str, FeedsReactionGroupResponse]" = dc_field( + 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( + 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: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -1055,7 +1113,7 @@ class ActivityResponse(DataClassJsonMixin): ), ) # When the activity was last edited - edited_at: datetime | None = dc_field( + edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", @@ -1065,7 +1123,7 @@ class ActivityResponse(DataClassJsonMixin): ), ) # When the activity will expire - expires_at: datetime | None = dc_field( + expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", @@ -1075,67 +1133,79 @@ class ActivityResponse(DataClassJsonMixin): ), ) # Total count of reactions from friends on this activity - friend_reaction_count: int | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) - is_watched: bool | None = dc_field( + is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) - moderation_action: str | None = dc_field( + moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) - # Which activity selector provided this activity (e.g., 'following', 'popular', 'interest'). Only set when using multiple activity selectors with ranking. - selector_source: str | None = dc_field( + # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + 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: str | None = dc_field( + 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: "list[FeedsReactionResponse] | None" = dc_field( + 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: "list[ShareResponse] | None" = dc_field( + latest_shares: "Optional[List[ShareResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_shares") ) - current_feed: "FeedResponse | None" = dc_field( + # 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: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) - metrics: "dict[str, int] | None" = dc_field( + metrics: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) - notification_context: "NotificationContext | None" = dc_field( + notification_context: "Optional[NotificationContext]" = dc_field( default=None, metadata=dc_config(field_name="notification_context") ) - parent: "ActivityResponse | None" = dc_field( + parent: "Optional[ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent") ) - poll: "PollResponseData | None" = dc_field( + 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: dict[str, object] | None = dc_field( + score_vars: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="score_vars") ) @@ -1153,15 +1223,16 @@ class ActivityRestoredEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -1170,7 +1241,7 @@ class ActivityRestoredEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1178,31 +1249,43 @@ class ActivityRestoredEvent(DataClassJsonMixin): @dataclass class ActivitySelectorConfig(DataClassJsonMixin): # Type of selector. One of: popular, proximity, following, current_feed, query, interest, follow_suggestion - type: str = dc_field(metadata=dc_config(field_name="type")) + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) - feed_groups: "FeedGroupScope | None" = dc_field( + feed_groups: "Optional[FeedGroupScope]" = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) # Filter for activity selection - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) - params: dict[str, object] | None = dc_field( + params: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="params") ) @@ -1210,9 +1293,9 @@ class ActivitySelectorConfig(DataClassJsonMixin): @dataclass class ActivitySelectorConfigResponse(DataClassJsonMixin): # Type of selector - type: str = dc_field(metadata=dc_config(field_name="type")) + type: "ActivitySelectorType" = dc_field(metadata=dc_config(field_name="type")) # Time threshold for activity selection (timestamp) - cutoff_time: datetime | None = dc_field( + cutoff_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="cutoff_time", @@ -1222,30 +1305,55 @@ class ActivitySelectorConfigResponse(DataClassJsonMixin): ), ) # Flexible relative time window for activity selection (e.g., '1h', '3d', '1y') - cutoff_window: str | None = dc_field( + 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: int | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) - feed_groups: "FeedGroupScope | None" = dc_field( + feed_groups: "Optional[FeedGroupScope]" = dc_field( default=None, metadata=dc_config(field_name="feed_groups") ) # Filter for activity selection - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # Generic params for selector-specific configuration - params: dict[str, object] | None = dc_field( + 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 @@ -1259,7 +1367,7 @@ class ActivityUnpinnedEvent(DataClassJsonMixin): ) # 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) pinned_activity: "PinActivityResponse" = dc_field( metadata=dc_config(field_name="pinned_activity") ) @@ -1267,10 +1375,11 @@ class ActivityUnpinnedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.activity.unpinned", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -1279,7 +1388,7 @@ class ActivityUnpinnedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1297,15 +1406,16 @@ class ActivityUpdatedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -1314,108 +1424,120 @@ class ActivityUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + 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")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + create_notification_activity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_notification_activity") ) - create_users: bool | None = dc_field( + create_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_users") ) - enrich_own_fields: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Expiration time for the activity - expires_at: str | None = dc_field( + expires_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expires_at") ) - force_moderation: bool | None = dc_field( + force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) # Optional ID for the activity - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of parent activity for replies/comments - parent_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Text content of the activity - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # ID of the user creating the activity - user_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references - collection_refs: list[str] | None = dc_field( + 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: "list[CollectionRequest] | None" = dc_field( + collections: "Optional[List[CollectionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="collections") ) # Tags for filtering activities - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags for indicating user interests - interest_tags: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing - search_data: dict[str, object] | None = dc_field( + search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) @@ -1425,29 +1547,33 @@ 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: int | None = dc_field( + 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: str | None = dc_field( + folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - new_folder: "AddFolderRequest | None" = dc_field( + new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1461,21 +1587,21 @@ class AddBookmarkResponse(DataClassJsonMixin): @dataclass class AddCommentBookmarkRequest(DataClassJsonMixin): # ID of the folder to add the bookmark to - folder_id: str | None = dc_field( + folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="folder_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - new_folder: "AddFolderRequest | None" = dc_field( + new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1492,59 +1618,67 @@ class AddCommentReactionRequest(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + notification_task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_task_id") ) - reference_activity: "ActivityResponse | None" = dc_field( + # 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") ) @@ -1552,60 +1686,60 @@ class AddCommentReactionResponse(DataClassJsonMixin): @dataclass class AddCommentRequest(DataClassJsonMixin): # Text content of the comment - comment: str | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Media attachments for the reply - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of users mentioned in the reply - mentioned_user_ids: list[str] | None = dc_field( + mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the comment - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1615,11 +1749,11 @@ 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: int | None = dc_field( + 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: bool | None = dc_field( + notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @@ -1627,7 +1761,7 @@ class AddCommentResponse(DataClassJsonMixin): @dataclass class AddCommentsBatchRequest(DataClassJsonMixin): # List of comments to add - comments: "list[AddCommentRequest]" = dc_field( + comments: "List[AddCommentRequest]" = dc_field( metadata=dc_config(field_name="comments") ) @@ -1636,7 +1770,7 @@ class AddCommentsBatchRequest(DataClassJsonMixin): class AddCommentsBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of comments added - comments: "list[CommentResponse]" = dc_field( + comments: "List[CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) @@ -1646,7 +1780,7 @@ class AddFolderRequest(DataClassJsonMixin): # Name of the folder name: str = dc_field(metadata=dc_config(field_name="name")) # Custom data for the folder - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -1657,62 +1791,70 @@ class AddReactionRequest(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + target_feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds") ) # Custom data for the reaction - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + notification_task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_task_id") ) - reference_activity: "ActivityResponse | None" = dc_field( + # 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") ) @@ -1720,18 +1862,18 @@ class AddReactionResponse(DataClassJsonMixin): @dataclass class AddSegmentTargetsRequest(DataClassJsonMixin): # Target IDs - target_ids: list[str] = dc_field(metadata=dc_config(field_name="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")) + 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: bool | None = dc_field( + as_admin: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="as_admin") ) - team_id: str | None = dc_field( + team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) @@ -1739,7 +1881,7 @@ class AddUserGroupMembersRequest(DataClassJsonMixin): @dataclass class AddUserGroupMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - user_group: "UserGroupResponse | None" = dc_field( + user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -1777,18 +1919,18 @@ class AggregatedActivityResponse(DataClassJsonMixin): metadata=dc_config(field_name="user_count_truncated") ) # List of activities in this aggregation - activities: "list[ActivityResponse]" = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) - is_watched: bool | None = dc_field( + is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) @@ -1796,13 +1938,19 @@ class AggregatedActivityResponse(DataClassJsonMixin): @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: str | None = dc_field( + activities_sort: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activities_sort") ) # Format for activity aggregation - format: str | None = dc_field(default=None, metadata=dc_config(field_name="format")) + 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: str | None = dc_field( + score_strategy: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="score_strategy") ) @@ -1810,21 +1958,29 @@ class AggregationConfig(DataClassJsonMixin): @dataclass class AnalyzeImageField(DataClassJsonMixin): # Per-image action: keep | flag | remove. - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) + 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: float | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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: "list[Classification] | None" = dc_field( + 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: "list[Classification] | None" = dc_field( + ocr_classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_classifications") ) @@ -1832,15 +1988,15 @@ class AnalyzeImageField(DataClassJsonMixin): @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: bool | None = dc_field( + 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: str | None = dc_field( + 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: datetime | None = dc_field( + content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", @@ -1849,35 +2005,44 @@ class AnalyzeRequest(DataClassJsonMixin): 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) - user_id: str | None = dc_field( + 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: "dict[str, str] | None" = dc_field( + content_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="content_ids") ) # Arbitrary metadata surfaced in the dashboard. - custom: dict[str, object] | None = dc_field( + 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: "dict[str, str] | None" = dc_field( + texts: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -1887,12 +2052,20 @@ 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: "dict[str, AnalyzeImageField] | None" = dc_field( + 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: "dict[str, AnalyzeTextField] | None" = dc_field( + texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @@ -1900,23 +2073,75 @@ class AnalyzeResponse(DataClassJsonMixin): @dataclass class AnalyzeTextField(DataClassJsonMixin): # Per-field action: keep | flag | remove. - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Detected language code. - language: str | None = dc_field( + language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) # Aggregate severity across the field: LOW | MEDIUM | HIGH | CRITICAL. - severity: str | None = dc_field( + 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: "list[Classification] | None" = dc_field( + 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 @@ -1924,12 +2149,17 @@ 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") @@ -1992,6 +2222,7 @@ class AppResponseFields(DataClassJsonMixin): 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( @@ -2011,57 +2242,62 @@ class AppResponseFields(DataClassJsonMixin): 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( + event_hooks: "List[EventHook]" = dc_field( metadata=dc_config(field_name="event_hooks") ) - user_search_disallowed_roles: list[str] = dc_field( + user_search_disallowed_roles: List[str] = dc_field( metadata=dc_config(field_name="user_search_disallowed_roles") ) - webhook_events: list[str] = dc_field( + webhook_events: List[str] = dc_field( metadata=dc_config(field_name="webhook_events") ) - call_types: "dict[str, CallType | None]" = dc_field( + call_types: "Dict[str, Optional[CallType]]" = dc_field( metadata=dc_config(field_name="call_types") ) - channel_configs: "dict[str, ChannelConfig | None]" = dc_field( + 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")) + 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( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + chat_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_primary_use_case") ) - moderation_onboarding_complete: bool | None = dc_field( + moderation_onboarding_complete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_onboarding_complete") ) - moderation_s3_image_access_role_arn: str | None = dc_field( + 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: datetime | None = dc_field( + revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", @@ -2070,25 +2306,25 @@ class AppResponseFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - video_primary_use_case: str | None = dc_field( + video_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="video_primary_use_case") ) - allowed_flag_reasons: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - geofences: "list[GeofenceResponse] | None" = dc_field( + geofences: "Optional[List[GeofenceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="geofences") ) - image_moderation_labels: list[str] | None = dc_field( + image_moderation_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_labels") ) - activity_metrics_config: "dict[str, int] | None" = dc_field( + activity_metrics_config: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="activity_metrics_config") ) - datadog_info: "DataDogInfo | None" = dc_field( + datadog_info: "Optional[DataDogInfo]" = dc_field( default=None, metadata=dc_config(field_name="datadog_info") ) - moderation_dashboard_preferences: "ModerationDashboardPreferences | None" = ( + moderation_dashboard_preferences: "Optional[ModerationDashboardPreferences]" = ( dc_field( default=None, metadata=dc_config(field_name="moderation_dashboard_preferences"), @@ -2106,11 +2342,11 @@ class AppealAcceptedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2119,7 +2355,7 @@ class AppealAcceptedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - appeal: "AppealItemResponse | None" = dc_field( + appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @@ -2134,11 +2370,11 @@ class AppealCreatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2147,7 +2383,7 @@ class AppealCreatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - appeal: "AppealItemResponse | None" = dc_field( + appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @@ -2182,64 +2418,72 @@ class AppealItemResponse(DataClassJsonMixin): ) ) # Text severity level assigned by the AI provider - ai_text_severity: str | None = dc_field( + ai_text_severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ai_text_severity") ) - # CID of the channel the entity belongs to, if applicable - channel_cid: str | None = dc_field( + # 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: str | None = dc_field( + config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Decision Reason of the Appeal Item - decision_reason: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: "list[ActionLogResponse] | None" = dc_field( + actions: "Optional[List[ActionLogResponse]]" = dc_field( default=None, metadata=dc_config(field_name="actions") ) # Attachments(e.g. Images) of the Appeal Item - attachments: list[str] | None = dc_field( + attachments: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Classification labels from automated and manual review - flag_labels: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: "list[ModerationFlagResponse] | None" = dc_field( + flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) - entity_content: "ModerationPayload | None" = dc_field( + # 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: "ActionLogResponse | None" = dc_field( + moderation_action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) - original_moderation_action: "ActionLogResponse | None" = dc_field( + original_moderation_action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="original_moderation_action") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -2254,11 +2498,11 @@ class AppealRejectedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2267,7 +2511,7 @@ class AppealRejectedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - appeal: "AppealItemResponse | None" = dc_field( + appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) @@ -2280,19 +2524,23 @@ class AppealRequest(DataClassJsonMixin): 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: str | None = dc_field( + review_queue_item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="review_queue_item_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of Attachment URLs(e.g., images) - attachments: list[str] | None = dc_field( + attachments: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -2304,6 +2552,21 @@ class AppealResponse(DataClassJsonMixin): 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( @@ -2332,12 +2595,12 @@ class AsyncBulkImageModerationEvent(DataClassJsonMixin): ) 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2376,11 +2639,11 @@ class AsyncExportChannelsEvent(DataClassJsonMixin): ) 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2419,11 +2682,11 @@ class AsyncExportErrorEvent(DataClassJsonMixin): ) ) task_id: str = dc_field(metadata=dc_config(field_name="task_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) type: str = dc_field( - default="export.users.error", metadata=dc_config(field_name="type") + default="feeds.export.error", metadata=dc_config(field_name="type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2435,7 +2698,7 @@ class AsyncExportErrorEvent(DataClassJsonMixin): @dataclass -class AsyncExportModerationLogsEvent(DataClassJsonMixin): +class AsyncExportFeedsSuccessEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", @@ -2452,6 +2715,7 @@ class AsyncExportModerationLogsEvent(DataClassJsonMixin): 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", @@ -2461,12 +2725,11 @@ class AsyncExportModerationLogsEvent(DataClassJsonMixin): ) ) 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")) + 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") + default="feeds.export.success", metadata=dc_config(field_name="type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2478,7 +2741,7 @@ class AsyncExportModerationLogsEvent(DataClassJsonMixin): @dataclass -class AsyncExportReviewQueueEvent(DataClassJsonMixin): +class AsyncExportLabelResultsEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", @@ -2505,11 +2768,11 @@ class AsyncExportReviewQueueEvent(DataClassJsonMixin): ) 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")) + 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") + default="export.label_results.success", metadata=dc_config(field_name="type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2521,7 +2784,7 @@ class AsyncExportReviewQueueEvent(DataClassJsonMixin): @dataclass -class AsyncExportUsersEvent(DataClassJsonMixin): +class AsyncExportModerationLogsEvent(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", @@ -2548,11 +2811,11 @@ class AsyncExportUsersEvent(DataClassJsonMixin): ) 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")) + 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") + default="export.moderation_logs.success", metadata=dc_config(field_name="type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -2564,84 +2827,266 @@ class AsyncExportUsersEvent(DataClassJsonMixin): @dataclass -class AsyncModerationCallbackConfig(DataClassJsonMixin): - mode: str | None = dc_field(default=None, metadata=dc_config(field_name="mode")) - server_url: str | None = dc_field( - default=None, metadata=dc_config(field_name="server_url") +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"), + ) ) - - -@dataclass -class AsyncModerationConfiguration(DataClassJsonMixin): - timeout_ms: int | None = dc_field( - default=None, metadata=dc_config(field_name="timeout_ms") + 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"), + ) ) - callback: "AsyncModerationCallbackConfig | None" = dc_field( - default=None, metadata=dc_config(field_name="callback") + 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 Attachment(DataClassJsonMixin): - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) - asset_url: str | None = dc_field( - default=None, metadata=dc_config(field_name="asset_url") - ) - author_icon: str | None = dc_field( - default=None, metadata=dc_config(field_name="author_icon") - ) - author_link: str | None = dc_field( - default=None, metadata=dc_config(field_name="author_link") - ) - author_name: str | None = dc_field( - default=None, metadata=dc_config(field_name="author_name") - ) - color: str | None = dc_field(default=None, metadata=dc_config(field_name="color")) - fallback: str | None = dc_field( - default=None, metadata=dc_config(field_name="fallback") - ) - footer: str | None = dc_field(default=None, metadata=dc_config(field_name="footer")) - footer_icon: str | None = dc_field( - default=None, metadata=dc_config(field_name="footer_icon") - ) - image_url: str | None = dc_field( - default=None, metadata=dc_config(field_name="image_url") - ) - og_scrape_url: str | None = dc_field( - default=None, metadata=dc_config(field_name="og_scrape_url") +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"), + ) ) - original_height: int | None = dc_field( - default=None, metadata=dc_config(field_name="original_height") + 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"), + ) ) - original_width: int | None = dc_field( - default=None, metadata=dc_config(field_name="original_width") + 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"), + ) ) - pretext: str | None = dc_field( - default=None, metadata=dc_config(field_name="pretext") + 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") ) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - thumb_url: str | None = dc_field( - default=None, metadata=dc_config(field_name="thumb_url") + 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"), + ), ) - title: str | None = dc_field(default=None, metadata=dc_config(field_name="title")) - title_link: str | None = dc_field( - default=None, metadata=dc_config(field_name="title_link") + + +@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"), + ) ) - # Attachment type (e.g. image, video, url) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - actions: "list[Action] | None" = dc_field( - default=None, metadata=dc_config(field_name="actions") + 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"), + ) ) - fields: "list[Field] | None" = dc_field( - default=None, metadata=dc_config(field_name="fields") + 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"), + ), ) - giphy: "Images | None" = dc_field( - default=None, metadata=dc_config(field_name="giphy") + 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 Audience(DataClassJsonMixin): +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") ) @@ -2653,22 +3098,32 @@ class Audience(DataClassJsonMixin): viewer_connections: int = dc_field( metadata=dc_config(field_name="viewer_connections") ) - concurrency_by_minute: "list[ConcurrencyMinute]" = dc_field( + concurrency_by_minute: "List[ConcurrencyMinute]" = dc_field( metadata=dc_config(field_name="concurrency_by_minute") ) - peak_at: str | None = dc_field( + peak_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="peak_at") ) - ramp_up_min_to_90pct_peak: int | None = dc_field( + 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: float | None = dc_field( + retention_at_90pct_mark: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="retention_at_90pct_mark") ) - retention_at_midpoint: float | None = dc_field( + retention_at_midpoint: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="retention_at_midpoint") ) - shape: str | None = dc_field(default=None, metadata=dc_config(field_name="shape")) + 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 @@ -2676,7 +3131,10 @@ class AudioSettings(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) - default_device: str = dc_field(metadata=dc_config(field_name="default_device")) + # 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") ) @@ -2688,33 +3146,36 @@ class AudioSettings(DataClassJsonMixin): speaker_default_on: bool = dc_field( metadata=dc_config(field_name="speaker_default_on") ) - noise_cancellation: "NoiseCancellationSettings | None" = dc_field( + noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @dataclass class AudioSettingsRequest(DataClassJsonMixin): - default_device: str = dc_field(metadata=dc_config(field_name="default_device")) - access_request_enabled: bool | None = dc_field( + # 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: bool | None = dc_field( + hifi_audio_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hifi_audio_enabled") ) - mic_default_on: bool | None = dc_field( + mic_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mic_default_on") ) - opus_dtx_enabled: bool | None = dc_field( + opus_dtx_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="opus_dtx_enabled") ) - redundant_coding_enabled: bool | None = dc_field( + redundant_coding_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="redundant_coding_enabled") ) - speaker_default_on: bool | None = dc_field( + speaker_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="speaker_default_on") ) - noise_cancellation: "NoiseCancellationSettings | None" = dc_field( + noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @@ -2724,7 +3185,10 @@ class AudioSettingsResponse(DataClassJsonMixin): access_request_enabled: bool = dc_field( metadata=dc_config(field_name="access_request_enabled") ) - default_device: str = dc_field(metadata=dc_config(field_name="default_device")) + # 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") ) @@ -2736,72 +3200,91 @@ class AudioSettingsResponse(DataClassJsonMixin): speaker_default_on: bool = dc_field( metadata=dc_config(field_name="speaker_default_on") ) - noise_cancellation: "NoiseCancellationSettings | None" = dc_field( + noise_cancellation: "Optional[NoiseCancellationSettings]" = dc_field( default=None, metadata=dc_config(field_name="noise_cancellation") ) @dataclass class AutomodDetailsResponse(DataClassJsonMixin): - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - original_message_type: str | None = dc_field( + 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: list[str] | None = dc_field( + image_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) - message_details: "FlagMessageDetailsResponse | None" = dc_field( + message_details: "Optional[FlagMessageDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="message_details") ) # Result of the message moderation - result: "MessageModerationResult | None" = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: "list[AutomodRule] | None" = dc_field( + rules: "Optional[List[AutomodRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AutomodRule(DataClassJsonMixin): - action: str = dc_field(metadata=dc_config(field_name="action")) + # 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: "list[AutomodSemanticFiltersRule] | None" = dc_field( + rules: "Optional[List[AutomodSemanticFiltersRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @dataclass class AutomodSemanticFiltersRule(DataClassJsonMixin): - action: str = dc_field(metadata=dc_config(field_name="action")) + # 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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: "list[AutomodRule] | None" = dc_field( + rules: "Optional[List[AutomodRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @@ -2823,17 +3306,17 @@ class AzureRequest(DataClassJsonMixin): @dataclass class BackstageSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - join_ahead_time_seconds: int | None = dc_field( + join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @dataclass class BackstageSettingsRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - join_ahead_time_seconds: int | None = dc_field( + join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @@ -2841,7 +3324,7 @@ class BackstageSettingsRequest(DataClassJsonMixin): @dataclass class BackstageSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - join_ahead_time_seconds: int | None = dc_field( + join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) @@ -2849,36 +3332,38 @@ class BackstageSettingsResponse(DataClassJsonMixin): @dataclass class BanActionRequestPayload(DataClassJsonMixin): # Also ban user from all channels this moderator creates in the future - ban_from_future_channels: bool | None = dc_field( + 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: bool | None = dc_field( + channel_ban_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="channel_ban_only") ) - channel_cid: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Message deletion mode: soft, pruning, or hard - delete_messages: str | None = dc_field( + delete_messages: "Optional[DeleteMessages]" = dc_field( default=None, metadata=dc_config(field_name="delete_messages") ) # Whether to ban by IP address - ip_ban: bool | None = dc_field( + ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) # Reason for the ban - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) # Whether this is a shadow ban - shadow: bool | None = dc_field( + shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # Optional: ban user directly without review item - target_user_id: str | None = dc_field( + target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) # Duration of ban in minutes - timeout: int | None = dc_field( + timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) @@ -2895,11 +3380,11 @@ class BanInfoResponse(DataClassJsonMixin): ) ) # The channel this ban applies to. Empty if this is an app-wide (global) ban rather than a per-channel ban. - channel_cid: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # When the ban expires - expires: datetime | None = dc_field( + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", @@ -2909,37 +3394,42 @@ class BanInfoResponse(DataClassJsonMixin): ), ) # Reason for the ban - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) # Whether this is a shadow ban - shadow: bool | None = dc_field( + shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) - channel: "ChannelMetadata | None" = dc_field( + channel: "Optional[ChannelMetadata]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class BanOptions(DataClassJsonMixin): - delete_messages: str | None = dc_field( + # 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: int | None = dc_field( + duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="duration") ) - ip_ban: bool | None = dc_field( + ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - shadow_ban: bool | None = dc_field( + 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") ) @@ -2948,33 +3438,44 @@ class BanOptions(DataClassJsonMixin): 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: str | None = dc_field( + banned_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="banned_by_id") ) # Channel where the ban applies - channel_cid: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) - delete_messages: str | None = dc_field( + # 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: bool | None = dc_field( + ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) # Optional explanation for the ban - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) # Whether this is a shadow ban - shadow: bool | None = dc_field( + shadow: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow") ) # Duration of the ban in minutes - timeout: int | None = dc_field( + timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) # User request object - banned_by: "UserRequest | None" = dc_field( + banned_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) @@ -2989,7 +3490,7 @@ class BanResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - expires: datetime | None = dc_field( + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", @@ -2998,20 +3499,22 @@ class BanResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - shadow: bool | None = dc_field( + 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: "UserResponse | None" = dc_field( + banned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3019,23 +3522,25 @@ class BanResponse(DataClassJsonMixin): @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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Optional filter on reaction_type or created_at - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3044,33 +3549,35 @@ class BatchQueryActivityReactionsRequest(DataClassJsonMixin): class BatchQueryActivityReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reactions: "list[FeedsReactionResponse]" = dc_field( + reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Optional filter on reaction_type or created_at - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3079,29 +3586,52 @@ class BatchQueryCommentReactionsRequest(DataClassJsonMixin): class BatchQueryCommentReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reactions: "list[FeedsReactionResponse]" = dc_field( + reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass class BlockListConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - enabled: bool | None = dc_field( + _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") ) - match_substring: bool | None = dc_field( + 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: "list[BlockListRule] | None" = dc_field( + rules: "Optional[List[BlockListRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @@ -3109,7 +3639,9 @@ class BlockListConfig(DataClassJsonMixin): @dataclass class BlockListOptions(DataClassJsonMixin): # Blocklist behavior. One of: flag, block, shadow_block - behavior: str = dc_field(metadata=dc_config(field_name="behavior")) + behavior: "ChannelModerationBehavior" = dc_field( + metadata=dc_config(field_name="behavior") + ) # Blocklist name blocklist: str = dc_field(metadata=dc_config(field_name="blocklist")) @@ -3130,12 +3662,12 @@ class BlockListResponse(DataClassJsonMixin): ) # 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 + # 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")) + words: List[str] = dc_field(metadata=dc_config(field_name="words")) # Date/time of creation - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -3144,13 +3676,13 @@ class BlockListResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - owner_user_id: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Date/time of the last update - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -3164,8 +3696,8 @@ class BlockListResponse(DataClassJsonMixin): @dataclass class BlockListRule(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + 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 @@ -3184,11 +3716,11 @@ class BlockUserResponse(DataClassJsonMixin): class BlockUsersRequest(DataClassJsonMixin): # User id to block blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3232,7 +3764,7 @@ class BlockedUserEvent(DataClassJsonMixin): default="call.blocked_user", metadata=dc_config(field_name="type") ) # User response object - blocked_by_user: "UserResponse | None" = dc_field( + blocked_by_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocked_by_user") ) @@ -3259,9 +3791,17 @@ class BlockedUserResponse(DataClassJsonMixin): 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: "list[BodyguardRule] | None" = dc_field( + rules: "Optional[List[BodyguardRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @@ -3269,10 +3809,10 @@ class BodyguardImageAnalysisConfig(DataClassJsonMixin): @dataclass class BodyguardProfileSummary(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) - display_name: str | None = dc_field( + display_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="display_name") ) - text_type: str | None = dc_field( + text_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="text_type") ) @@ -3280,8 +3820,10 @@ class BodyguardProfileSummary(DataClassJsonMixin): @dataclass class BodyguardRule(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - severity_rules: "list[BodyguardSeverityRule] | None" = dc_field( + 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") ) @@ -3304,12 +3846,12 @@ class BookmarkAddedEvent(DataClassJsonMixin): ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -3318,7 +3860,7 @@ class BookmarkAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3335,12 +3877,12 @@ class BookmarkDeletedEvent(DataClassJsonMixin): ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -3349,7 +3891,7 @@ class BookmarkDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3368,12 +3910,12 @@ class BookmarkFolderDeletedEvent(DataClassJsonMixin): bookmark_folder: "BookmarkFolderResponse" = dc_field( metadata=dc_config(field_name="bookmark_folder") ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -3382,7 +3924,7 @@ class BookmarkFolderDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3414,7 +3956,7 @@ class BookmarkFolderResponse(DataClassJsonMixin): # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # Custom data for the folder - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -3433,12 +3975,12 @@ class BookmarkFolderUpdatedEvent(DataClassJsonMixin): bookmark_folder: "BookmarkFolderResponse" = dc_field( metadata=dc_config(field_name="bookmark_folder") ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -3447,7 +3989,7 @@ class BookmarkFolderUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3479,17 +4021,17 @@ class BookmarkResponse(DataClassJsonMixin): 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: str | None = dc_field( + activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) - comment: "CommentResponse | None" = dc_field( + comment: "Optional[CommentResponse]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data for the bookmark - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - folder: "BookmarkFolderResponse | None" = dc_field( + folder: "Optional[BookmarkFolderResponse]" = dc_field( default=None, metadata=dc_config(field_name="folder") ) @@ -3506,12 +4048,12 @@ class BookmarkUpdatedEvent(DataClassJsonMixin): ) ) bookmark: "BookmarkResponse" = dc_field(metadata=dc_config(field_name="bookmark")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -3520,7 +4062,7 @@ class BookmarkUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3547,7 +4089,7 @@ class BroadcastDailyRollup(DataClassJsonMixin): unique_viewers_sum: int = dc_field( metadata=dc_config(field_name="unique_viewers_sum") ) - top_broadcasts: "list[TopBroadcast]" = dc_field( + top_broadcasts: "List[TopBroadcast]" = dc_field( metadata=dc_config(field_name="top_broadcasts") ) poor_viewers_by_cause: "PoorByCause" = dc_field( @@ -3578,8 +4120,8 @@ class BroadcastInfo(DataClassJsonMixin): 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: str | None = dc_field( + 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") ) @@ -3588,19 +4130,19 @@ class BroadcastInfo(DataClassJsonMixin): 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: float | None = dc_field( + avg_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_quality_score") ) - p5_quality_score: float | None = dc_field( + p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) - poor_pct: float | None = dc_field( + poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) - share_pct: float | None = dc_field( + share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="share_pct") ) - watch_share_pct: float | None = dc_field( + watch_share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="watch_share_pct") ) @@ -3608,23 +4150,23 @@ class BroadcastSegment(DataClassJsonMixin): @dataclass class BroadcastSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - hls: "HLSSettings | None" = dc_field( + hls: "Optional[HLSSettings]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) - rtmp: "RTMPSettings | None" = dc_field( + rtmp: "Optional[RTMPSettings]" = dc_field( default=None, metadata=dc_config(field_name="rtmp") ) @dataclass class BroadcastSettingsRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - hls: "HLSSettingsRequest | None" = dc_field( + hls: "Optional[HLSSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) - rtmp: "RTMPSettingsRequest | None" = dc_field( + rtmp: "Optional[RTMPSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="rtmp") ) @@ -3640,8 +4182,8 @@ class BroadcastSettingsResponse(DataClassJsonMixin): @dataclass class BrowserDataResponse(DataClassJsonMixin): - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - version: str | None = dc_field( + 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") ) @@ -3651,32 +4193,33 @@ 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: str | None = dc_field( + 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: "MarkReviewedRequestPayload | None" = dc_field( + mark_reviewed: "Optional[MarkReviewedRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="mark_reviewed") ) # Configuration for rejecting an appeal - reject_appeal: "RejectAppealRequestPayload | None" = dc_field( + 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: "RestoreActionRequestPayload | None" = dc_field( + restore: "Optional[RestoreActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="restore") ) # Configuration for unban moderation action - unban: "UnbanActionRequestPayload | None" = dc_field( + unban: "Optional[UnbanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unban") ) - # Deprecated: use restore instead — it now also reverses a block or shadow block. Configuration for unblock action. - unblock: "UnblockActionRequestPayload | None" = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3685,9 +4228,9 @@ class BulkActionAppealsRequest(DataClassJsonMixin): 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")) + errors: "List[BulkAppealError]" = dc_field(metadata=dc_config(field_name="errors")) # Successfully processed appeals - results: "list[BulkAppealResult]" = dc_field( + results: "List[BulkAppealResult]" = dc_field( metadata=dc_config(field_name="results") ) @@ -3701,7 +4244,7 @@ class BulkAppealError(DataClassJsonMixin): @dataclass class BulkAppealResult(DataClassJsonMixin): appeal_id: str = dc_field(metadata=dc_config(field_name="appeal_id")) - appeal_item: "AppealItemResponse | None" = dc_field( + appeal_item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal_item") ) @@ -3709,12 +4252,12 @@ class BulkAppealResult(DataClassJsonMixin): @dataclass class BulkDeleteActionConfigRequest(DataClassJsonMixin): # UUIDs of the action configs to delete - ids: list[str] = dc_field(metadata=dc_config(field_name="ids")) - user_id: str | None = dc_field( + 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3742,14 +4285,14 @@ class BulkImageModerationResponse(DataClassJsonMixin): @dataclass class BulkUpsertActionConfigRequest(DataClassJsonMixin): # List of action configs to create or update - action_configs: "list[UpsertActionConfigItem]" = dc_field( + action_configs: "List[UpsertActionConfigItem]" = dc_field( metadata=dc_config(field_name="action_configs") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -3758,14 +4301,14 @@ class BulkUpsertActionConfigRequest(DataClassJsonMixin): 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( + action_configs: "List[ModerationActionConfigResponse]" = dc_field( metadata=dc_config(field_name="action_configs") ) @dataclass class BypassActionRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @@ -3804,23 +4347,25 @@ class CallAcceptedEvent(DataClassJsonMixin): @dataclass class CallActionOptions(DataClassJsonMixin): - duration: int | None = dc_field( + duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="duration") ) - flag_reason: str | None = dc_field( + flag_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="flag_reason") ) - kick_reason: str | None = dc_field( + kick_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="kick_reason") ) - mute_audio: bool | None = dc_field( + mute_audio: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mute_audio") ) - mute_video: bool | None = dc_field( + mute_video: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mute_video") ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - warning_text: str | None = dc_field( + 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") ) @@ -3850,7 +4395,7 @@ class CallClosedCaption(DataClassJsonMixin): translated: bool = dc_field(metadata=dc_config(field_name="translated")) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) - service: str | None = dc_field( + service: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="service") ) @@ -3918,7 +4463,7 @@ class CallCreatedEvent(DataClassJsonMixin): ) ) # the members added to this call - members: "list[MemberResponse]" = dc_field(metadata=dc_config(field_name="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")) # The type of event: "call.created" in this case @@ -3927,10 +4472,10 @@ class CallCreatedEvent(DataClassJsonMixin): @dataclass class CallCustomPropertyParameters(DataClassJsonMixin): - operator: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - property_key: str | None = dc_field( + property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @@ -3986,14 +4531,14 @@ class CallDeletedEvent(DataClassJsonMixin): @dataclass class CallDurationReport(DataClassJsonMixin): - histogram: "list[ReportByHistogramBucket]" = dc_field( + histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class CallDurationReportResponse(DataClassJsonMixin): - daily: "list[DailyAggregateCallDurationReportResponse]" = dc_field( + daily: "List[DailyAggregateCallDurationReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @@ -4014,13 +4559,15 @@ class CallEndedEvent(DataClassJsonMixin): # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) # The list of members in the call - members: "list[MemberResponse] | None" = dc_field( + members: "Optional[List[MemberResponse]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -4073,7 +4620,7 @@ class CallFrameRecordingFrameReadyEvent(DataClassJsonMixin): # 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")) + 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") @@ -4187,11 +4734,19 @@ 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: dict[str, object] | None = dc_field( + 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")) @@ -4223,7 +4778,7 @@ class CallMemberAddedEvent(DataClassJsonMixin): ) ) # the members added to this call - members: "list[MemberResponse]" = dc_field(metadata=dc_config(field_name="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")) # The type of event: "call.member_added" in this case @@ -4244,7 +4799,7 @@ class CallMemberRemovedEvent(DataClassJsonMixin): ) ) # the list of member IDs removed from the call - members: list[str] = dc_field(metadata=dc_config(field_name="members")) + 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 @@ -4265,7 +4820,7 @@ class CallMemberUpdatedEvent(DataClassJsonMixin): ) ) # The list of members that were updated - members: "list[MemberResponse]" = dc_field(metadata=dc_config(field_name="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")) # The type of event: "call.member_updated" in this case @@ -4286,11 +4841,11 @@ class CallMemberUpdatedPermissionEvent(DataClassJsonMixin): ) ) # The list of members that were updated - members: "list[MemberResponse]" = dc_field(metadata=dc_config(field_name="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")) # The capabilities by role for this call - capabilities_by_role: "dict[str, list[str]]" = dc_field( + 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 @@ -4314,7 +4869,7 @@ class CallMissedEvent(DataClassJsonMixin): # 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")) + 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 @@ -4337,7 +4892,7 @@ class CallModerationBlurEvent(DataClassJsonMixin): # 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")) + 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") @@ -4360,7 +4915,7 @@ class CallModerationWarningEvent(DataClassJsonMixin): # 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")) + 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") @@ -4381,7 +4936,7 @@ class CallNotificationEvent(DataClassJsonMixin): # 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")) + 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 @@ -4394,14 +4949,14 @@ class CallNotificationEvent(DataClassJsonMixin): @dataclass class CallParticipantCountReport(DataClassJsonMixin): - histogram: "list[ReportByHistogramBucket]" = dc_field( + histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class CallParticipantCountReportResponse(DataClassJsonMixin): - daily: "list[DailyAggregateCallParticipantCountReportResponse]" = dc_field( + daily: "List[DailyAggregateCallParticipantCountReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @@ -4434,7 +4989,7 @@ class CallParticipantTimeline(DataClassJsonMixin): ) ) type: str = dc_field(metadata=dc_config(field_name="type")) - data: dict[str, object] = dc_field(metadata=dc_config(field_name="data")) + data: Dict[str, object] = dc_field(metadata=dc_config(field_name="data")) @dataclass @@ -4468,7 +5023,10 @@ class CallRecording(DataClassJsonMixin): ) ) filename: str = dc_field(metadata=dc_config(field_name="filename")) - recording_type: str = dc_field(metadata=dc_config(field_name="recording_type")) + # 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( @@ -4494,7 +5052,9 @@ class CallRecordingFailedEvent(DataClassJsonMixin): ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording - recording_type: str = dc_field(metadata=dc_config(field_name="recording_type")) + 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") @@ -4514,7 +5074,9 @@ class CallRecordingReadyEvent(DataClassJsonMixin): ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording - recording_type: str = dc_field(metadata=dc_config(field_name="recording_type")) + 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") @@ -4538,7 +5100,9 @@ class CallRecordingStartedEvent(DataClassJsonMixin): ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording - recording_type: str = dc_field(metadata=dc_config(field_name="recording_type")) + 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") @@ -4558,7 +5122,9 @@ class CallRecordingStoppedEvent(DataClassJsonMixin): ) egress_id: str = dc_field(metadata=dc_config(field_name="egress_id")) # The type of recording - recording_type: str = dc_field(metadata=dc_config(field_name="recording_type")) + 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") @@ -4583,13 +5149,15 @@ class CallRejectedEvent(DataClassJsonMixin): # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + 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: datetime | None = dc_field( + ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", @@ -4598,7 +5166,7 @@ class CallReportResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - started_at: datetime | None = dc_field( + started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", @@ -4611,13 +5179,13 @@ class CallReportResponse(DataClassJsonMixin): @dataclass class CallRequest(DataClassJsonMixin): - channel_cid: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) - created_by_id: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) - starts_at: datetime | None = dc_field( + starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", @@ -4626,19 +5194,21 @@ class CallRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - video: bool | None = dc_field(default=None, metadata=dc_config(field_name="video")) - members: "list[MemberRequest] | None" = dc_field( + 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: "UserRequest | None" = dc_field( + created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - settings_override: "CallSettingsRequest | None" = dc_field( + settings_override: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings_override") ) @@ -4677,24 +5247,24 @@ class CallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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")) + 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: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Date/time when the call ended - ended_at: datetime | None = dc_field( + ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", @@ -4703,15 +5273,15 @@ class CallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - join_ahead_time_seconds: int | None = dc_field( + 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: str | None = dc_field( + routing_number: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="routing_number") ) # Date/time when the call will start - starts_at: datetime | None = dc_field( + starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", @@ -4720,11 +5290,11 @@ class CallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - session: "CallSessionResponse | None" = dc_field( + 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: "ThumbnailResponse | None" = dc_field( + thumbnails: "Optional[ThumbnailResponse]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) @@ -4744,13 +5314,68 @@ class CallRingEvent(DataClassJsonMixin): 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")) + 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 @@ -4818,13 +5443,13 @@ class CallRtmpBroadcastStoppedEvent(DataClassJsonMixin): @dataclass class CallRuleActionSequence(DataClassJsonMixin): - violation_number: int | None = dc_field( + violation_number: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="violation_number") ) - actions: list[str] | None = dc_field( + actions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="actions") ) - call_options: "CallActionOptions | None" = dc_field( + call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) @@ -4866,7 +5491,7 @@ class CallSessionParticipantCountsUpdatedEvent(DataClassJsonMixin): ) # Call session ID session_id: str = dc_field(metadata=dc_config(field_name="session_id")) - participants_count_by_role: "dict[str, int]" = dc_field( + 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 @@ -4921,7 +5546,9 @@ class CallSessionParticipantLeftEvent(DataClassJsonMixin): default="call.session_participant_left", metadata=dc_config(field_name="type") ) # The reason why the participant left the session - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -4930,10 +5557,10 @@ class CallSessionResponse(DataClassJsonMixin): metadata=dc_config(field_name="anonymous_participant_count") ) id: str = dc_field(metadata=dc_config(field_name="id")) - participants: "list[CallParticipantResponse]" = dc_field( + participants: "List[CallParticipantResponse]" = dc_field( metadata=dc_config(field_name="participants") ) - accepted_by: "dict[str, datetime]" = dc_field( + accepted_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="accepted_by", encoder=encode_datetime, @@ -4941,7 +5568,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - missed_by: "dict[str, datetime]" = dc_field( + missed_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="missed_by", encoder=encode_datetime, @@ -4949,10 +5576,10 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - participants_count_by_role: "dict[str, int]" = dc_field( + 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( + rejected_by: "Dict[str, datetime]" = dc_field( metadata=dc_config( field_name="rejected_by", encoder=encode_datetime, @@ -4960,7 +5587,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - ended_at: datetime | None = dc_field( + ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", @@ -4969,7 +5596,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - live_ended_at: datetime | None = dc_field( + live_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="live_ended_at", @@ -4978,7 +5605,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - live_started_at: datetime | None = dc_field( + live_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="live_started_at", @@ -4987,7 +5614,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - started_at: datetime | None = dc_field( + started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", @@ -4996,7 +5623,7 @@ class CallSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - timer_ends_at: datetime | None = dc_field( + timer_ends_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="timer_ends_at", @@ -5030,107 +5657,110 @@ class CallSessionStartedEvent(DataClassJsonMixin): @dataclass class CallSettings(DataClassJsonMixin): - audio: "AudioSettings | None" = dc_field( + audio: "Optional[AudioSettings]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) - backstage: "BackstageSettings | None" = dc_field( + backstage: "Optional[BackstageSettings]" = dc_field( default=None, metadata=dc_config(field_name="backstage") ) - broadcasting: "BroadcastSettings | None" = dc_field( + broadcasting: "Optional[BroadcastSettings]" = dc_field( default=None, metadata=dc_config(field_name="broadcasting") ) - frame_recording: "FrameRecordSettings | None" = dc_field( + frame_recording: "Optional[FrameRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) - geofencing: "GeofenceSettings | None" = dc_field( + geofencing: "Optional[GeofenceSettings]" = dc_field( default=None, metadata=dc_config(field_name="geofencing") ) - individual_recording: "IndividualRecordSettings | None" = dc_field( + individual_recording: "Optional[IndividualRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) - ingress: "IngressSettings | None" = dc_field( + ingress: "Optional[IngressSettings]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) - limits: "LimitsSettings | None" = dc_field( + limits: "Optional[LimitsSettings]" = dc_field( default=None, metadata=dc_config(field_name="limits") ) - raw_recording: "RawRecordSettings | None" = dc_field( + raw_recording: "Optional[RawRecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) - recording: "RecordSettings | None" = dc_field( + recording: "Optional[RecordSettings]" = dc_field( default=None, metadata=dc_config(field_name="recording") ) - ring: "RingSettings | None" = dc_field( + ring: "Optional[RingSettings]" = dc_field( default=None, metadata=dc_config(field_name="ring") ) - screensharing: "ScreensharingSettings | None" = dc_field( + screensharing: "Optional[ScreensharingSettings]" = dc_field( default=None, metadata=dc_config(field_name="screensharing") ) - session: "SessionSettings | None" = dc_field( + session: "Optional[SessionSettings]" = dc_field( default=None, metadata=dc_config(field_name="session") ) - thumbnails: "ThumbnailsSettings | None" = dc_field( + thumbnails: "Optional[ThumbnailsSettings]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) - transcription: "TranscriptionSettings | None" = dc_field( + transcription: "Optional[TranscriptionSettings]" = dc_field( default=None, metadata=dc_config(field_name="transcription") ) - video: "VideoSettings | None" = dc_field( + video: "Optional[VideoSettings]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class CallSettingsRequest(DataClassJsonMixin): - audio: "AudioSettingsRequest | None" = dc_field( + audio: "Optional[AudioSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) - backstage: "BackstageSettingsRequest | None" = dc_field( + backstage: "Optional[BackstageSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="backstage") ) - broadcasting: "BroadcastSettingsRequest | None" = dc_field( + broadcasting: "Optional[BroadcastSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="broadcasting") ) - encryption: "EncryptionSettingsRequest | None" = dc_field( + encryption: "Optional[EncryptionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="encryption") ) - frame_recording: "FrameRecordingSettingsRequest | None" = dc_field( + frame_recording: "Optional[FrameRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) - geofencing: "GeofenceSettingsRequest | None" = dc_field( + geofencing: "Optional[GeofenceSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="geofencing") ) - individual_recording: "IndividualRecordingSettingsRequest | None" = dc_field( + individual_recording: "Optional[IndividualRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) - ingress: "IngressSettingsRequest | None" = dc_field( + ingress: "Optional[IngressSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) - limits: "LimitsSettingsRequest | None" = dc_field( + 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: "RawRecordingSettingsRequest | None" = dc_field( + raw_recording: "Optional[RawRecordingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) - recording: "RecordSettingsRequest | None" = dc_field( + recording: "Optional[RecordSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="recording") ) - ring: "RingSettingsRequest | None" = dc_field( + ring: "Optional[RingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="ring") ) - screensharing: "ScreensharingSettingsRequest | None" = dc_field( + screensharing: "Optional[ScreensharingSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="screensharing") ) - session: "SessionSettingsRequest | None" = dc_field( + session: "Optional[SessionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="session") ) - thumbnails: "ThumbnailsSettingsRequest | None" = dc_field( + thumbnails: "Optional[ThumbnailsSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="thumbnails") ) - transcription: "TranscriptionSettingsRequest | None" = dc_field( + transcription: "Optional[TranscriptionSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="transcription") ) - video: "VideoSettingsRequest | None" = dc_field( + video: "Optional[VideoSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @@ -5158,6 +5788,10 @@ class CallSettingsResponse(DataClassJsonMixin): 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") @@ -5180,7 +5814,7 @@ class CallSettingsResponse(DataClassJsonMixin): metadata=dc_config(field_name="transcription") ) video: "VideoSettingsResponse" = dc_field(metadata=dc_config(field_name="video")) - ingress: "IngressSettingsResponse | None" = dc_field( + ingress: "Optional[IngressSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="ingress") ) @@ -5188,8 +5822,8 @@ class CallSettingsResponse(DataClassJsonMixin): @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( + 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 @@ -5198,26 +5832,26 @@ class CallStateResponseFields(DataClassJsonMixin): @dataclass class CallStatsLocation(DataClassJsonMixin): - accuracy_radius_meters: int | None = dc_field( + accuracy_radius_meters: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="accuracy_radius_meters") ) - city: str | None = dc_field(default=None, metadata=dc_config(field_name="city")) - continent: str | None = dc_field( + 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: str | None = dc_field( + country: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country") ) - country_iso_code: str | None = dc_field( + country_iso_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="country_iso_code") ) - latitude: float | None = dc_field( + latitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latitude") ) - longitude: float | None = dc_field( + longitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="longitude") ) - subdivision: str | None = dc_field( + subdivision: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="subdivision") ) @@ -5226,7 +5860,7 @@ class CallStatsLocation(DataClassJsonMixin): 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: "CallStatsLocation | None" = dc_field( + location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -5239,25 +5873,25 @@ class CallStatsMapPublisher(DataClassJsonMixin): published_tracks: "PublishedTrackFlags" = dc_field( metadata=dc_config(field_name="published_tracks") ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - publisher_type: str | None = dc_field( + 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: "CallStatsLocation | None" = dc_field( + location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @dataclass class CallStatsMapPublishers(DataClassJsonMixin): - publishers: "list[CallStatsMapPublisher]" = dc_field( + publishers: "List[CallStatsMapPublisher]" = dc_field( metadata=dc_config(field_name="publishers") ) @dataclass class CallStatsMapSFUs(DataClassJsonMixin): - locations: "list[SFULocationResponse]" = dc_field( + locations: "List[SFULocationResponse]" = dc_field( metadata=dc_config(field_name="locations") ) @@ -5267,18 +5901,18 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - location: "CallStatsLocation | None" = dc_field( + 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( + locations: "List[CallStatsMapLocation]" = dc_field( metadata=dc_config(field_name="locations") ) - participants: "list[CallStatsMapSubscriber] | None" = dc_field( + participants: "Optional[List[CallStatsMapSubscriber]]" = dc_field( default=None, metadata=dc_config(field_name="participants") ) @@ -5286,10 +5920,10 @@ class CallStatsMapSubscribers(DataClassJsonMixin): @dataclass class CallStatsParticipant(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - sessions: "list[CallStatsParticipantSession]" = dc_field( + sessions: "List[CallStatsParticipantSession]" = dc_field( metadata=dc_config(field_name="sessions") ) - latest_activity_at: datetime | None = dc_field( + latest_activity_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="latest_activity_at", @@ -5298,8 +5932,8 @@ class CallStatsParticipant(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - roles: list[str] | None = dc_field( + 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") ) @@ -5317,28 +5951,28 @@ class CallStatsParticipantCounts(DataClassJsonMixin): 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: int | None = dc_field( + average_jitter_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="average_jitter_ms") ) - average_latency_ms: int | None = dc_field( + average_latency_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="average_latency_ms") ) - avg_user_rating: float | None = dc_field( + avg_user_rating: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_user_rating") ) - call_event_count: int | None = dc_field( + call_event_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="call_event_count") ) - cq_score: int | None = dc_field( + cq_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cq_score") ) - max_freezes_duration_ms: int | None = dc_field( + max_freezes_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_freezes_duration_ms") ) - min_user_rating: int | None = dc_field( + min_user_rating: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_user_rating") ) - total_participant_duration: int | None = dc_field( + total_participant_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_participant_duration") ) @@ -5350,25 +5984,25 @@ class CallStatsParticipantSession(DataClassJsonMixin): published_tracks: "PublishedTrackFlags" = dc_field( metadata=dc_config(field_name="published_tracks") ) - browser: str | None = dc_field( + browser: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser") ) - browser_version: str | None = dc_field( + browser_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser_version") ) - cq_score: int | None = dc_field( + cq_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cq_score") ) - current_ip: str | None = dc_field( + current_ip: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_ip") ) - current_sfu: str | None = dc_field( + current_sfu: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="current_sfu") ) - distance_to_sfu_kilometers: float | None = dc_field( + distance_to_sfu_kilometers: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="distance_to_sfu_kilometers") ) - ended_at: datetime | None = dc_field( + ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", @@ -5377,27 +6011,27 @@ class CallStatsParticipantSession(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - freezes_duration_ms: int | None = dc_field( + freezes_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="freezes_duration_ms") ) - ingress: str | None = dc_field( + ingress: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ingress") ) - jitter_ms: int | None = dc_field( + jitter_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) - latency_ms: int | None = dc_field( + latency_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="latency_ms") ) - os: str | None = dc_field(default=None, metadata=dc_config(field_name="os")) - publisher_type: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="sdk")) - sdk_version: str | None = dc_field( + 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: datetime | None = dc_field( + started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", @@ -5406,13 +6040,13 @@ class CallStatsParticipantSession(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - unified_session_id: str | None = dc_field( + unified_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="unified_session_id") ) - webrtc_version: str | None = dc_field( + webrtc_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webrtc_version") ) - location: "CallStatsLocation | None" = dc_field( + location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -5438,11 +6072,11 @@ class CallStatsReportReadyEvent(DataClassJsonMixin): default="call.stats_report_ready", metadata=dc_config(field_name="type") ) # Whether participants_overview is truncated by the server-side limit - is_trimmed: bool | None = dc_field( + is_trimmed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_trimmed") ) # Top participant sessions overview - participants_overview: "list[CallStatsParticipant] | None" = dc_field( + participants_overview: "Optional[List[CallStatsParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="participants_overview") ) @@ -5463,7 +6097,7 @@ class CallStatsReportSummaryResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -5472,10 +6106,10 @@ class CallStatsReportSummaryResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - min_user_rating: int | None = dc_field( + min_user_rating: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="min_user_rating") ) - quality_score: int | None = dc_field( + quality_score: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="quality_score") ) @@ -5496,7 +6130,7 @@ class CallStatsSessionResponse(DataClassJsonMixin): counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) - call_ended_at: datetime | None = dc_field( + call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", @@ -5505,7 +6139,7 @@ class CallStatsSessionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - call_started_at: datetime | None = dc_field( + call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", @@ -5537,6 +6171,12 @@ class CallTranscription(DataClassJsonMixin): ) ) 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 @@ -5556,7 +6196,9 @@ class CallTranscriptionFailedEvent(DataClassJsonMixin): default="call.transcription_failed", metadata=dc_config(field_name="type") ) # The error message detailing why transcription failed. - error: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + error: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="error") + ) @dataclass @@ -5641,10 +6283,10 @@ class CallType(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - notification_settings: "NotificationSettings | None" = dc_field( + notification_settings: "Optional[NotificationSettings]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) - settings: "CallSettings | None" = dc_field( + settings: "Optional[CallSettings]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @@ -5672,7 +6314,7 @@ class CallTypeResponse(DataClassJsonMixin): ) ) # the permissions granted to each role - grants: "dict[str, list[str]]" = dc_field(metadata=dc_config(field_name="grants")) + 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") ) @@ -5680,14 +6322,14 @@ class CallTypeResponse(DataClassJsonMixin): metadata=dc_config(field_name="settings") ) # the external storage for the call type - external_storage: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @dataclass class CallTypeRuleParameters(DataClassJsonMixin): - call_type: str | None = dc_field( + call_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_type") ) @@ -5706,7 +6348,7 @@ class CallUpdatedEvent(DataClassJsonMixin): # 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( + 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 @@ -5735,13 +6377,15 @@ class CallUserFeedbackSubmittedEvent(DataClassJsonMixin): default="call.user_feedback_submitted", metadata=dc_config(field_name="type") ) # The reason provided by the user for the rating - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - sdk: str | None = dc_field(default=None, metadata=dc_config(field_name="sdk")) - sdk_version: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -5759,7 +6403,7 @@ class CallUserMutedEvent(DataClassJsonMixin): ) 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( + 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 @@ -5770,10 +6414,10 @@ class CallUserMutedEvent(DataClassJsonMixin): @dataclass class CallViolationCountParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @@ -5785,18 +6429,27 @@ class CallsPerDayReport(DataClassJsonMixin): @dataclass class CallsPerDayReportResponse(DataClassJsonMixin): - daily: "list[DailyAggregateCallsPerDayReportResponse]" = dc_field( + 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: str | None = dc_field( + channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -5804,15 +6457,15 @@ class CampaignChannelMember(DataClassJsonMixin): @dataclass class CampaignChannelTemplate(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - members: list[str] | None = dc_field( + 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: "list[CampaignChannelMember] | None" = dc_field( + members_template: "Optional[List[CampaignChannelMember]]" = dc_field( default=None, metadata=dc_config(field_name="members_template") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -5827,11 +6480,11 @@ class CampaignCompletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -5840,7 +6493,7 @@ class CampaignCompletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - campaign: "CampaignResponse | None" = dc_field( + campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) @@ -5848,16 +6501,16 @@ class CampaignCompletedEvent(DataClassJsonMixin): @dataclass class CampaignMessageTemplate(DataClassJsonMixin): text: str = dc_field(metadata=dc_config(field_name="text")) - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - searchable: bool | None = dc_field( + searchable: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="searchable") ) - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -5877,10 +6530,6 @@ class CampaignResponse(DataClassJsonMixin): 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")) - sender_mode: str = dc_field(metadata=dc_config(field_name="sender_mode")) - sender_visibility: str = dc_field( - metadata=dc_config(field_name="sender_visibility") - ) 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")) @@ -5893,12 +6542,12 @@ class CampaignResponse(DataClassJsonMixin): 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")) + 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: datetime | None = dc_field( + scheduled_for: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_for", @@ -5907,7 +6556,15 @@ class CampaignResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - stop_at: datetime | None = dc_field( + # 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", @@ -5916,18 +6573,34 @@ class CampaignResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - channel_template: "CampaignChannelTemplate | None" = dc_field( + channel_template: "Optional[CampaignChannelTemplate]" = dc_field( default=None, metadata=dc_config(field_name="channel_template") ) - message_template: "CampaignMessageTemplate | None" = dc_field( + message_template: "Optional[CampaignMessageTemplate]" = dc_field( default=None, metadata=dc_config(field_name="message_template") ) # User response object - sender: "UserResponse | None" = dc_field( + 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( @@ -5938,11 +6611,11 @@ class CampaignStartedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -5951,7 +6624,7 @@ class CampaignStartedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - campaign: "CampaignResponse | None" = dc_field( + campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) @@ -5986,8 +6659,8 @@ class CampaignStatsResponse(DataClassJsonMixin): @dataclass -class CancelImportV2TaskRequest(DataClassJsonMixin): - pass +class CancelExportFeedsResponse(DataClassJsonMixin): + duration: str = dc_field(metadata=dc_config(field_name="duration")) @dataclass @@ -5998,14 +6671,22 @@ class CancelImportV2TaskResponse(DataClassJsonMixin): @dataclass class CastPollVoteRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - vote: "VoteData | None" = dc_field( + vote: "Optional[VoteData]" = dc_field( default=None, metadata=dc_config(field_name="vote") ) @@ -6013,9 +6694,9 @@ class CastPollVoteRequest(DataClassJsonMixin): @dataclass class ChangeFeedVisibilityRequest(DataClassJsonMixin): # Feed visibility level: public, visible, followers, members, or private - visibility: str = dc_field(metadata=dc_config(field_name="visibility")) + 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: str | None = dc_field( + pending_follows_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pending_follows_action") ) @@ -6027,15 +6708,7 @@ class ChangeFeedVisibilityResponse(DataClassJsonMixin): @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"), - ) - ) +class ChannelBanResponse(DataClassJsonMixin): created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", @@ -6044,42 +6717,108 @@ class ChannelBatchCompletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - finished_at: datetime = dc_field( + 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="finished_at", + field_name="created_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: datetime | None = dc_field( + shadow: bool = dc_field(metadata=dc_config(field_name="shadow")) + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( - field_name="received_at", + 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: str | None = dc_field( + channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) @@ -6116,14 +6855,14 @@ class ChannelBatchStartedEvent(DataClassJsonMixin): 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( + 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -6138,9 +6877,9 @@ class ChannelBatchStartedEvent(DataClassJsonMixin): 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")) + 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: datetime | None = dc_field( + hide_history_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_history_before", @@ -6149,35 +6888,47 @@ class ChannelBatchUpdateRequest(DataClassJsonMixin): 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: list[str] | None = dc_field( + custom_unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="custom_unset") ) - members: "list[ChannelBatchMemberRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + custom_set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_set") ) - data: "ChannelDataUpdate | None" = dc_field( + data: "Optional[ChannelDataUpdate]" = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class ChannelBatchUpdateResponse(DataClassJsonMixin): - # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - task_id: str | None = dc_field( + # 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: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -6230,105 +6981,112 @@ class ChannelConfig(DataClassJsonMixin): 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: str | None = dc_field( + commands: List[str] = dc_field(metadata=dc_config(field_name="commands")) + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @dataclass class ChannelConfigOverrides(DataClassJsonMixin): - blocklist: str | None = dc_field( + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) - blocklist_behavior: str | None = dc_field( + # 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: bool | None = dc_field( + count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Overrides max message length - max_message_length: int | None = dc_field( + 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: str | None = dc_field( + push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # Enables message quotes - quotes: bool | None = dc_field( + quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) # Enables or disables reactions - reactions: bool | None = dc_field( + reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Enables message replies (threads) - replies: bool | None = dc_field( + replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Enable/disable shared locations - shared_locations: bool | None = dc_field( + shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) # Enables or disables typing events - typing_events: bool | None = dc_field( + typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Enables or disables file uploads - uploads: bool | None = dc_field( + uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # Enables or disables URL enrichment - url_enrichment: bool | None = dc_field( + url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) # Enable/disable user message reminders - user_message_reminders: bool | None = dc_field( + user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # List of commands that channel supports - commands: list[str] | None = dc_field( + commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class ChannelConfigWithInfo(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -6380,36 +7138,57 @@ class ChannelConfigWithInfo(DataClassJsonMixin): 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: str | None = dc_field( + commands: "List[Command]" = dc_field(metadata=dc_config(field_name="commands")) + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + # 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: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @@ -6423,7 +7202,7 @@ class ChannelContextResponse(DataClassJsonMixin): # Channel type type: str = dc_field(metadata=dc_config(field_name="type")) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @@ -6441,29 +7220,29 @@ class ChannelCreatedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was created - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -6473,35 +7252,35 @@ class ChannelCreatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelDataUpdate(DataClassJsonMixin): - auto_translation_enabled: bool | None = dc_field( + auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) - auto_translation_language: str | None = dc_field( + auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) - frozen: bool | None = dc_field( + frozen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="frozen") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Channel configuration overrides - config_overrides: "ChannelConfigOverrides | None" = dc_field( + config_overrides: "Optional[ChannelConfigOverrides]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -6519,29 +7298,29 @@ class ChannelDeletedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was deleted - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -6551,22 +7330,22 @@ class ChannelDeletedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelExport(DataClassJsonMixin): - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Channel ID - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Date to export messages since - messages_since: datetime | None = dc_field( + messages_since: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="messages_since", @@ -6576,7 +7355,7 @@ class ChannelExport(DataClassJsonMixin): ), ) # Date to export messages until - messages_until: datetime | None = dc_field( + messages_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="messages_until", @@ -6586,7 +7365,157 @@ class ChannelExport(DataClassJsonMixin): ), ) # Channel type - type: str | None = dc_field(default=None, metadata=dc_config(field_name="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 @@ -6600,22 +7529,22 @@ class ChannelFrozenEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was frozen - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -6629,28 +7558,34 @@ class ChannelFrozenEvent(DataClassJsonMixin): @dataclass class ChannelGetOrCreateRequest(DataClassJsonMixin): # Whether this channel will be hidden for the user who created the channel or not - hide_for_creator: bool | None = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="state")) - thread_unread_counts: bool | None = dc_field( + 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: list[str] | None = dc_field( + member_custom_include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_custom_include") ) - data: "ChannelInput | None" = dc_field( + data: "Optional[ChannelInput]" = dc_field( default=None, metadata=dc_config(field_name="data") ) - members: "PaginationParams | None" = dc_field( + members: "Optional[PaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="members") ) - messages: "MessagePaginationParams | None" = dc_field( + messages: "Optional[MessagePaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="messages") ) - watchers: "PaginationParams | None" = dc_field( + watchers: "Optional[PaginationParams]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) @@ -6670,29 +7605,29 @@ class ChannelHiddenEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was hidden - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -6702,11 +7637,11 @@ class ChannelHiddenEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -6714,80 +7649,80 @@ class ChannelHiddenEvent(DataClassJsonMixin): @dataclass class ChannelInput(DataClassJsonMixin): # Enable or disable auto translation - auto_translation_enabled: bool | None = dc_field( + 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: str | None = dc_field( + auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) - created_by_id: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) # Freeze or unfreeze the channel - frozen: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - truncated_by_id: str | None = dc_field( + 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: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) - invites: "list[ChannelMemberRequest] | None" = dc_field( + invites: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="invites") ) - members: "list[ChannelMemberRequest] | None" = dc_field( + members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Channel configuration overrides - config_overrides: "ChannelConfigOverrides | None" = dc_field( + config_overrides: "Optional[ChannelConfigOverrides]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) # User request object - created_by: "UserRequest | None" = dc_field( + created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class ChannelInputRequest(DataClassJsonMixin): - auto_translation_enabled: bool | None = dc_field( + auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) - auto_translation_language: str | None = dc_field( + auto_translation_language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_language") ) - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) - frozen: bool | None = dc_field( + frozen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="frozen") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - invites: "list[ChannelMemberRequest] | None" = dc_field( + 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: "list[ChannelMemberRequest] | None" = dc_field( + members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Channel configuration overrides - config_overrides: "ConfigOverridesRequest | None" = dc_field( + config_overrides: "Optional[ConfigOverridesRequest]" = dc_field( default=None, metadata=dc_config(field_name="config_overrides") ) # User request object - created_by: "UserRequest | None" = dc_field( + created_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -6801,7 +7736,7 @@ class ChannelMemberPartialResponse(DataClassJsonMixin): metadata=dc_config(field_name="notifications_muted") ) # Channel-member custom fields projected via `member_custom_include` - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -6809,16 +7744,16 @@ class ChannelMemberPartialResponse(DataClassJsonMixin): @dataclass class ChannelMemberRequest(DataClassJsonMixin): # Role of the member in the channel - channel_role: str | None = dc_field( + channel_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_role") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - user: "MemberUserRequest | None" = dc_field( + user: "Optional[MemberUserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -6852,8 +7787,9 @@ class ChannelMemberResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) - archived_at: datetime | None = dc_field( + 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", @@ -6863,7 +7799,7 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Expiration date of the ban - ban_expires: datetime | None = dc_field( + ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", @@ -6873,10 +7809,10 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # 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: bool | None = dc_field( + ban_from_future_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ban_from_future_channels") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -6886,7 +7822,7 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Expiration date of the future channel ban; absent when the future channel ban is permanent - future_channel_ban_expires: datetime | None = dc_field( + future_channel_ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="future_channel_ban_expires", @@ -6896,7 +7832,7 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Date when invite was accepted - invite_accepted_at: datetime | None = dc_field( + invite_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_accepted_at", @@ -6906,7 +7842,7 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Date when invite was rejected - invite_rejected_at: datetime | None = dc_field( + invite_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_rejected_at", @@ -6916,14 +7852,14 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Whether member was invited or not - invited: bool | None = dc_field( + invited: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="invited") ) # Whether member is channel moderator or not - is_moderator: bool | None = dc_field( + is_moderator: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_moderator") ) - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -6933,26 +7869,25 @@ class ChannelMemberResponse(DataClassJsonMixin): ), ) # Permission level of the member in the channel (DEPRECATED: use channel_role instead). One of: member, moderator, admin, owner - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) - status: str | None = dc_field(default=None, metadata=dc_config(field_name="status")) - user_id: str | None = dc_field( - default=None, metadata=dc_config(field_name="user_id") + 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: list[str] | None = dc_field( + deleted_messages: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="deleted_messages") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelMessageCountRuleParameters(DataClassJsonMixin): - operator: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) @@ -6960,7 +7895,7 @@ class ChannelMessageCountRuleParameters(DataClassJsonMixin): @dataclass class ChannelMessagesResponse(DataClassJsonMixin): # List of messages - messages: "list[MessageResponse]" = dc_field( + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # Represents channel in chat @@ -6972,8 +7907,8 @@ 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: datetime | None = dc_field( + 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", @@ -6982,16 +7917,26 @@ class ChannelMetadata(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - member_count: int | None = dc_field( + member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_count") ) - message_count: int | None = dc_field( + message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="message_count") ) - push_level: str | None = dc_field( + # How much a channel notifies its members. + push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + 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 @@ -7015,7 +7960,7 @@ class ChannelMute(DataClassJsonMixin): ) ) # Date/time of mute expiration - expires: datetime | None = dc_field( + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", @@ -7025,11 +7970,11 @@ class ChannelMute(DataClassJsonMixin): ), ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -7045,10 +7990,10 @@ class ChannelMutedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -7058,13 +8003,13 @@ class ChannelMutedEvent(DataClassJsonMixin): ), ) # The mute objects - mutes: "list[ChannelMute] | None" = dc_field( + mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="mutes") ) - mute: "ChannelMute | None" = dc_field( + mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="mute") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -7095,6 +8040,7 @@ class ChannelOwnCapability: 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" @@ -7121,10 +8067,12 @@ class ChannelOwnCapability: @dataclass class ChannelPushPreferencesResponse(DataClassJsonMixin): - chat_level: str | None = dc_field( + # The scope level of the push notifications. + chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) - disabled_until: datetime | None = dc_field( + # 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", @@ -7133,7 +8081,7 @@ class ChannelPushPreferencesResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - chat_preferences: "ChatPreferencesResponse | None" = dc_field( + chat_preferences: "Optional[ChatPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @@ -7168,25 +8116,29 @@ class ChannelResponse(DataClassJsonMixin): ) ) # Custom data for this object - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: bool | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + blocked: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="blocked") ) # Cooldown period after sending each message - cooldown: int | None = dc_field( + cooldown: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown") ) # Date/time of deletion - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -7196,11 +8148,11 @@ class ChannelResponse(DataClassJsonMixin): ), ) # Whether this channel is hidden by current user or not - hidden: bool | None = dc_field( + hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hidden") ) # Date since when the message history is accessible - hide_messages_before: datetime | None = dc_field( + hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", @@ -7210,7 +8162,7 @@ class ChannelResponse(DataClassJsonMixin): ), ) # Date of the last message sent - last_message_at: datetime | None = dc_field( + last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", @@ -7220,15 +8172,15 @@ class ChannelResponse(DataClassJsonMixin): ), ) # Number of members in the channel - member_count: int | None = dc_field( + member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="member_count") ) # Number of messages in the channel - message_count: int | None = dc_field( + message_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="message_count") ) # Date of mute expiration - mute_expires_at: datetime | None = dc_field( + mute_expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="mute_expires_at", @@ -7238,11 +8190,13 @@ class ChannelResponse(DataClassJsonMixin): ), ) # Whether this channel is muted or not - muted: bool | None = dc_field(default=None, metadata=dc_config(field_name="muted")) + muted: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="muted") + ) # Team the channel belongs to (multi-tenant only) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Date of the latest truncation of the channel - truncated_at: datetime | None = dc_field( + truncated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="truncated_at", @@ -7252,49 +8206,141 @@ class ChannelResponse(DataClassJsonMixin): ), ) # List of filter tags associated with the channel - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # List of channel members (max 100) - members: "list[ChannelMemberResponse] | None" = dc_field( + members: "Optional[List[ChannelMemberResponse]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # List of channel capabilities of authenticated user - own_capabilities: "list[ChannelOwnCapability] | None" = dc_field( + own_capabilities: "Optional[List[ChannelOwnCapability]]" = dc_field( default=None, metadata=dc_config(field_name="own_capabilities") ) - config: "ChannelConfigWithInfo | None" = dc_field( + config: "Optional[ChannelConfigWithInfo]" = dc_field( default=None, metadata=dc_config(field_name="config") ) # User response object - created_by: "UserResponse | None" = dc_field( + 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: "UserResponse | None" = dc_field( + 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")) - members: "list[ChannelMemberResponse]" = dc_field( + # List of channel members + members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) - messages: "list[MessageResponse]" = dc_field( + # List of channel messages + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) - pinned_messages: "list[MessageResponse]" = dc_field( + # 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( + threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) - hidden: bool | None = dc_field( + # 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") ) - hide_messages_before: datetime | None = dc_field( + # 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", @@ -7303,32 +8349,42 @@ class ChannelStateResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - watcher_count: int | None = dc_field( + # Number of channel watchers + watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) - active_live_locations: "list[SharedLocationResponseData] | None" = dc_field( + # 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: "list[PendingMessageResponse] | None" = dc_field( + # Pending messages that this user has sent + pending_messages: "Optional[List[PendingMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="pending_messages") ) - read: "list[ReadStateResponse] | None" = dc_field( + # List of read states + read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) - watchers: "list[UserResponse] | None" = dc_field( + # 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: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - draft: "DraftResponse | None" = dc_field( + draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) - membership: "ChannelMemberResponse | None" = dc_field( + membership: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership") ) - push_preferences: "ChannelPushPreferencesResponse | None" = dc_field( + # The push preference details. + push_preferences: "Optional[ChannelPushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) @@ -7336,26 +8392,30 @@ class ChannelStateResponse(DataClassJsonMixin): @dataclass class ChannelStateResponseFields(DataClassJsonMixin): # List of channel members - members: "list[ChannelMemberResponse]" = dc_field( + members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # List of channel messages - messages: "list[MessageResponse]" = dc_field( + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) # List of pinned messages in the channel - pinned_messages: "list[MessageResponse]" = dc_field( + pinned_messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="pinned_messages") ) - threads: "list[ThreadStateResponse]" = dc_field( + 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: bool | None = dc_field( + 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: datetime | None = dc_field( + hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_messages_before", @@ -7365,36 +8425,41 @@ class ChannelStateResponseFields(DataClassJsonMixin): ), ) # Number of channel watchers - watcher_count: int | None = dc_field( + watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) # Active live locations in the channel - active_live_locations: "list[SharedLocationResponseData] | None" = dc_field( + 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: "list[PendingMessageResponse] | None" = dc_field( + pending_messages: "Optional[List[PendingMessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="pending_messages") ) # List of read states - read: "list[ReadStateResponse] | None" = dc_field( + 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: "list[UserResponse] | None" = dc_field( + watchers: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="watchers") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - draft: "DraftResponse | None" = dc_field( + draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) - membership: "ChannelMemberResponse | None" = dc_field( + membership: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="membership") ) - push_preferences: "ChannelPushPreferencesResponse | None" = dc_field( + # The push preference details. + push_preferences: "Optional[ChannelPushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) @@ -7412,32 +8477,32 @@ class ChannelTruncatedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was truncated - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - message_id: str | None = dc_field( + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -7447,23 +8512,27 @@ class ChannelTruncatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChannelTypeConfig(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -7515,41 +8584,57 @@ class ChannelTypeConfig(DataClassJsonMixin): 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( + 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: str | None = dc_field( + 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") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + 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 @@ -7561,22 +8646,22 @@ class ChannelUnFrozenEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was unfrozen - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -7598,12 +8683,12 @@ class ChannelUnmutedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -7613,13 +8698,13 @@ class ChannelUnmutedEvent(DataClassJsonMixin): ), ) # The mute objects - mutes: "list[ChannelMute] | None" = dc_field( + mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="mutes") ) - mute: "ChannelMute | None" = dc_field( + mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="mute") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -7637,32 +8722,32 @@ class ChannelUpdatedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was updated - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - message_id: str | None = dc_field( + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -7672,15 +8757,15 @@ class ChannelUpdatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -7698,29 +8783,29 @@ class ChannelVisibleEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel which was shown - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -7730,18 +8815,18 @@ class ChannelVisibleEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class ChatActivityStatsResponse(DataClassJsonMixin): - messages: "MessageStatsResponse | None" = dc_field( + messages: "Optional[MessageStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="Messages") ) @@ -7750,29 +8835,29 @@ class ChatActivityStatsResponse(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="html")) - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) - parent_id: str | None = dc_field( + 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: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) - show_in_channel: bool | None = dc_field( + show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) - silent: bool | None = dc_field( + silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - attachments: "list[Attachment] | None" = dc_field( + 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: "list[UserResponse] | None" = dc_field( + mentioned_users: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) @@ -7791,13 +8876,13 @@ class ChatDraftResponse(DataClassJsonMixin): message: "ChatDraftPayloadResponse" = dc_field( metadata=dc_config(field_name="message") ) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - parent_message: "ChatMessageResponse | None" = dc_field( + parent_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) - quoted_message: "ChatMessageResponse | None" = dc_field( + quoted_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) @@ -7836,34 +8921,34 @@ class ChatMessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - attachments: "list[Attachment]" = dc_field( + attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) - latest_reactions: "list[ChatReactionResponse]" = dc_field( + latest_reactions: "List[ChatReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) - mentioned_users: "list[UserResponse]" = dc_field( + mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) - own_reactions: "list[ChatReactionResponse]" = dc_field( + own_reactions: "List[ChatReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) - restricted_visibility: list[str] = dc_field( + 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( + 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( + 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: str | None = dc_field( + command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -7872,10 +8957,10 @@ class ChatMessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_for_me: bool | None = dc_field( + deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) - message_text_updated_at: datetime | None = dc_field( + message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", @@ -7884,11 +8969,11 @@ class ChatMessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) - parent_id: str | None = dc_field( + 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: datetime | None = dc_field( + pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", @@ -7897,7 +8982,7 @@ class ChatMessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -7906,59 +8991,59 @@ class ChatMessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) - show_in_channel: bool | None = dc_field( + show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) - mentioned_group_ids: list[str] | None = dc_field( + mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) - mentioned_groups: "list[UserGroupResponse] | None" = dc_field( + mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) - mentioned_roles: list[str] | None = dc_field( + mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) - thread_participants: "list[UserResponse] | None" = dc_field( + thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - draft: "ChatDraftResponse | None" = dc_field( + draft: "Optional[ChatDraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) - i18n: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - image_labels: "dict[str, list[str]] | None" = dc_field( + image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) - member: "ChannelMemberPartialResponse | None" = dc_field( + member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) - moderation: "ChatModerationV2Response | None" = dc_field( + moderation: "Optional[ChatModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object - pinned_by: "UserResponse | None" = dc_field( + pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) - quoted_message: "ChatMessageResponse | None" = dc_field( + quoted_message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) - reaction_groups: "dict[str, ChatReactionGroupResponse | None] | None" = dc_field( - default=None, metadata=dc_config(field_name="reaction_groups") + reaction_groups: "Optional[Dict[str, Optional[ChatReactionGroupResponse]]]" = ( + dc_field(default=None, metadata=dc_config(field_name="reaction_groups")) ) - reminder: "ChatReminderResponseData | None" = dc_field( + reminder: "Optional[ChatReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) - shared_location: "ChatSharedLocationResponseData | None" = dc_field( + shared_location: "Optional[ChatSharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @@ -7967,100 +9052,100 @@ class ChatMessageResponse(DataClassJsonMixin): 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: str | None = dc_field( + blocklist_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_matched") ) - platform_circumvented: bool | None = dc_field( + platform_circumvented: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="platform_circumvented") ) - semantic_filter_matched: str | None = dc_field( + semantic_filter_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_matched") ) - blocklists_matched: list[str] | None = dc_field( + blocklists_matched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklists_matched") ) - image_harms: list[str] | None = dc_field( + image_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_harms") ) - text_harms: list[str] | None = dc_field( + text_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_harms") ) @dataclass class ChatPreferences(DataClassJsonMixin): - channel_mentions: str | None = dc_field( + channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) - default_preference: str | None = dc_field( + default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) - direct_mentions: str | None = dc_field( + direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) - distinct_channel_messages: str | None = dc_field( + distinct_channel_messages: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="distinct_channel_messages") ) - group_mentions: str | None = dc_field( + group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) - here_mentions: str | None = dc_field( + here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) - role_mentions: str | None = dc_field( + role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) - thread_replies: str | None = dc_field( + thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @dataclass class ChatPreferencesInput(DataClassJsonMixin): - channel_mentions: str | None = dc_field( + channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) - default_preference: str | None = dc_field( + default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) - direct_mentions: str | None = dc_field( + direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) - group_mentions: str | None = dc_field( + group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) - here_mentions: str | None = dc_field( + here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) - role_mentions: str | None = dc_field( + role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) - thread_replies: str | None = dc_field( + thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @dataclass class ChatPreferencesResponse(DataClassJsonMixin): - channel_mentions: str | None = dc_field( + channel_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_mentions") ) - default_preference: str | None = dc_field( + default_preference: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_preference") ) - direct_mentions: str | None = dc_field( + direct_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direct_mentions") ) - group_mentions: str | None = dc_field( + group_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="group_mentions") ) - here_mentions: str | None = dc_field( + here_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="here_mentions") ) - role_mentions: str | None = dc_field( + role_mentions: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="role_mentions") ) - thread_replies: str | None = dc_field( + thread_replies: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_replies") ) @@ -8085,7 +9170,7 @@ class ChatReactionGroupResponse(DataClassJsonMixin): ) ) sum_scores: int = dc_field(metadata=dc_config(field_name="sum_scores")) - latest_reactions_by: "list[ChatReactionGroupUserResponse]" = dc_field( + latest_reactions_by: "List[ChatReactionGroupUserResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions_by") ) @@ -8102,7 +9187,7 @@ class ChatReactionGroupUserResponse(DataClassJsonMixin): ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8129,7 +9214,7 @@ class ChatReactionResponse(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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")) @@ -8155,7 +9240,7 @@ class ChatReminderResponseData(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - remind_at: datetime | None = dc_field( + remind_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="remind_at", @@ -8164,11 +9249,11 @@ class ChatReminderResponseData(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - message: "ChatMessageResponse | None" = dc_field( + message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8199,7 +9284,7 @@ class ChatSharedLocationResponseData(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - end_at: datetime | None = dc_field( + end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", @@ -8208,7 +9293,7 @@ class ChatSharedLocationResponseData(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - message: "ChatMessageResponse | None" = dc_field( + message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -8221,44 +9306,76 @@ class CheckExternalStorageResponse(DataClassJsonMixin): @dataclass -class CheckPushRequest(DataClassJsonMixin): - # Push message template for APN - apn_template: str | None = 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 - event_type: str | None = dc_field( - default=None, metadata=dc_config(field_name="event_type") - ) - # Push message data template for Firebase - firebase_data_template: str | None = dc_field( - default=None, metadata=dc_config(field_name="firebase_data_template") +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"), ) - # Push message template for Firebase - firebase_template: str | None = dc_field( - default=None, metadata=dc_config(field_name="firebase_template") + # 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") ) - # Message ID to send push notification for - message_id: str | None = dc_field( - default=None, metadata=dc_config(field_name="message_id") + # 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") ) - # Name of push provider - push_provider_name: str | None = dc_field( + + +@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: str | None = dc_field( + 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: bool | None = dc_field( + skip_devices: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_devices") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8267,28 +9384,28 @@ class CheckPushRequest(DataClassJsonMixin): class CheckPushResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # The event type that was tested - event_type: str | None = dc_field( + event_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="event_type") ) - rendered_apn_template: str | None = dc_field( + rendered_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="rendered_apn_template") ) - rendered_firebase_template: str | None = dc_field( + 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: bool | None = dc_field( + skip_devices: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_devices") ) # List of general errors - general_errors: list[str] | None = dc_field( + general_errors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="general_errors") ) # Object with device errors - device_errors: "dict[str, DeviceErrorInfo] | None" = dc_field( + device_errors: "Optional[Dict[str, DeviceErrorInfo]]" = dc_field( default=None, metadata=dc_config(field_name="device_errors") ) - rendered_message: "dict[str, str] | None" = dc_field( + rendered_message: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="rendered_message") ) @@ -8304,15 +9421,15 @@ class CheckRequest(DataClassJsonMixin): # 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: str | None = dc_field( + config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) # Team associated with the configuration - config_team: str | None = dc_field( + 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: datetime | None = dc_field( + content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", @@ -8321,25 +9438,34 @@ class CheckRequest(DataClassJsonMixin): 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: bool | None = dc_field( + test_mode: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="test_mode") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - config: "ModerationConfig | None" = dc_field( + # 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: "ModerationPayload | None" = dc_field( + moderation_payload: "Optional[ModerationPayload]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # Additional moderation configuration options - options: dict[str, object] | None = dc_field( + options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8353,18 +9479,31 @@ class CheckResponse(DataClassJsonMixin): ) # 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: str | None = dc_field( + 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: "list[TriggeredRuleResponse] | None" = dc_field( + triggered_rules: "Optional[List[TriggeredRuleResponse]]" = dc_field( default=None, metadata=dc_config(field_name="triggered_rules") ) - item: "ReviewQueueItemResponse | None" = dc_field( + item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) - triggered_rule: "TriggeredRuleResponse | None" = dc_field( + # Deprecated + triggered_rule: "Optional[TriggeredRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="triggered_rule") ) @@ -8372,7 +9511,9 @@ class CheckResponse(DataClassJsonMixin): @dataclass class CheckS3AccessRequest(DataClassJsonMixin): # Optional stream+s3:// reference to test access against - s3_url: str | None = dc_field(default=None, metadata=dc_config(field_name="s3_url")) + s3_url: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="s3_url") + ) @dataclass @@ -8381,7 +9522,7 @@ class CheckS3AccessResponse(DataClassJsonMixin): # Whether the S3 access check succeeded success: bool = dc_field(metadata=dc_config(field_name="success")) # Descriptive message about the check result - message: str | None = dc_field( + message: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -8389,15 +9530,15 @@ class CheckS3AccessResponse(DataClassJsonMixin): @dataclass class CheckSNSRequest(DataClassJsonMixin): # AWS SNS access key - sns_key: str | None = dc_field( + sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) # AWS SNS key secret - sns_secret: str | None = dc_field( + sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) # AWS SNS topic ARN - sns_topic_arn: str | None = dc_field( + sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) @@ -8408,9 +9549,11 @@ class CheckSNSResponse(DataClassJsonMixin): # Validation result. One of: ok, error status: str = dc_field(metadata=dc_config(field_name="status")) # Error text - error: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + error: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="error") + ) # Error data - data: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @@ -8418,15 +9561,15 @@ class CheckSNSResponse(DataClassJsonMixin): @dataclass class CheckSQSRequest(DataClassJsonMixin): # AWS SQS access key - sqs_key: str | None = dc_field( + sqs_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_key") ) # AWS SQS key secret - sqs_secret: str | None = dc_field( + sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) # AWS SQS endpoint URL - sqs_url: str | None = dc_field( + sqs_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_url") ) @@ -8437,26 +9580,44 @@ class CheckSQSResponse(DataClassJsonMixin): # Validation result. One of: ok, error status: str = dc_field(metadata=dc_config(field_name="status")) # Error text - error: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + error: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="error") + ) # Error data - data: dict[str, object] | None = dc_field( + 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: float | None = dc_field( + confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - matched_contributors: list[str] | None = dc_field( + matched_contributors: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="matched_contributors") ) - subclassifications: "list[Classification] | None" = dc_field( + subclassifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="subclassifications") ) @@ -8464,53 +9625,61 @@ class Classification(DataClassJsonMixin): @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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: datetime | None = dc_field( + previously_connected_timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="previously_connected_timestamp", @@ -8520,35 +9689,43 @@ class ClientEvent(DataClassJsonMixin): ), ) # Total in-stage retries the client made before resolving (0–1000). Required on completed join events. - retry_count_attempt: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + screen_share_status: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="screen_share_status") ) # Version of the client SDK - sdk_version: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="sfu_id")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="stage")) + 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: str | None = dc_field( + stage_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stage_id") ) # UTC timestamp at which the event was recorded - timestamp: datetime | None = dc_field( + timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="timestamp", @@ -8558,32 +9735,32 @@ class ClientEvent(DataClassJsonMixin): ), ) # Identifier of the media track the frame belongs to. Required on FirstVideoFrame; optional on FirstAudioFrame. - track_id: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # User agent string of the client SDK - user_agent: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + was_previously_connected: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="was_previously_connected") ) @dataclass class ClientOSDataResponse(DataClassJsonMixin): - architecture: str | None = dc_field( + architecture: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="architecture") ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - version: str | None = dc_field( + 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") ) @@ -8611,19 +9788,19 @@ class ClosedCaptionEvent(DataClassJsonMixin): @dataclass class ClosedCaptionRuleParameters(DataClassJsonMixin): - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) - llm_harm_labels: "dict[str, str] | None" = dc_field( + llm_harm_labels: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="llm_harm_labels") ) @@ -8633,11 +9810,13 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - user_session_id: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -8653,11 +9832,11 @@ 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")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # ID of the user who owns this collection - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @@ -8669,7 +9848,7 @@ class CollectionResponse(DataClassJsonMixin): # Name/type of the collection name: str = dc_field(metadata=dc_config(field_name="name")) # When the collection was created - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -8679,7 +9858,7 @@ class CollectionResponse(DataClassJsonMixin): ), ) # When the collection was last updated - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -8689,15 +9868,23 @@ class CollectionResponse(DataClassJsonMixin): ), ) # ID of the user who owns this collection - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the collection - custom: dict[str, object] | None = dc_field( + 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 @@ -8709,7 +9896,7 @@ class Command(DataClassJsonMixin): # Set name used for grouping commands set: str = dc_field(metadata=dc_config(field_name="set")) # Date/time of creation - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -8719,7 +9906,7 @@ class Command(DataClassJsonMixin): ), ) # Date/time of the last update - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -8744,15 +9931,16 @@ class CommentAddedEvent(DataClassJsonMixin): 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -8761,7 +9949,7 @@ class CommentAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8779,15 +9967,49 @@ class CommentDeletedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + 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", @@ -8796,11 +10018,61 @@ class CommentDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + 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 @@ -8815,7 +10087,7 @@ class CommentReactionAddedEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -8823,10 +10095,11 @@ class CommentReactionAddedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.comment.reaction.added", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -8835,7 +10108,7 @@ class CommentReactionAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8853,7 +10126,7 @@ class CommentReactionDeletedEvent(DataClassJsonMixin): ) 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -8861,10 +10134,11 @@ class CommentReactionDeletedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.comment.reaction.deleted", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -8889,7 +10163,7 @@ class CommentReactionUpdatedEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reaction: "FeedsReactionResponse" = dc_field( metadata=dc_config(field_name="reaction") ) @@ -8897,10 +10171,11 @@ class CommentReactionUpdatedEvent(DataClassJsonMixin): type: str = dc_field( default="feeds.comment.reaction.updated", metadata=dc_config(field_name="type") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -8909,7 +10184,7 @@ class CommentReactionUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -8932,6 +10207,8 @@ class CommentResponse(DataClassJsonMixin): ) # 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 @@ -8945,7 +10222,7 @@ class CommentResponse(DataClassJsonMixin): # 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: str = dc_field(metadata=dc_config(field_name="status")) + status: "CommentStatus" = dc_field(metadata=dc_config(field_name="status")) # When the comment was last updated updated_at: datetime = dc_field( metadata=dc_config( @@ -8958,21 +10235,21 @@ class CommentResponse(DataClassJsonMixin): # 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( + 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( + 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: float | None = dc_field( + controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) # When the comment was deleted - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -8982,7 +10259,7 @@ class CommentResponse(DataClassJsonMixin): ), ) # When the comment was last edited - edited_at: datetime | None = dc_field( + edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", @@ -8992,31 +10269,31 @@ class CommentResponse(DataClassJsonMixin): ), ) # ID of parent comment for nested replies - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Text content of the comment - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Attachments associated with the comment - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Recent reactions to the comment - latest_reactions: "list[FeedsReactionResponse] | None" = dc_field( + latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) # Custom data for the comment - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - i18n: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # Grouped reactions by type - reaction_groups: "dict[str, FeedsReactionGroupResponse] | None" = dc_field( + reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @@ -9034,15 +10311,16 @@ class CommentRestoredEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -9051,11 +10329,22 @@ class CommentRestoredEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + 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 @@ -9069,15 +10358,16 @@ class CommentUpdatedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -9086,16 +10376,11 @@ class CommentUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) -@dataclass -class CommitMessageRequest(DataClassJsonMixin): - pass - - @dataclass class CompositeRecordingResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) @@ -9113,65 +10398,66 @@ class ConcurrencyMinute(DataClassJsonMixin): @dataclass class ConfigOverridesRequest(DataClassJsonMixin): # Blocklist name - blocklist: str | None = dc_field( + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # Blocklist behavior. One of: flag, block - blocklist_behavior: str | None = dc_field( + blocklist_behavior: "Optional[BlocklistBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) # Enable/disable message counting - count_messages: bool | None = dc_field( + count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Maximum message length - max_message_length: int | None = dc_field( + max_message_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_message_length") ) - push_level: str | None = dc_field( + # 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: bool | None = dc_field( + quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) # Enable/disable reactions - reactions: bool | None = dc_field( + reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Enable/disable replies - replies: bool | None = dc_field( + replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Enable/disable shared locations - shared_locations: bool | None = dc_field( + shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) # Enable/disable typing events - typing_events: bool | None = dc_field( + typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Enable/disable uploads - uploads: bool | None = dc_field( + uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # Enable/disable URL enrichment - url_enrichment: bool | None = dc_field( + url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) # Enable/disable user message reminders - user_message_reminders: bool | None = dc_field( + user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # List of available commands - commands: list[str] | None = dc_field( + commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) # Permission grants modifiers - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @@ -9202,92 +10488,111 @@ class ConfigResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - supported_video_call_harm_types: list[str] = dc_field( + 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: "list[AIImageLabelDefinition] | None" = dc_field( + 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: "list[BodyguardProfileSummary] | None" = dc_field( + available_bodyguard_profiles: "Optional[List[BodyguardProfileSummary]]" = dc_field( default=None, metadata=dc_config(field_name="available_bodyguard_profiles") ) - ai_audio_config: "AIAudioConfigResponse | None" = dc_field( + ai_audio_config: "Optional[AIAudioConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="ai_audio_config") ) - ai_image_config: "AIImageConfig | None" = dc_field( + 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: "dict[str, list[str]] | None" = dc_field( + ai_image_subclassifications: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_subclassifications") ) - ai_text_config: "AITextConfig | None" = dc_field( + ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) - ai_video_config: "AIVideoConfigResponse | None" = dc_field( + ai_video_config: "Optional[AIVideoConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) - automod_platform_circumvention_config: "AutomodPlatformCircumventionConfig | None" = dc_field( + automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) - automod_semantic_filters_config: "AutomodSemanticFiltersConfig | None" = dc_field( - default=None, metadata=dc_config(field_name="automod_semantic_filters_config") + automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( + dc_field( + default=None, + metadata=dc_config(field_name="automod_semantic_filters_config"), + ) ) - automod_toxicity_config: "AutomodToxicityConfig | None" = dc_field( + automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) - block_list_config: "BlockListConfig | None" = dc_field( + block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) - flood_config: "FloodConfig | None" = dc_field( + 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") ) - llm_config: "LLMConfig | None" = dc_field( + 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: "VelocityFilterConfig | None" = dc_field( + velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) - video_call_rule_config: "VideoCallRuleConfig | None" = dc_field( + video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @dataclass class ContentCountRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + 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: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - property_key: str | None = dc_field( + property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class ContentCustomPropertyParameters(DataClassJsonMixin): - operator: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - property_key: str | None = dc_field( + property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @@ -9318,7 +10623,7 @@ 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")) + absent: "List[AbsentMetric]" = dc_field(metadata=dc_config(field_name="absent")) metrics_pct: "MetricsPct" = dc_field(metadata=dc_config(field_name="metrics_pct")) @@ -9327,27 +10632,27 @@ 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: bool | None = dc_field( + 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: bool | None = dc_field( + is_leet_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_leet_check_enabled") ) - is_plural_check_enabled: bool | None = dc_field( + is_plural_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_plural_check_enabled") ) - is_substring_matching_enabled: bool | None = dc_field( + is_substring_matching_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_substring_matching_enabled") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - # Block list type. One of: regex, domain, domain_allowlist, email, email_allowlist, word - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - user_id: str | None = dc_field( + 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -9357,7 +10662,7 @@ 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: "BlockListResponse | None" = dc_field( + blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @@ -9366,17 +10671,17 @@ class CreateBlockListResponse(DataClassJsonMixin): class CreateCallTypeRequest(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) # the external storage for the call type - external_storage: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) # the permissions granted to each role - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) - notification_settings: "NotificationSettingsRequest | None" = dc_field( + notification_settings: "Optional[NotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) - settings: "CallSettingsRequest | None" = dc_field( + settings: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @@ -9405,7 +10710,7 @@ class CreateCallTypeResponse(DataClassJsonMixin): ) ) # the permissions granted to each role - grants: "dict[str, list[str]]" = dc_field(metadata=dc_config(field_name="grants")) + 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") ) @@ -9413,7 +10718,7 @@ class CreateCallTypeResponse(DataClassJsonMixin): metadata=dc_config(field_name="settings") ) # the external storage for the call type - external_storage: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @@ -9426,45 +10731,45 @@ class CreateCampaignRequest(DataClassJsonMixin): metadata=dc_config(field_name="message_template") ) # Whether to create channels for the campaign, if they don't exist - create_channels: bool | None = dc_field( + create_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_channels") ) # The description of the campaign - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # The name of the campaign - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # The sender mode of the campaign - sender_mode: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + show_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_channels") ) # Whether to skip push notifications - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) # Whether to skip webhooks - skip_webhook: bool | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_ids") ) - channel_template: "CampaignChannelTemplate | None" = dc_field( + channel_template: "Optional[CampaignChannelTemplate]" = dc_field( default=None, metadata=dc_config(field_name="channel_template") ) @@ -9473,10 +10778,10 @@ class CreateCampaignRequest(DataClassJsonMixin): class CreateCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - campaign: "CampaignResponse | None" = dc_field( + campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) - users: "PagerResponse | None" = dc_field( + users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @@ -9484,9 +10789,11 @@ class CreateCampaignResponse(DataClassJsonMixin): @dataclass class CreateChannelTypeRequest(DataClassJsonMixin): # Automod. One of: disabled, simple, AI - automod: str = dc_field(metadata=dc_config(field_name="automod")) + automod: "AutomodMode" = dc_field(metadata=dc_config(field_name="automod")) # Automod behavior. One of: flag, block - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + 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") @@ -9494,120 +10801,140 @@ class CreateChannelTypeRequest(DataClassJsonMixin): # Channel type name name: str = dc_field(metadata=dc_config(field_name="name")) # Blocklist - blocklist: str | None = dc_field( + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) # Blocklist behavior. One of: flag, block, shadow_block - blocklist_behavior: str | None = dc_field( + blocklist_behavior: "Optional[ChannelModerationBehavior]" = dc_field( default=None, metadata=dc_config(field_name="blocklist_behavior") ) # Connect events - connect_events: bool | None = dc_field( + connect_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="connect_events") ) # Count messages in channel. - count_messages: bool | None = dc_field( + count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) # Custom events - custom_events: bool | None = dc_field( + custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_events") ) - delivery_events: bool | None = dc_field( + delivery_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delivery_events") ) # Mark messages pending - mark_messages_pending: bool | None = dc_field( + 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: str | None = dc_field( + message_retention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="message_retention") ) # Mutes - mutes: bool | None = dc_field(default=None, metadata=dc_config(field_name="mutes")) + mutes: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="mutes") + ) # Partition size - partition_size: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) # Partition TTL - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) # Polls - polls: bool | None = dc_field(default=None, metadata=dc_config(field_name="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: str | None = dc_field( + push_level: "Optional[PushLevel]" = dc_field( default=None, metadata=dc_config(field_name="push_level") ) # Push notifications - push_notifications: bool | None = dc_field( + 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: bool | None = dc_field( + reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # Read events - read_events: bool | None = dc_field( + 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: bool | None = dc_field( + replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) # Search - search: bool | None = dc_field( + search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="search") ) # Enables shared location messages - shared_locations: bool | None = dc_field( + shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) - skip_last_msg_update_for_system_msgs: bool | None = dc_field( + 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: bool | None = dc_field( + typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) # Uploads - uploads: bool | None = dc_field( + uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) # URL enrichment - url_enrichment: bool | None = dc_field( + url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) - user_message_reminders: bool | None = dc_field( + user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) # Blocklists - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # List of commands that channel supports - commands: list[str] | None = dc_field( + commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) # List of permissions for the channel type - permissions: "list[PolicyRequest] | None" = dc_field( + permissions: "Optional[List[PolicyRequest]]" = dc_field( default=None, metadata=dc_config(field_name="permissions") ) - chat_preferences: "ChatPreferences | None" = dc_field( + # 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: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class CreateChannelTypeResponse(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -9620,6 +10947,7 @@ class CreateChannelTypeResponse(DataClassJsonMixin): ) 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") @@ -9660,37 +10988,39 @@ class CreateChannelTypeResponse(DataClassJsonMixin): 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( + 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: str | None = dc_field( + 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") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @@ -9698,14 +11028,14 @@ class CreateChannelTypeResponse(DataClassJsonMixin): @dataclass class CreateCollectionsRequest(DataClassJsonMixin): # List of collections to create - collections: "list[CollectionRequest]" = dc_field( + collections: "List[CollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -9714,7 +11044,7 @@ class CreateCollectionsRequest(DataClassJsonMixin): class CreateCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of created collections - collections: "list[CollectionResponse]" = dc_field( + collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @@ -9726,16 +11056,16 @@ class CreateCommandRequest(DataClassJsonMixin): # Unique command name name: str = dc_field(metadata=dc_config(field_name="name")) # Arguments help text, shown in commands auto-completion - args: str | None = dc_field(default=None, metadata=dc_config(field_name="args")) + args: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="args")) # Set name used for grouping commands - set: str | None = dc_field(default=None, metadata=dc_config(field_name="set")) + 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: "Command | None" = dc_field( + command: "Optional[Command]" = dc_field( default=None, metadata=dc_config(field_name="command") ) @@ -9745,25 +11075,27 @@ class CreateDeviceRequest(DataClassJsonMixin): # Device ID id: str = dc_field(metadata=dc_config(field_name="id")) # Push provider - push_provider: str = dc_field(metadata=dc_config(field_name="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: str | None = dc_field( + hardware_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="hardware_id") ) # Push provider name - push_provider_name: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + voip_token: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="voip_token") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -9776,17 +11108,17 @@ class CreateExternalStorageRequest(DataClassJsonMixin): 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: str | None = dc_field( + gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) # The path prefix to use for storing files - path: str | None = dc_field(default=None, metadata=dc_config(field_name="path")) + path: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="path")) # Config for creating Amazon S3 storage. - aws_s3: "S3Request | None" = dc_field( + aws_s3: "Optional[S3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) # Config for creating Azure Blob Storage storage - azure_blob: "AzureRequest | None" = dc_field( + azure_blob: "Optional[AzureRequest]" = dc_field( default=None, metadata=dc_config(field_name="azure_blob") ) @@ -9802,47 +11134,47 @@ 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: str | None = dc_field( + 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: str | None = dc_field( + default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors - activity_processors: "list[ActivityProcessorConfig] | None" = dc_field( + activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors - activity_selectors: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - activity_filter: "ActivityFilterConfig | None" = dc_field( + activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) - activity_marks: "ActivityMarksConfig | None" = dc_field( + activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) - activity_processing: "ActivityProcessingConfig | None" = dc_field( + activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - notification: "NotificationConfig | None" = dc_field( + notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) - push_notification: "PushNotificationConfig | None" = dc_field( + push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) - stories: "StoriesConfig | None" = dc_field( + stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @@ -9860,13 +11192,13 @@ 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: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @@ -9880,13 +11212,13 @@ class CreateFeedViewResponse(DataClassJsonMixin): @dataclass class CreateFeedsBatchRequest(DataClassJsonMixin): # List of feeds to create - feeds: "list[FeedRequest]" = dc_field(metadata=dc_config(field_name="feeds")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @@ -9895,7 +11227,7 @@ class CreateFeedsBatchRequest(DataClassJsonMixin): 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")) + feeds: "List[FeedResponse]" = dc_field(metadata=dc_config(field_name="feeds")) @dataclass @@ -9918,7 +11250,7 @@ class CreateGuestResponse(DataClassJsonMixin): 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: bool | None = dc_field( + merge_custom: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="merge_custom") ) @@ -9927,14 +11259,14 @@ class CreateImportRequest(DataClassJsonMixin): class CreateImportResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - import_task: "ImportTask | None" = dc_field( + import_task: "Optional[ImportTask]" = dc_field( default=None, metadata=dc_config(field_name="import_task") ) @dataclass class CreateImportURLRequest(DataClassJsonMixin): - filename: str | None = dc_field( + filename: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="filename") ) @@ -9953,11 +11285,11 @@ class CreateImportV2TaskRequest(DataClassJsonMixin): settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -9998,19 +11330,19 @@ class CreateMembershipLevelRequest(DataClassJsonMixin): # Display name for the membership level name: str = dc_field(metadata=dc_config(field_name="name")) # Optional description of the membership level - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Priority level (higher numbers = higher priority) - priority: int | None = dc_field( + priority: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Activity tags this membership level gives access to - tags: list[str] | None = dc_field( + tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="tags") ) # Custom data for the membership level - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -10032,15 +11364,17 @@ class CreatePermissionRequest(DataClassJsonMixin): # 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")) + condition: Dict[str, object] = dc_field(metadata=dc_config(field_name="condition")) # Description of the permission - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether this permission applies to resource owner or not - owner: bool | None = dc_field(default=None, metadata=dc_config(field_name="owner")) + 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: bool | None = dc_field( + same_team: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="same_team") ) @@ -10050,18 +11384,18 @@ 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="mode")) + mode: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mode")) # Team scope for the config (optional) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Messages to test; capped at 1000. Mutually exclusive with seed - rows: "list[PolicyTestRow] | None" = dc_field( + rows: "Optional[List[PolicyTestRow]]" = dc_field( default=None, metadata=dc_config(field_name="rows") ) - seed: "PolicyTestSeedSpec | None" = dc_field( + seed: "Optional[PolicyTestSeedSpec]" = dc_field( default=None, metadata=dc_config(field_name="seed") ) @@ -10070,15 +11404,23 @@ class CreatePolicyTestSetRequest(DataClassJsonMixin): class CreatePollOptionRequest(DataClassJsonMixin): # Option text text: str = dc_field(metadata=dc_config(field_name="text")) - user_id: str | None = dc_field( + # 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10088,44 +11430,54 @@ 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: bool | None = dc_field( + allow_answers: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_answers") ) - allow_user_suggested_options: bool | None = dc_field( + 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: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Indicates whether users can cast multiple votes - enforce_unique_vote: bool | None = dc_field( + enforce_unique_vote: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_vote") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Indicates whether the poll is open for voting - is_closed: bool | None = dc_field( + 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: int | None = dc_field( + max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) - user_id: str | None = dc_field( + 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") ) - voting_visibility: str | None = dc_field( + # Represents the visibility of votes in a poll. + voting_visibility: "Optional[VotingVisibility]" = dc_field( default=None, metadata=dc_config(field_name="voting_visibility") ) - options: "list[PollOptionInput] | None" = dc_field( + options: "Optional[List[PollOptionInput]]" = dc_field( default=None, metadata=dc_config(field_name="options") ) # Custom data for this object - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10137,12 +11489,12 @@ class CreatePredefinedFilterRequest(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")) + filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # The description of the predefined filter - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - sort: "list[dict[str, object]] | None" = dc_field( + sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @@ -10151,7 +11503,7 @@ class CreatePredefinedFilterRequest(DataClassJsonMixin): class CreatePredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - predefined_filter: "PredefinedFilterResponse | None" = dc_field( + predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @@ -10160,27 +11512,36 @@ class CreatePredefinedFilterResponse(DataClassJsonMixin): class CreateQueueRequest(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) type: str = dc_field(metadata=dc_config(field_name="type")) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - sort: "list[dict[str, object]] | None" = dc_field( + sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) - filters: dict[str, object] | None = dc_field( + filters: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filters") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class CreateReminderRequest(DataClassJsonMixin): - remind_at: datetime | None = dc_field( + 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", @@ -10189,11 +11550,11 @@ class CreateReminderRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10225,13 +11586,13 @@ 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")) + numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) # Optional password for SIP trunk authentication - password: str | None = dc_field( + 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: list[str] | None = dc_field( + allowed_ips: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_ips") ) @@ -10240,7 +11601,7 @@ class CreateSIPTrunkRequest(DataClassJsonMixin): class CreateSIPTrunkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP trunk information - sip_trunk: "SIPTrunkResponse | None" = dc_field( + sip_trunk: "Optional[SIPTrunkResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_trunk") ) @@ -10250,23 +11611,23 @@ 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: bool | None = dc_field( + 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: bool | None = dc_field( + all_users: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="all_users") ) # The description of the segment (max 256 characters) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The ID of the segment - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # The name of the segment (max 128 characters) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -10275,7 +11636,7 @@ class CreateSegmentRequest(DataClassJsonMixin): class CreateSegmentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - segment: "SegmentResponse | None" = dc_field( + segment: "Optional[SegmentResponse]" = dc_field( default=None, metadata=dc_config(field_name="segment") ) @@ -10285,17 +11646,17 @@ 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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: str | None = dc_field( + 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: list[str] | None = dc_field( + member_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_ids") ) @@ -10303,7 +11664,7 @@ class CreateUserGroupRequest(DataClassJsonMixin): @dataclass class CreateUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - user_group: "UserGroupResponse | None" = dc_field( + user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -10311,9 +11672,9 @@ class CreateUserGroupResponse(DataClassJsonMixin): @dataclass class CustomActionRequestPayload(DataClassJsonMixin): # Custom action identifier - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Custom action options - options: dict[str, object] | None = dc_field( + options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @@ -10323,13 +11684,15 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) # Labels from various moderation sources - labels: list[str] | None = dc_field( + labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) # Additional metadata for the flag - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -10341,20 +11704,20 @@ class CustomCheckRequest(DataClassJsonMixin): # 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")) + 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: str | None = dc_field( + entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Content payload for moderation - moderation_payload: "ModerationPayloadRequest | None" = dc_field( + moderation_payload: "Optional[ModerationPayloadRequest]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10366,7 +11729,7 @@ class CustomCheckResponse(DataClassJsonMixin): 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: "ReviewQueueItemResponse | None" = dc_field( + item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @@ -10381,9 +11744,9 @@ class CustomEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -10406,7 +11769,7 @@ class CustomVideoEvent(DataClassJsonMixin): ) ) # Custom data for this object - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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 @@ -10459,13 +11822,13 @@ class DailyDigestCallSessionSummary(DataClassJsonMixin): counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) - digest_error: str | None = dc_field( + digest_error: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="digest_error") ) - session_ended_at: str | None = dc_field( + session_ended_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="session_ended_at") ) - session_started_at: str | None = dc_field( + session_started_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="session_started_at") ) @@ -10483,7 +11846,7 @@ 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( + daily: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @@ -10503,23 +11866,23 @@ class Data(DataClassJsonMixin): @dataclass class DataDogInfo(DataClassJsonMixin): - api_key: str | None = dc_field( + api_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="api_key") ) - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - site: str | None = dc_field(default=None, metadata=dc_config(field_name="site")) + 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: str | None = dc_field( + 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: bool | None = dc_field( + mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) @@ -10529,7 +11892,7 @@ class DeactivateUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10537,16 +11900,16 @@ class DeactivateUserResponse(DataClassJsonMixin): @dataclass class DeactivateUsersRequest(DataClassJsonMixin): # User IDs to deactivate - user_ids: list[str] = dc_field(metadata=dc_config(field_name="user_ids")) + user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) # ID of the user who deactivated the users - created_by_id: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) - mark_channels_deleted: bool | None = dc_field( + 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: bool | None = dc_field( + mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) @@ -10561,19 +11924,27 @@ class DeactivateUsersResponse(DataClassJsonMixin): @dataclass class DecayFunctionConfig(DataClassJsonMixin): # Base value for decay function - base: str | None = dc_field(default=None, metadata=dc_config(field_name="base")) + base: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="base")) # Decay rate - decay: str | None = dc_field(default=None, metadata=dc_config(field_name="decay")) + decay: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="decay") + ) # Direction of decay - direction: str | None = dc_field( + direction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="direction") ) # Offset value for decay function - offset: str | None = dc_field(default=None, metadata=dc_config(field_name="offset")) + offset: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="offset") + ) # Origin value for decay function - origin: str | None = dc_field(default=None, metadata=dc_config(field_name="origin")) + origin: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="origin") + ) # Scale factor for decay function - scale: str | None = dc_field(default=None, metadata=dc_config(field_name="scale")) + scale: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="scale") + ) @dataclass @@ -10586,20 +11957,20 @@ class DeleteActionConfigResponse(DataClassJsonMixin): @dataclass class DeleteActivitiesRequest(DataClassJsonMixin): # List of activity IDs to delete - ids: list[str] = dc_field(metadata=dc_config(field_name="ids")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10608,7 +11979,7 @@ class DeleteActivitiesRequest(DataClassJsonMixin): 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")) + deleted_ids: List[str] = dc_field(metadata=dc_config(field_name="deleted_ids")) @dataclass @@ -10623,19 +11994,21 @@ class DeleteActivityReactionResponse(DataClassJsonMixin): @dataclass class DeleteActivityRequestPayload(DataClassJsonMixin): # ID of the activity to delete (alternative to item_id) - entity_id: str | None = dc_field( + 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: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the activity - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -10657,7 +12030,7 @@ class DeleteBookmarkResponse(DataClassJsonMixin): @dataclass class DeleteCallRequest(DataClassJsonMixin): # if true the call will be hard deleted along with all related data - hard: bool | None = dc_field(default=None, metadata=dc_config(field_name="hard")) + hard: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="hard")) @dataclass @@ -10665,7 +12038,7 @@ 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: str | None = dc_field( + task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) @@ -10681,7 +12054,7 @@ class DeleteChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @@ -10689,13 +12062,13 @@ class DeleteChannelResponse(DataClassJsonMixin): @dataclass class DeleteChannelsRequest(DataClassJsonMixin): # All channels that should be deleted - cids: list[str] = dc_field(metadata=dc_config(field_name="cids")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_truncate: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_truncate") ) @@ -10704,11 +12077,11 @@ class DeleteChannelsRequest(DataClassJsonMixin): class DeleteChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - task_id: str | None = dc_field( + task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) # Map of channel IDs and their deletion results - result: "dict[str, DeleteChannelsResultResponse | None] | None" = dc_field( + result: "Optional[Dict[str, Optional[DeleteChannelsResultResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="result") ) @@ -10716,7 +12089,9 @@ class DeleteChannelsResponse(DataClassJsonMixin): @dataclass class DeleteChannelsResultResponse(DataClassJsonMixin): status: str = dc_field(metadata=dc_config(field_name="status")) - error: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + error: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="error") + ) @dataclass @@ -10749,19 +12124,21 @@ class DeleteCommentReactionResponse(DataClassJsonMixin): @dataclass class DeleteCommentRequestPayload(DataClassJsonMixin): # ID of the comment to delete (alternative to item_id) - entity_id: str | None = dc_field( + entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the comment - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -10793,7 +12170,7 @@ class DeleteFeedResponse(DataClassJsonMixin): @dataclass class DeleteFeedUserDataRequest(DataClassJsonMixin): # Whether to perform a hard delete instead of a soft delete - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) @@ -10813,13 +12190,13 @@ class DeleteFeedViewResponse(DataClassJsonMixin): @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")) + feeds: List[str] = dc_field(metadata=dc_config(field_name="feeds")) # Whether to permanently delete the feeds instead of soft delete - hard_delete: bool | None = dc_field( + 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: bool | None = dc_field( + purge_user_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="purge_user_activities") ) @@ -10831,6 +12208,31 @@ class DeleteFeedsBatchResponse(DataClassJsonMixin): 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 @@ -10840,19 +12242,21 @@ class DeleteImportV2TaskResponse(DataClassJsonMixin): @dataclass class DeleteMessageRequestPayload(DataClassJsonMixin): # ID of the message to delete (alternative to item_id) - entity_id: str | None = dc_field( + entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the message - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -10863,6 +12267,15 @@ class DeleteMessageResponse(DataClassJsonMixin): 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")) @@ -10879,13 +12292,41 @@ 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -10893,19 +12334,21 @@ class DeleteQueueRequest(DataClassJsonMixin): @dataclass class DeleteReactionRequestPayload(DataClassJsonMixin): # ID of the reaction to delete (alternative to item_id) - entity_id: str | None = dc_field( + entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the reaction - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Reason for deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -10931,7 +12374,11 @@ class DeleteReminderResponse(DataClassJsonMixin): @dataclass class DeleteRetentionPolicyRequest(DataClassJsonMixin): - policy: str = dc_field(metadata=dc_config(field_name="policy")) + # 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 @@ -10950,10 +12397,20 @@ 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")) + target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) @dataclass @@ -10962,101 +12419,121 @@ class DeleteTranscriptionResponse(DataClassJsonMixin): 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: str = dc_field(metadata=dc_config(field_name="delete_messages")) + 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: str | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Reason for the deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + 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: bool | None = dc_field( + delete_conversation_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delete_conversation_channels") ) # Delete flagged feeds content - delete_feeds_content: bool | None = dc_field( + 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: str | None = dc_field( + entity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_id") ) # Type of the entity - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) # Whether to permanently delete the user - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) # Also delete all user messages - mark_messages_deleted: bool | None = dc_field( + mark_messages_deleted: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_deleted") ) # Reason for deletion - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + 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")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="calls")) + 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 + # * 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) - conversations: str | None = dc_field( + # * 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="files")) + 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: str | None = dc_field( + messages: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="messages") ) - new_call_owner_id: str | None = dc_field( + new_call_owner_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_call_owner_id") ) - new_channel_owner_id: str | None = dc_field( + 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 conversations as well - user: str | None = dc_field(default=None, metadata=dc_config(field_name="user")) + # * 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 @@ -11069,8 +12546,8 @@ class DeleteUsersResponse(DataClassJsonMixin): @dataclass class DeliveredMessagePayload(DataClassJsonMixin): - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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 @@ -11083,28 +12560,38 @@ 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: float | None = dc_field( + avg_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_quality_score") ) - p5_quality_score: float | None = dc_field( + p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) - poor_pct: float | None = dc_field( + poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) - share_pct: float | None = dc_field( + share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="share_pct") ) - watch_share_pct: float | None = dc_field( + watch_share_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="watch_share_pct") ) @dataclass -class DeviceDataResponse(DataClassJsonMixin): - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - version: str | None = dc_field( - default=None, metadata=dc_config(field_name="version") +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") ) @@ -11117,7 +12604,7 @@ class DeviceErrorInfo(DataClassJsonMixin): @dataclass class DeviceResponse(DataClassJsonMixin): - # Date/time of creation + # The date when the device was created. created_at: datetime = dc_field( metadata=dc_config( field_name="created_at", @@ -11126,30 +12613,32 @@ class DeviceResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - # Device ID + # The device identifier. id: str = dc_field(metadata=dc_config(field_name="id")) # Push provider - push_provider: str = dc_field(metadata=dc_config(field_name="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: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) # Reason explaining why device had been disabled - disabled_reason: str | None = dc_field( + 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: str | None = dc_field( + hardware_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="hardware_id") ) # Push provider name - push_provider_name: str | None = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="voip")) + voip: Optional[bool] = dc_field(default=None, metadata=dc_config(field_name="voip")) @dataclass @@ -11158,38 +12647,38 @@ class DraftPayloadResponse(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Contains HTML markup of the message - html: str | None = dc_field(default=None, metadata=dc_config(field_name="html")) + html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) # MML content of the message - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) + mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) - parent_id: str | None = dc_field( + 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: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + 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: bool | None = dc_field( + show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # Whether message is silent or not - silent: bool | None = dc_field( + silent: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="silent") ) # Contains type of the message. One of: regular, system - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # Array of message attachments - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # List of mentioned users - mentioned_users: "list[UserResponse] | None" = dc_field( + mentioned_users: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_users") ) @@ -11207,19 +12696,19 @@ class DraftResponse(DataClassJsonMixin): ) # Contains the draft message content message: "DraftPayloadResponse" = dc_field(metadata=dc_config(field_name="message")) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - parent_message: "MessageResponse | None" = dc_field( + parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) # Represents any chat message - quoted_message: "MessageResponse | None" = dc_field( + quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) @@ -11227,15 +12716,15 @@ class DraftResponse(DataClassJsonMixin): @dataclass class EMAUStatsResponse(DataClassJsonMixin): # Per-day unique engaged user counts - daily: "list[DailyMetricResponse]" = dc_field( + 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( + 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( + month_to_date: "List[DailyMetricResponse]" = dc_field( metadata=dc_config(field_name="month_to_date") ) @@ -11273,10 +12762,10 @@ class EgressRTMPResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - stream_key: str | None = dc_field( + stream_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_key") ) - stream_url: str | None = dc_field( + stream_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_url") ) @@ -11284,20 +12773,20 @@ class EgressRTMPResponse(DataClassJsonMixin): @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: "CompositeRecordingResponse | None" = dc_field( + 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: "FrameRecordingResponse | None" = dc_field( + frame_recording: "Optional[FrameRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="frame_recording") ) - hls: "EgressHLSResponse | None" = dc_field( + hls: "Optional[EgressHLSResponse]" = dc_field( default=None, metadata=dc_config(field_name="hls") ) - individual_recording: "IndividualRecordingResponse | None" = dc_field( + individual_recording: "Optional[IndividualRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="individual_recording") ) - raw_recording: "RawRecordingResponse | None" = dc_field( + raw_recording: "Optional[RawRecordingResponse]" = dc_field( default=None, metadata=dc_config(field_name="raw_recording") ) @@ -11308,39 +12797,41 @@ class EncodingProfile(DataClassJsonMixin): 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( + 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( + quality_limitation_samples: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="quality_limitation_samples") ) - avg_send_kbps: int | None = dc_field( + avg_send_kbps: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="avg_send_kbps") ) - codec: str | None = dc_field(default=None, metadata=dc_config(field_name="codec")) - encoder_impl: str | None = dc_field( + 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: int | None = dc_field( + fps_p10: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fps_p10") ) - fps_p50: int | None = dc_field( + fps_p50: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fps_p50") ) - hardware_encode: bool | None = dc_field( + hardware_encode: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hardware_encode") ) - ladder_type: str | None = dc_field( + ladder_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="ladder_type") ) - power_efficient: bool | None = dc_field( + power_efficient: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="power_efficient") ) - resolution: str | None = dc_field( + resolution: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="resolution") ) - simulcast_layers: int | None = dc_field( + simulcast_layers: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="simulcast_layers") ) @@ -11348,18 +12839,15 @@ class EncodingProfile(DataClassJsonMixin): @dataclass class EncryptionSettingsRequest(DataClassJsonMixin): # Encryption mode. One of: available, disabled, auto-on - mode: str | None = dc_field(default=None, metadata=dc_config(field_name="mode")) + 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: str = dc_field(metadata=dc_config(field_name="mode")) - - -@dataclass -class EndCallRequest(DataClassJsonMixin): - pass + mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) @dataclass @@ -11370,32 +12858,37 @@ class EndCallResponse(DataClassJsonMixin): @dataclass class EnrichedActivity(DataClassJsonMixin): - foreign_id: str | None = dc_field( + foreign_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="foreign_id") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - score: float | None = dc_field(default=None, metadata=dc_config(field_name="score")) - verb: str | None = dc_field(default=None, metadata=dc_config(field_name="verb")) - to: list[str] | None = dc_field(default=None, metadata=dc_config(field_name="to")) - actor: "Data | None" = dc_field( + 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: "dict[str, list[EnrichedReaction]] | None" = dc_field( + latest_reactions: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) - object: "Data | None" = dc_field( + object: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="object") ) - origin: "Data | None" = dc_field( + origin: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="origin") ) - own_reactions: "dict[str, list[EnrichedReaction]] | None" = dc_field( + own_reactions: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_reactions") ) - reaction_counts: "dict[str, int] | None" = dc_field( + reaction_counts: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_counts") ) - target: "Data | None" = dc_field( + target: "Optional[Data]" = dc_field( default=None, metadata=dc_config(field_name="target") ) @@ -11407,9 +12900,9 @@ class EnrichedCollectionResponse(DataClassJsonMixin): # 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: str = dc_field(metadata=dc_config(field_name="status")) + status: "CollectionStatus" = dc_field(metadata=dc_config(field_name="status")) # When the collection was created - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -11419,7 +12912,7 @@ class EnrichedCollectionResponse(DataClassJsonMixin): ), ) # When the collection was last updated - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -11429,11 +12922,11 @@ class EnrichedCollectionResponse(DataClassJsonMixin): ), ) # ID of the user who owns this collection - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the collection - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -11443,112 +12936,124 @@ 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")) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - parent: str | None = dc_field(default=None, metadata=dc_config(field_name="parent")) - target_feeds: list[str] | None = dc_field( + 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: "dict[str, int] | None" = dc_field( + children_counts: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="children_counts") ) - created_at: "Time | None" = dc_field( - default=None, metadata=dc_config(field_name="created_at") - ) - data: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) - latest_children: "dict[str, list[EnrichedReaction]] | None" = dc_field( + latest_children: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_children") ) - own_children: "dict[str, list[EnrichedReaction]] | None" = dc_field( + own_children: "Optional[Dict[str, List[EnrichedReaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_children") ) - updated_at: "Time | None" = dc_field( - default=None, metadata=dc_config(field_name="updated_at") + user: "Optional[Data]" = dc_field( + default=None, metadata=dc_config(field_name="user") ) - user: "Data | None" = 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_pins: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_pins") ) @@ -11586,15 +13091,15 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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: int | None = dc_field( + 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: datetime | None = dc_field( + ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", @@ -11603,10 +13108,10 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - bypass_moderation: bool | None = dc_field( + bypass_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="bypass_moderation") ) - deactivated_at: datetime | None = dc_field( + deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", @@ -11615,7 +13120,7 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -11624,8 +13129,10 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - last_active: datetime | None = dc_field( + 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", @@ -11634,8 +13141,8 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - revoke_tokens_issued_before: datetime | None = dc_field( + 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", @@ -11644,16 +13151,17 @@ class EntityCreatorResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - devices: "list[DeviceResponse] | None" = dc_field( + devices: "Optional[List[DeviceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="devices") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - push_notifications: "PushNotificationSettingsResponse | None" = dc_field( + push_notifications: "Optional[PushNotificationSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -11662,10 +13170,10 @@ class EntityCreatorResponse(DataClassJsonMixin): class ErrorResult(DataClassJsonMixin): description: str = dc_field(metadata=dc_config(field_name="description")) type: str = dc_field(metadata=dc_config(field_name="type")) - stacktrace: str | None = dc_field( + stacktrace: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stacktrace") ) - version: str | None = dc_field( + version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @@ -11673,27 +13181,35 @@ class ErrorResult(DataClassJsonMixin): @dataclass class EscalatePayload(DataClassJsonMixin): # Additional context for the reviewer - notes: str | None = dc_field(default=None, metadata=dc_config(field_name="notes")) + notes: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="notes") + ) # Priority of the escalation (low, medium, high) - priority: str | None = dc_field( + priority: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Reason for the escalation (from configured escalation_reasons) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass class EscalationMetadata(DataClassJsonMixin): - notes: str | None = dc_field(default=None, metadata=dc_config(field_name="notes")) - priority: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass class EventHook(DataClassJsonMixin): - created_at: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -11702,63 +13218,80 @@ class EventHook(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - hook_type: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - product: str | None = dc_field( + 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: bool | None = dc_field( + should_send_custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="should_send_custom_events") ) - sns_auth_type: str | None = dc_field( + sns_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_auth_type") ) - sns_event_based_message_group_id_enabled: bool | None = dc_field( + 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: str | None = dc_field( + sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) - sns_region: str | None = dc_field( + sns_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_region") ) - sns_role_arn: str | None = dc_field( + sns_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_role_arn") ) - sns_secret: str | None = dc_field( + sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) - sns_topic_arn: str | None = dc_field( + sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) - sqs_auth_type: str | None = dc_field( + sqs_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_auth_type") ) - sqs_key: str | None = dc_field( + 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: str | None = dc_field( + sqs_queue_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_queue_url") ) - sqs_region: str | None = dc_field( + sqs_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_region") ) - sqs_role_arn: str | None = dc_field( + sqs_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_role_arn") ) - sqs_secret: str | None = dc_field( + sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) - timeout_ms: int | None = dc_field( + timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout_ms") ) - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -11767,16 +13300,16 @@ class EventHook(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - webhook_url: str | None = dc_field( + webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webhook_url") ) - event_types: list[str] | None = dc_field( + event_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="event_types") ) - callback: "AsyncModerationCallbackConfig | None" = dc_field( + callback: "Optional[AsyncModerationCallbackConfig]" = dc_field( default=None, metadata=dc_config(field_name="callback") ) - failover_config: "WebhookFailoverConfig | None" = dc_field( + failover_config: "Optional[WebhookFailoverConfig]" = dc_field( default=None, metadata=dc_config(field_name="failover_config") ) @@ -11790,13 +13323,13 @@ class EventNotificationSettings(DataClassJsonMixin): @dataclass class EventNotificationSettingsRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - apns: "APNSPayload | None" = dc_field( + apns: "Optional[APNSPayload]" = dc_field( default=None, metadata=dc_config(field_name="apns") ) - fcm: "FCMPayload | None" = dc_field( + fcm: "Optional[FCMPayload]" = dc_field( default=None, metadata=dc_config(field_name="fcm") ) @@ -11811,17 +13344,17 @@ class EventNotificationSettingsResponse(DataClassJsonMixin): @dataclass class EventRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -11837,32 +13370,34 @@ class EventResponse(DataClassJsonMixin): @dataclass class ExportChannelsRequest(DataClassJsonMixin): # Export options for channels - channels: "list[ChannelExport]" = dc_field( + channels: "List[ChannelExport]" = dc_field( metadata=dc_config(field_name="channels") ) # Set if deleted message text should be cleared - clear_deleted_message_text: bool | None = dc_field( + clear_deleted_message_text: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="clear_deleted_message_text") ) - export_users: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="format")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + include_truncated_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_truncated_messages") ) # Export version - version: str | None = dc_field( + 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: list[str] | None = dc_field( + include_fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="include_fields") ) @@ -11876,12 +13411,62 @@ class ExportChannelsResponse(DataClassJsonMixin): @dataclass -class ExportFeedUserDataRequest(DataClassJsonMixin): - pass +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 ExportFeedUserDataResponse(DataClassJsonMixin): +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")) @@ -11892,22 +13477,22 @@ class ExportUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of exported messages - messages: "list[MessageResponse] | None" = dc_field( + messages: "Optional[List[MessageResponse]]" = dc_field( default=None, metadata=dc_config(field_name="messages") ) # List of exported reactions - reactions: "list[ReactionResponse] | None" = dc_field( + reactions: "Optional[List[ReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reactions") ) # User response object - user: "UserResponse | None" = dc_field( + 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")) + user_ids: List[str] = dc_field(metadata=dc_config(field_name="user_ids")) @dataclass @@ -11927,14 +13512,14 @@ class ExternalStorageResponse(DataClassJsonMixin): @dataclass class FCM(DataClassJsonMixin): - data: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @dataclass class FCMPayload(DataClassJsonMixin): - data: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @@ -11942,7 +13527,16 @@ class FCMPayload(DataClassJsonMixin): @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")) + 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 @@ -11957,20 +13551,21 @@ class FeedCreatedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - members: "list[FeedMemberResponse]" = dc_field( + members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -11993,15 +13588,16 @@ class FeedDeletedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12010,7 +13606,7 @@ class FeedDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12032,7 +13628,8 @@ class FeedGroup(DataClassJsonMixin): default_follower_role: str = dc_field( metadata=dc_config(field_name="default_follower_role") ) - default_visibility: str = dc_field( + # 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")) @@ -12044,14 +13641,14 @@ class FeedGroup(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - activity_processors: "list[ActivityProcessorConfig]" = dc_field( + activity_processors: "List[ActivityProcessorConfig]" = dc_field( metadata=dc_config(field_name="activity_processors") ) - activity_selectors: "list[ActivitySelectorConfig]" = dc_field( + 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: datetime | None = dc_field( + 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", @@ -12060,7 +13657,7 @@ class FeedGroup(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - last_feed_get_at: datetime | None = dc_field( + last_feed_get_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_feed_get_at", @@ -12069,22 +13666,22 @@ class FeedGroup(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - activity_filter: "ActivityFilterConfig | None" = dc_field( + activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) - notification: "NotificationConfig | None" = dc_field( + notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) - push_notification: "PushNotificationConfig | None" = dc_field( + push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) - stories: "StoriesConfig | None" = dc_field( + stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @@ -12101,15 +13698,16 @@ class FeedGroupChangedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12118,10 +13716,10 @@ class FeedGroupChangedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - feed_group: "FeedGroup | None" = dc_field( + feed_group: "Optional[FeedGroup]" = dc_field( default=None, metadata=dc_config(field_name="feed_group") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12140,15 +13738,16 @@ class FeedGroupDeletedEvent(DataClassJsonMixin): 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12182,14 +13781,14 @@ class FeedGroupResponse(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: str | None = dc_field( + 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: str | None = dc_field( + default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -12199,39 +13798,39 @@ class FeedGroupResponse(DataClassJsonMixin): ), ) # Configuration for activity processors - activity_processors: "list[ActivityProcessorConfig] | None" = dc_field( + activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors - activity_selectors: "list[ActivitySelectorConfigResponse] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfigResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - activity_filter: "ActivityFilterConfig | None" = dc_field( + activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) - activity_marks: "ActivityMarksConfig | None" = dc_field( + activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) - activity_processing: "ActivityProcessingConfig | None" = dc_field( + activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - notification: "NotificationConfig | None" = dc_field( + notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) - push_notification: "PushNotificationConfig | None" = dc_field( + push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) - stories: "StoriesConfig | None" = dc_field( + stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @@ -12250,15 +13849,16 @@ class FeedGroupRestoredEvent(DataClassJsonMixin): 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12272,34 +13872,35 @@ class FeedGroupRestoredEvent(DataClassJsonMixin): @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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="include") ) @dataclass class FeedInput(DataClassJsonMixin): - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - visibility: str | None = dc_field( + 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: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) - members: "list[FeedMemberRequest] | None" = dc_field( + members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -12316,16 +13917,17 @@ class FeedMemberAddedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12334,7 +13936,7 @@ class FeedMemberAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12352,15 +13954,16 @@ class FeedMemberRemovedEvent(DataClassJsonMixin): ) 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12369,7 +13972,7 @@ class FeedMemberRemovedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12379,17 +13982,17 @@ 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: bool | None = dc_field( + 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: str | None = dc_field( + membership_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="membership_level") ) # Role of the member in the feed - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) + role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # Custom data for the member - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -12408,7 +14011,7 @@ class FeedMemberResponse(DataClassJsonMixin): # 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: str = dc_field(metadata=dc_config(field_name="status")) + status: "FeedMemberStatus" = dc_field(metadata=dc_config(field_name="status")) # When the membership was last updated updated_at: datetime = dc_field( metadata=dc_config( @@ -12421,7 +14024,7 @@ class FeedMemberResponse(DataClassJsonMixin): # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) # When the invite was accepted - invite_accepted_at: datetime | None = dc_field( + invite_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_accepted_at", @@ -12431,7 +14034,7 @@ class FeedMemberResponse(DataClassJsonMixin): ), ) # When the invite was rejected - invite_rejected_at: datetime | None = dc_field( + invite_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="invite_rejected_at", @@ -12441,14 +14044,23 @@ class FeedMemberResponse(DataClassJsonMixin): ), ) # Custom data for the membership - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - membership_level: "MembershipLevelResponse | None" = dc_field( + 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 @@ -12461,16 +14073,17 @@ class FeedMemberUpdatedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12479,7 +14092,7 @@ class FeedMemberUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12530,18 +14143,18 @@ class FeedOwnCapability: @dataclass class FeedOwnData(DataClassJsonMixin): # Capabilities the current user has for this feed - own_capabilities: "list[FeedOwnCapability] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) - own_membership: "FeedMemberResponse | None" = dc_field( + own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @@ -12553,32 +14166,32 @@ class FeedRequest(DataClassJsonMixin): # ID of the feed feed_id: str = dc_field(metadata=dc_config(field_name="feed_id")) # ID of the feed creator - created_by_id: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Description of the feed - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Name of the feed - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + 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: str | None = dc_field( + visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Initial members for the feed - members: "list[FeedMemberRequest] | None" = dc_field( + members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Custom data for the feed - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -12625,7 +14238,7 @@ class FeedResponse(DataClassJsonMixin): # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) # When the feed was deleted - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -12635,33 +14248,33 @@ class FeedResponse(DataClassJsonMixin): ), ) # Visibility setting for the feed - visibility: str | None = dc_field( + visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds - filter_tags: list[str] | None = dc_field( + 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: "list[FeedOwnCapability] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) # Custom data for the feed - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) - own_membership: "FeedMemberResponse | None" = dc_field( + own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @@ -12708,7 +14321,7 @@ class FeedSuggestionResponse(DataClassJsonMixin): # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) # When the feed was deleted - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -12717,41 +14330,43 @@ class FeedSuggestionResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - recommendation_score: float | None = dc_field( + 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: str | None = dc_field( + visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) # Tags used for filtering feeds - filter_tags: list[str] | None = dc_field( + 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: "list[FeedOwnCapability] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + 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: "list[FollowResponse] | None" = dc_field( + own_follows: "Optional[List[FollowResponse]]" = dc_field( default=None, metadata=dc_config(field_name="own_follows") ) - algorithm_scores: "dict[str, float] | None" = dc_field( + algorithm_scores: "Optional[Dict[str, float]]" = dc_field( default=None, metadata=dc_config(field_name="algorithm_scores") ) # Custom data for the feed - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) - own_membership: "FeedMemberResponse | None" = dc_field( + own_membership: "Optional[FeedMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_membership") ) @@ -12767,16 +14382,17 @@ class FeedUpdatedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -12785,7 +14401,7 @@ class FeedUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -12795,7 +14411,7 @@ 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: datetime | None = dc_field( + last_used_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_used_at", @@ -12805,27 +14421,38 @@ class FeedViewResponse(DataClassJsonMixin): ), ) # Configured activity selectors - activity_selectors: "list[ActivitySelectorConfigResponse] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfigResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) - ranking: "RankingConfig | None" = dc_field( + 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( + 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")) + grants: "Dict[str, List[str]]" = dc_field(metadata=dc_config(field_name="grants")) @dataclass @@ -12856,10 +14483,10 @@ class FeedsBookmarkResponse(DataClassJsonMixin): ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) - activity_id: str | None = dc_field( + activity_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="activity_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -12876,7 +14503,8 @@ class FeedsEnrichedCollectionResponse(DataClassJsonMixin): ) id: str = dc_field(metadata=dc_config(field_name="id")) name: str = dc_field(metadata=dc_config(field_name="name")) - status: str = dc_field(metadata=dc_config(field_name="status")) + # 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", @@ -12886,7 +14514,7 @@ class FeedsEnrichedCollectionResponse(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) @dataclass @@ -12919,7 +14547,7 @@ class FeedsFeedResponse(DataClassJsonMixin): ) # User response object created_by: "UserResponse" = dc_field(metadata=dc_config(field_name="created_by")) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -12928,16 +14556,17 @@ class FeedsFeedResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - visibility: str | None = dc_field( + # Who can see and follow a feed. + visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="visibility") ) - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "FeedsActivityLocation | None" = dc_field( + location: "Optional[FeedsActivityLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -12945,9 +14574,9 @@ class FeedsFeedResponse(DataClassJsonMixin): @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")) + data_types: "Dict[str, str]" = dc_field(metadata=dc_config(field_name="data_types")) # Key of the moderation configuration to use - config_key: str | None = dc_field( + config_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="config_key") ) @@ -12957,17 +14586,20 @@ 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")) - attachments: "list[Attachment] | None" = dc_field( + 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: "FeedsNotificationTarget | None" = dc_field( + target: "Optional[FeedsNotificationTarget]" = dc_field( default=None, metadata=dc_config(field_name="target") ) - trigger: "FeedsNotificationTrigger | None" = dc_field( + trigger: "Optional[FeedsNotificationTrigger]" = dc_field( default=None, metadata=dc_config(field_name="trigger") ) @@ -12975,12 +14607,12 @@ class FeedsNotificationContext(DataClassJsonMixin): @dataclass class FeedsNotificationParentActivity(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - user_id: str | None = dc_field( + 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: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @@ -12988,22 +14620,22 @@ class FeedsNotificationParentActivity(DataClassJsonMixin): @dataclass class FeedsNotificationTarget(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - user_id: str | None = dc_field( + 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: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) - comment: "FeedsNotificationComment | None" = dc_field( + comment: "Optional[FeedsNotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - parent_activity: "FeedsNotificationParentActivity | None" = dc_field( + parent_activity: "Optional[FeedsNotificationParentActivity]" = dc_field( default=None, metadata=dc_config(field_name="parent_activity") ) @@ -13012,70 +14644,82 @@ class FeedsNotificationTarget(DataClassJsonMixin): class FeedsNotificationTrigger(DataClassJsonMixin): text: str = dc_field(metadata=dc_config(field_name="text")) type: str = dc_field(metadata=dc_config(field_name="type")) - comment: "FeedsNotificationComment | None" = dc_field( + comment: "Optional[FeedsNotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) - custom: dict[str, object] | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="follow")) + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: "dict[str, str] | None" = dc_field( + custom_activity_types: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="custom_activity_types") ) @dataclass class FeedsPreferencesResponse(DataClassJsonMixin): - comment: str | None = dc_field( + comment: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment") ) - comment_mention: str | None = dc_field( + comment_mention: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_mention") ) - comment_reaction: str | None = dc_field( + comment_reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reaction") ) - comment_reply: str | None = dc_field( + comment_reply: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_reply") ) - follow: str | None = dc_field(default=None, metadata=dc_config(field_name="follow")) - mention: str | None = dc_field( + 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: str | None = dc_field( + reaction: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reaction") ) - custom_activity_types: "dict[str, str] | None" = dc_field( + custom_activity_types: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="custom_activity_types") ) @@ -13123,14 +14767,37 @@ class FeedsReactionResponse(DataClassJsonMixin): ) # User response object user: "UserResponse" = dc_field(metadata=dc_config(field_name="user")) - comment_id: str | None = dc_field( + comment_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="comment_id") ) - custom: dict[str, object] | None = dc_field( + 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")) @@ -13163,7 +14830,10 @@ class FeedsV3ActivityResponse(DataClassJsonMixin): 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")) - restrict_replies: str = dc_field(metadata=dc_config(field_name="restrict_replies")) + # 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")) @@ -13175,41 +14845,44 @@ class FeedsV3ActivityResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - visibility: str = dc_field(metadata=dc_config(field_name="visibility")) - attachments: "list[Attachment]" = dc_field( + # 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( + 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( + 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( + mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) - own_bookmarks: "list[FeedsBookmarkResponse]" = dc_field( + own_bookmarks: "List[FeedsBookmarkResponse]" = dc_field( metadata=dc_config(field_name="own_bookmarks") ) - own_reactions: "list[FeedsReactionResponse]" = dc_field( + own_reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) - collections: "dict[str, FeedsEnrichedCollectionResponse]" = dc_field( + 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( + 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( + 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: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -13218,7 +14891,7 @@ class FeedsV3ActivityResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - edited_at: datetime | None = dc_field( + edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", @@ -13227,7 +14900,7 @@ class FeedsV3ActivityResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - expires_at: datetime | None = dc_field( + expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", @@ -13236,59 +14909,59 @@ class FeedsV3ActivityResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - friend_reaction_count: int | None = dc_field( + friend_reaction_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="friend_reaction_count") ) - is_read: bool | None = dc_field( + is_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_read") ) - is_seen: bool | None = dc_field( + is_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_seen") ) - is_watched: bool | None = dc_field( + is_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_watched") ) - moderation_action: str | None = dc_field( + moderation_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_action") ) - selector_source: str | None = dc_field( + selector_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="selector_source") ) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - visibility_tag: str | None = dc_field( + 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: "list[FeedsReactionResponse] | None" = dc_field( + friend_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="friend_reactions") ) - latest_shares: "list[FeedsShareResponse] | None" = dc_field( + latest_shares: "Optional[List[FeedsShareResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_shares") ) - current_feed: "FeedsFeedResponse | None" = dc_field( + current_feed: "Optional[FeedsFeedResponse]" = dc_field( default=None, metadata=dc_config(field_name="current_feed") ) - i18n: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - location: "FeedsActivityLocation | None" = dc_field( + location: "Optional[FeedsActivityLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) - metrics: "dict[str, int] | None" = dc_field( + metrics: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) - notification_context: "FeedsNotificationContext | None" = dc_field( + notification_context: "Optional[FeedsNotificationContext]" = dc_field( default=None, metadata=dc_config(field_name="notification_context") ) - parent: "FeedsV3ActivityResponse | None" = dc_field( + parent: "Optional[FeedsV3ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) - score_vars: dict[str, object] | None = dc_field( + score_vars: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="score_vars") ) @@ -13308,13 +14981,15 @@ class FeedsV3CommentResponse(DataClassJsonMixin): ) ) 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: str = dc_field(metadata=dc_config(field_name="status")) + # 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", @@ -13324,18 +14999,18 @@ class FeedsV3CommentResponse(DataClassJsonMixin): ) ) upvote_count: int = dc_field(metadata=dc_config(field_name="upvote_count")) - mentioned_users: "list[UserResponse]" = dc_field( + mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) - own_reactions: "list[FeedsReactionResponse]" = dc_field( + 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: float | None = dc_field( + controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -13344,7 +15019,7 @@ class FeedsV3CommentResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - edited_at: datetime | None = dc_field( + edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", @@ -13353,26 +15028,26 @@ class FeedsV3CommentResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - attachments: "list[Attachment] | None" = dc_field( + 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: "list[FeedsReactionResponse] | None" = dc_field( + latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - i18n: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) - reaction_groups: "dict[str, FeedsReactionGroupResponse] | None" = dc_field( + reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @@ -13387,16 +15062,16 @@ class Field(DataClassJsonMixin): @dataclass class FileUploadConfig(DataClassJsonMixin): size_limit: int = dc_field(metadata=dc_config(field_name="size_limit")) - allowed_file_extensions: list[str] | None = dc_field( + allowed_file_extensions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_file_extensions") ) - allowed_mime_types: list[str] | None = dc_field( + allowed_mime_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_mime_types") ) - blocked_file_extensions: list[str] | None = dc_field( + blocked_file_extensions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_file_extensions") ) - blocked_mime_types: list[str] | None = dc_field( + blocked_mime_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocked_mime_types") ) @@ -13404,8 +15079,8 @@ class FileUploadConfig(DataClassJsonMixin): @dataclass class FileUploadRequest(DataClassJsonMixin): # file field - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) - user: "OnlyUserID | None" = dc_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") ) @@ -13415,9 +15090,9 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) + 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: str | None = dc_field( + thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) @@ -13425,47 +15100,55 @@ class FileUploadResponse(DataClassJsonMixin): @dataclass class FilterConfigResponse(DataClassJsonMixin): # LLM moderation labels available as filter values - llm_labels: list[str] = dc_field(metadata=dc_config(field_name="llm_labels")) + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: "dict[str, list[str]] | None" = dc_field( + 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: str | None = dc_field( + apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_template") ) - credentials_json: str | None = dc_field( + credentials_json: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="credentials_json") ) - data_template: str | None = dc_field( + data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_template") ) - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) - notification_template: str | None = dc_field( + notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) - server_key: str | None = dc_field( + server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="server_key") ) @@ -13473,26 +15156,26 @@ class FirebaseConfig(DataClassJsonMixin): @dataclass class FirebaseConfigFields(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - apn_template: str | None = dc_field( + apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_template") ) - credentials_json: str | None = dc_field( + credentials_json: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="credentials_json") ) - data_template: str | None = dc_field( + data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_template") ) - notification_template: str | None = dc_field( + notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="notification_template") ) - server_key: str | None = dc_field( + server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="server_key") ) @dataclass class FlagCountRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) @@ -13500,7 +15183,7 @@ class FlagCountRuleParameters(DataClassJsonMixin): @dataclass class FlagDetails(DataClassJsonMixin): original_text: str = dc_field(metadata=dc_config(field_name="original_text")) - automod: "AutomodDetailsResponse | None" = dc_field( + automod: "Optional[AutomodDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="automod") ) @@ -13508,10 +15191,10 @@ class FlagDetails(DataClassJsonMixin): @dataclass class FlagDetailsResponse(DataClassJsonMixin): original_text: str = dc_field(metadata=dc_config(field_name="original_text")) - automod: "AutomodDetailsResponse | None" = dc_field( + automod: "Optional[AutomodDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="automod") ) - extra: dict[str, object] | None = dc_field( + extra: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="extra") ) @@ -13527,7 +15210,7 @@ class FlagFeedbackResponse(DataClassJsonMixin): ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) - labels: "list[LabelResponse]" = dc_field(metadata=dc_config(field_name="labels")) + labels: "List[LabelResponse]" = dc_field(metadata=dc_config(field_name="labels")) @dataclass @@ -13539,16 +15222,16 @@ class FlagItemResponse(DataClassJsonMixin): @dataclass class FlagMessageDetailsResponse(DataClassJsonMixin): - pin_changed: bool | None = dc_field( + pin_changed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pin_changed") ) - should_enrich: bool | None = dc_field( + should_enrich: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="should_enrich") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - updated_by_id: str | None = dc_field( + updated_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="updated_by_id") ) @@ -13560,23 +15243,25 @@ class FlagRequest(DataClassJsonMixin): # 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - user_id: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - moderation_payload: "ModerationPayload | None" = dc_field( + moderation_payload: "Optional[ModerationPayload]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -13602,7 +15287,7 @@ class FlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - approved_at: datetime | None = dc_field( + approved_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="approved_at", @@ -13611,8 +15296,10 @@ class FlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - rejected_at: datetime | None = dc_field( + 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", @@ -13621,7 +15308,7 @@ class FlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reviewed_at: datetime | None = dc_field( + reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", @@ -13630,28 +15317,28 @@ class FlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reviewed_by: str | None = dc_field( + reviewed_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reviewed_by") ) - target_message_id: str | None = dc_field( + target_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_message_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - details: "FlagDetails | None" = dc_field( + details: "Optional[FlagDetails]" = dc_field( default=None, metadata=dc_config(field_name="details") ) # Represents any chat message - target_message: "MessageResponse | None" = dc_field( + target_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_message") ) # User response object - target_user: "UserResponse | None" = dc_field( + target_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -13666,9 +15353,9 @@ class FlagUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -13678,93 +15365,108 @@ class FlagUpdatedEvent(DataClassJsonMixin): ), ) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="CreatedBy") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="Message") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="User") ) @dataclass class FlagUserOptions(DataClassJsonMixin): - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass class FloodConfig(DataClassJsonMixin): - allowlist: list[str] | None = dc_field( + allowlist: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowlist") ) - identical: "FloodIdenticalConfig | None" = dc_field( + identical: "Optional[FloodIdenticalConfig]" = dc_field( default=None, metadata=dc_config(field_name="identical") ) - similar: "FloodSimilarConfig | None" = dc_field( + similar: "Optional[FloodSimilarConfig]" = dc_field( default=None, metadata=dc_config(field_name="similar") ) @dataclass class FloodIdenticalConfig(DataClassJsonMixin): - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - enabled: bool | None = dc_field( + 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: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class FloodIdenticalRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + 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: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - allowlist: list[str] | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - enabled: bool | None = dc_field( + 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: int | None = dc_field( + similarity_distance: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="similarity_distance") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class FloodSimilarRuleParameters(DataClassJsonMixin): - similarity_distance: int | None = dc_field( + 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: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - allowlist: list[str] | None = dc_field( + allowlist: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowlist") ) @@ -13772,13 +15474,17 @@ class FloodSimilarRuleParameters(DataClassJsonMixin): @dataclass class FollowBatchRequest(DataClassJsonMixin): # List of follow relationships to create - follows: "list[FollowRequest]" = dc_field(metadata=dc_config(field_name="follows")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @@ -13787,9 +15493,13 @@ class FollowBatchRequest(DataClassJsonMixin): 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")) + 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")) + 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 @@ -13804,16 +15514,17 @@ class FollowCreatedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -13836,16 +15547,17 @@ class FollowDeletedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -13856,6 +15568,14 @@ class FollowDeletedEvent(DataClassJsonMixin): ) +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 @@ -13863,38 +15583,40 @@ class FollowRequest(DataClassJsonMixin): # 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: int | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + push_preference: "Optional[FollowPushPreference]" = dc_field( default=None, metadata=dc_config(field_name="push_preference") ) # Whether to skip push for this follow - skip_push: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="status")) + status: "Optional[FollowStatus]" = dc_field( + default=None, metadata=dc_config(field_name="status") + ) # Custom data for the follow relationship - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -13913,9 +15635,11 @@ class FollowResponse(DataClassJsonMixin): # 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: str = dc_field(metadata=dc_config(field_name="push_preference")) + push_preference: "FollowPushPreference" = dc_field( + metadata=dc_config(field_name="push_preference") + ) # Status of the follow relationship. One of: accepted, pending, rejected - status: str = dc_field(metadata=dc_config(field_name="status")) + 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( @@ -13928,7 +15652,7 @@ class FollowResponse(DataClassJsonMixin): 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: datetime | None = dc_field( + request_accepted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="request_accepted_at", @@ -13938,7 +15662,7 @@ class FollowResponse(DataClassJsonMixin): ), ) # When the follow request was rejected - request_rejected_at: datetime | None = dc_field( + request_rejected_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="request_rejected_at", @@ -13948,11 +15672,20 @@ class FollowResponse(DataClassJsonMixin): ), ) # Custom data for the follow relationship - custom: dict[str, object] | None = dc_field( + 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 @@ -13965,16 +15698,17 @@ class FollowUpdatedEvent(DataClassJsonMixin): ) ) fid: str = dc_field(metadata=dc_config(field_name="fid")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -13986,141 +15720,335 @@ class FollowUpdatedEvent(DataClassJsonMixin): @dataclass -class FrameRecordSettings(DataClassJsonMixin): - capture_interval_in_seconds: int = dc_field( - metadata=dc_config(field_name="capture_interval_in_seconds") +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") ) - mode: str = dc_field(metadata=dc_config(field_name="mode")) - quality: str | None = dc_field( - default=None, metadata=dc_config(field_name="quality") + # 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") ) - - -@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") + dwell: "Optional[ForYouDwellConfig]" = dc_field( + default=None, metadata=dc_config(field_name="dwell") ) - mode: str = dc_field(metadata=dc_config(field_name="mode")) - quality: str | None = dc_field( - default=None, metadata=dc_config(field_name="quality") + exploration: "Optional[ForYouExplorationConfig]" = dc_field( + default=None, metadata=dc_config(field_name="exploration") ) @dataclass -class FrameRecordingSettingsResponse(DataClassJsonMixin): - capture_interval_in_seconds: int = dc_field( - metadata=dc_config(field_name="capture_interval_in_seconds") +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") ) - mode: str = dc_field(metadata=dc_config(field_name="mode")) - quality: str | None = dc_field( - default=None, metadata=dc_config(field_name="quality") + # 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 FriendReactionsOptions(DataClassJsonMixin): - # Default: false. When true, fetches friend reactions for activities. - enabled: bool | None = dc_field( +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") ) - # Default: 3, Max: 10. The maximum number of friend reactions to return per activity. - limit: int | None = 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + # 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 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"), - ) +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") ) - 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") + user_id: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="user_id") ) - unread_channels: int = dc_field(metadata=dc_config(field_name="unread_channels")) - 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"), - ) + # User request object + user: "Optional[UserRequest]" = dc_field( + default=None, metadata=dc_config(field_name="user") ) - blocked_user_ids: list[str] = dc_field( - metadata=dc_config(field_name="blocked_user_ids") + + +@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") ) - channel_mutes: "list[ChannelMute]" = dc_field( - metadata=dc_config(field_name="channel_mutes") + # List of channel messages + messages: "List[MessageResponse]" = dc_field( + metadata=dc_config(field_name="messages") ) - 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: int | None = dc_field( - default=None, metadata=dc_config(field_name="avg_response_time") + # List of pinned messages in the channel + pinned_messages: "List[MessageResponse]" = dc_field( + metadata=dc_config(field_name="pinned_messages") ) - ban_expires: datetime | None = 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"), - ), + threads: "List[ThreadStateResponse]" = dc_field( + metadata=dc_config(field_name="threads") ) - bypass_moderation: bool | None = dc_field( - default=None, metadata=dc_config(field_name="bypass_moderation") + # 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") ) - deactivated_at: datetime | None = 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"), - ), + # Whether this channel is hidden or not + hidden: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="hidden") ) - deleted_at: datetime | None = dc_field( + # Messages before this date are hidden from the user + hide_messages_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( - field_name="deleted_at", + field_name="hide_messages_before", encoder=encode_datetime, decoder=datetime_from_unix_ns, mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - last_active: datetime | None = 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"), + # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - revoke_tokens_issued_before: datetime | None = dc_field( + 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", @@ -14129,13 +16057,14 @@ class FullUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - latest_hidden_channels: list[str] | None = dc_field( + latest_hidden_channels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="latest_hidden_channels") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -14150,7 +16079,7 @@ class FutureChannelBanResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - expires: datetime | None = dc_field( + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", @@ -14159,16 +16088,18 @@ class FutureChannelBanResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - shadow: bool | None = dc_field( + 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: "UserResponse | None" = dc_field( + banned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="banned_by") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -14176,37 +16107,37 @@ class FutureChannelBanResponse(DataClassJsonMixin): @dataclass class GeofenceResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - country_codes: list[str] | None = dc_field( + 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")) + names: List[str] = dc_field(metadata=dc_config(field_name="names")) @dataclass class GeofenceSettingsRequest(DataClassJsonMixin): - names: list[str] | None = dc_field( + 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")) + 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( + action_config: "Dict[str, List[ModerationActionConfigResponse]]" = dc_field( metadata=dc_config(field_name="action_config") ) @@ -14232,10 +16163,10 @@ class GetActiveCallsStatusResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - metrics: "ActiveCallsMetrics | None" = dc_field( + metrics: "Optional[ActiveCallsMetrics]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) - summary: "ActiveCallsSummary | None" = dc_field( + summary: "Optional[ActiveCallsSummary]" = dc_field( default=None, metadata=dc_config(field_name="summary") ) @@ -14249,7 +16180,7 @@ class GetActivityResponse(DataClassJsonMixin): @dataclass class GetAppealResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - item: "AppealItemResponse | None" = dc_field( + item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @@ -14258,6 +16189,7 @@ class GetAppealResponse(DataClassJsonMixin): 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")) @@ -14265,7 +16197,7 @@ class GetApplicationResponse(DataClassJsonMixin): class GetBlockListResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Block list contains restricted words - blocklist: "BlockListResponse | None" = dc_field( + blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @@ -14275,7 +16207,7 @@ 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( + blocks: "List[BlockedUserResponse]" = dc_field( metadata=dc_config(field_name="blocks") ) @@ -14284,13 +16216,13 @@ class GetBlockedUsersResponse(DataClassJsonMixin): class GetCallParticipantSessionMetricsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - is_publisher: bool | None = dc_field( + is_publisher: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_publisher") ) - is_subscriber: bool | None = dc_field( + is_subscriber: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_subscriber") ) - joined_at: datetime | None = dc_field( + joined_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="joined_at", @@ -14299,19 +16231,19 @@ class GetCallParticipantSessionMetricsResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - publisher_type: str | None = dc_field( + publisher_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_type") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - user_session_id: str | None = dc_field( + user_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_session_id") ) - published_tracks: "list[PublishedTrackMetrics] | None" = dc_field( + published_tracks: "Optional[List[PublishedTrackMetrics]]" = dc_field( default=None, metadata=dc_config(field_name="published_tracks") ) - client: "SessionClient | None" = dc_field( + client: "Optional[SessionClient]" = dc_field( default=None, metadata=dc_config(field_name="client") ) @@ -14322,16 +16254,16 @@ class GetCallReportResponse(DataClassJsonMixin): 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: "list[VideoReactionsResponse] | None" = dc_field( + video_reactions: "Optional[List[VideoReactionsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="video_reactions") ) - chat_activity: "ChatActivityStatsResponse | None" = dc_field( + chat_activity: "Optional[ChatActivityStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_activity") ) - digest: "BroadcastDigest | None" = dc_field( + digest: "Optional[BroadcastDigest]" = dc_field( default=None, metadata=dc_config(field_name="digest") ) - session: "CallSessionResponse | None" = dc_field( + session: "Optional[CallSessionResponse]" = dc_field( default=None, metadata=dc_config(field_name="session") ) @@ -14339,8 +16271,8 @@ class GetCallReportResponse(DataClassJsonMixin): @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( + 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 @@ -14356,16 +16288,16 @@ class GetCallSessionParticipantStatsDetailsResponse(DataClassJsonMixin): 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: "ParticipantSeriesPublisherStats | None" = dc_field( + publisher: "Optional[ParticipantSeriesPublisherStats]" = dc_field( default=None, metadata=dc_config(field_name="publisher") ) - subscriber: "ParticipantSeriesSubscriberStats | None" = dc_field( + subscriber: "Optional[ParticipantSeriesSubscriberStats]" = dc_field( default=None, metadata=dc_config(field_name="subscriber") ) - timeframe: "ParticipantSeriesTimeframe | None" = dc_field( + timeframe: "Optional[ParticipantSeriesTimeframe]" = dc_field( default=None, metadata=dc_config(field_name="timeframe") ) - user: "ParticipantSeriesUserStats | None" = dc_field( + user: "Optional[ParticipantSeriesUserStats]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -14390,14 +16322,14 @@ class GetCallTypeResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - grants: "dict[str, list[str]]" = dc_field(metadata=dc_config(field_name="grants")) + 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: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @@ -14406,18 +16338,22 @@ class GetCallTypeResponse(DataClassJsonMixin): class GetCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - campaign: "CampaignResponse | None" = dc_field( + campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) - users: "PagerResponse | None" = dc_field( + users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @dataclass class GetChannelTypeResponse(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -14471,37 +16407,39 @@ class GetChannelTypeResponse(DataClassJsonMixin): 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( + 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: str | None = dc_field( + 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") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @@ -14513,7 +16451,7 @@ class GetCommandResponse(DataClassJsonMixin): 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: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -14522,7 +16460,7 @@ class GetCommandResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -14539,11 +16477,11 @@ class GetCommentRepliesResponse(DataClassJsonMixin): # 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( + comments: "List[ThreadedCommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 @@ -14554,21 +16492,27 @@ class GetCommentResponse(DataClassJsonMixin): @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( + comments: "List[ThreadedCommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "ConfigResponse | None" = dc_field( + config: "Optional[ConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @@ -14586,28 +16530,28 @@ class GetDailyDigestResponse(DataClassJsonMixin): # 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: str | None = dc_field( + generated_at: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="generated_at") ) - retry_after: int | None = dc_field( + retry_after: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="retry_after") ) - revision: int | None = dc_field( + revision: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="revision") ) - schema_version: str | None = dc_field( + schema_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="schema_version") ) - broadcasts: "list[BroadcastDigest] | None" = dc_field( + broadcasts: "Optional[List[BroadcastDigest]]" = dc_field( default=None, metadata=dc_config(field_name="broadcasts") ) - call_sessions: "list[DailyDigestCallSessionSummary] | None" = dc_field( + call_sessions: "Optional[List[DailyDigestCallSessionSummary]]" = dc_field( default=None, metadata=dc_config(field_name="call_sessions") ) - digest_kinds: list[str] | None = dc_field( + digest_kinds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="digest_kinds") ) - broadcast_rollup: "BroadcastDailyRollup | None" = dc_field( + broadcast_rollup: "Optional[BroadcastDailyRollup]" = dc_field( default=None, metadata=dc_config(field_name="broadcast_rollup") ) @@ -14623,7 +16567,7 @@ class GetDraftResponse(DataClassJsonMixin): 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")) + edges: "List[EdgeResponse]" = dc_field(metadata=dc_config(field_name="edges")) @dataclass @@ -14631,7 +16575,7 @@ 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: str | None = dc_field( + path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @@ -14640,7 +16584,7 @@ class GetExternalStorageAWSS3Response(DataClassJsonMixin): 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: str | None = dc_field( + path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @@ -14666,10 +16610,10 @@ class GetExternalStorageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - aws_s3: "GetExternalStorageAWSS3Response | None" = dc_field( + aws_s3: "Optional[GetExternalStorageAWSS3Response]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) - gcs: "GetExternalStorageGCSResponse | None" = dc_field( + gcs: "Optional[GetExternalStorageGCSResponse]" = dc_field( default=None, metadata=dc_config(field_name="gcs") ) @@ -14711,35 +16655,73 @@ class GetFeedVisibilityResponse(DataClassJsonMixin): class GetFeedsRateLimitsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Rate limits for Android platform (endpoint name -> limit info) - android: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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 @@ -14747,7 +16729,7 @@ class GetFlagCountRequest(DataClassJsonMixin): metadata=dc_config(field_name="entity_creator_id") ) # Optional entity type filter (e.g., stream:chat:v1:message, stream:user) - entity_type: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) @@ -14763,19 +16745,31 @@ class GetFlagCountResponse(DataClassJsonMixin): class GetFollowSuggestionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of suggested feeds to follow - suggestions: "list[FeedSuggestionResponse]" = dc_field( + suggestions: "List[FeedSuggestionResponse]" = dc_field( metadata=dc_config(field_name="suggestions") ) - algorithm_used: str | None = dc_field( + 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: "ImportTask | None" = dc_field( + import_task: "Optional[ImportTask]" = dc_field( default=None, metadata=dc_config(field_name="import_task") ) @@ -14807,7 +16801,7 @@ class GetImportV2TaskResponse(DataClassJsonMixin): settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) - result: dict[str, object] | None = dc_field( + result: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="result") ) @@ -14816,7 +16810,7 @@ class GetImportV2TaskResponse(DataClassJsonMixin): class GetManyMessagesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of messages - messages: "list[MessageResponse]" = dc_field( + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @@ -14829,7 +16823,7 @@ class GetMessageResponse(DataClassJsonMixin): message: "MessageWithChannelResponse" = dc_field( metadata=dc_config(field_name="message") ) - pending_message_metadata: "dict[str, str] | None" = dc_field( + pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @@ -14838,94 +16832,131 @@ class GetMessageResponse(DataClassJsonMixin): class GetModerationRuleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - rule: "ModerationRuleV2Response | None" = dc_field( + 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # URL of detected video or audio - asset_url: str | None = dc_field( + asset_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="asset_url") ) - author_icon: str | None = dc_field( + author_icon: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_icon") ) # og:site - author_link: str | None = dc_field( + author_link: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_link") ) # og:site_name - author_name: str | None = dc_field( + author_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="author_name") ) - color: str | None = dc_field(default=None, metadata=dc_config(field_name="color")) - fallback: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="footer")) - footer_icon: str | None = dc_field( + 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: str | None = dc_field( + image_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="image_url") ) # extracted url from the text - og_scrape_url: str | None = dc_field( + og_scrape_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="og_scrape_url") ) - original_height: int | None = dc_field( + original_height: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_height") ) - original_width: int | None = dc_field( + original_width: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="original_width") ) - pretext: str | None = dc_field( + pretext: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pretext") ) # og:description - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # URL of detected thumb image - thumb_url: str | None = dc_field( + thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) # og:title - title: str | None = dc_field(default=None, metadata=dc_config(field_name="title")) + title: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="title") + ) # og:url - title_link: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - actions: "list[Action] | None" = dc_field( + 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: "list[Field] | None" = dc_field( + fields: "Optional[List[Field]]" = dc_field( default=None, metadata=dc_config(field_name="fields") ) - giphy: "Images | None" = dc_field( + giphy: "Optional[Images]" = dc_field( default=None, metadata=dc_config(field_name="giphy") ) @dataclass class GetOrCreateCallRequest(DataClassJsonMixin): - members_limit: int | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="ring")) - video: bool | None = dc_field(default=None, metadata=dc_config(field_name="video")) + 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: "CallRequest | None" = dc_field( + data: "Optional[CallRequest]" = dc_field( default=None, metadata=dc_config(field_name="data") ) @@ -14934,58 +16965,66 @@ class GetOrCreateCallRequest(DataClassJsonMixin): 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( + 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: str | None = dc_field( + 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: str | None = dc_field( + default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors - activity_processors: "list[ActivityProcessorConfig] | None" = dc_field( + activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors - activity_selectors: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - activity_filter: "ActivityFilterConfig | None" = dc_field( + activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) - activity_marks: "ActivityMarksConfig | None" = dc_field( + activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) - activity_processing: "ActivityProcessingConfig | None" = dc_field( + activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - notification: "NotificationConfig | None" = dc_field( + notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) - push_notification: "PushNotificationConfig | None" = dc_field( + push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) - stories: "StoriesConfig | None" = dc_field( + stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @@ -15002,53 +17041,64 @@ class GetOrCreateFeedGroupResponse(DataClassJsonMixin): @dataclass class GetOrCreateFeedRequest(DataClassJsonMixin): - id_around: str | None = dc_field( + id_around: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="id_around") ) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - overwrite_interest_weights: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="view")) - watch: bool | None = dc_field(default=None, metadata=dc_config(field_name="watch")) - data: "FeedInput | None" = dc_field( + 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: "EnrichmentOptions | None" = dc_field( + enrichment_options: "Optional[EnrichmentOptions]" = dc_field( default=None, metadata=dc_config(field_name="enrichment_options") ) - external_ranking: dict[str, object] | None = dc_field( + external_ranking: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="external_ranking") ) - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) - followers_pagination: "PagerRequest | None" = dc_field( + followers_pagination: "Optional[PagerRequest]" = dc_field( default=None, metadata=dc_config(field_name="followers_pagination") ) - following_pagination: "PagerRequest | None" = dc_field( + 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: "FriendReactionsOptions | None" = dc_field( + friend_reactions_options: "Optional[FriendReactionsOptions]" = dc_field( default=None, metadata=dc_config(field_name="friend_reactions_options") ) - interest_weights: "dict[str, float] | None" = dc_field( + interest_weights: "Optional[Dict[str, float]]" = dc_field( default=None, metadata=dc_config(field_name="interest_weights") ) - member_pagination: "PagerRequest | None" = dc_field( + member_pagination: "Optional[PagerRequest]" = dc_field( default=None, metadata=dc_config(field_name="member_pagination") ) # User request object - user: "UserRequest | None" = dc_field( + 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 @@ -15056,51 +17106,62 @@ 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( + activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) - aggregated_activities: "list[AggregatedActivityResponse]" = dc_field( + aggregated_activities: "List[AggregatedActivityResponse]" = dc_field( metadata=dc_config(field_name="aggregated_activities") ) - followers: "list[FollowResponse]" = dc_field( + followers: "List[FollowResponse]" = dc_field( metadata=dc_config(field_name="followers") ) - following: "list[FollowResponse]" = dc_field( + following: "List[FollowResponse]" = dc_field( metadata=dc_config(field_name="following") ) - members: "list[FeedMemberResponse]" = dc_field( + members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) - pinned_activities: "list[ActivityPinResponse]" = dc_field( + pinned_activities: "List[ActivityPinResponse]" = dc_field( metadata=dc_config(field_name="pinned_activities") ) feed: "FeedResponse" = dc_field(metadata=dc_config(field_name="feed")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - followers_pagination: "PagerResponse | None" = dc_field( + 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: "PagerResponse | None" = dc_field( + following_pagination: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="following_pagination") ) - member_pagination: "PagerResponse | None" = dc_field( + member_pagination: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="member_pagination") ) - notification_status: "NotificationStatusResponse | None" = dc_field( + 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: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @@ -15120,7 +17181,7 @@ class GetOrCreateFollowResponse(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 (only set when the follow was newly created) - notification_created: bool | None = dc_field( + notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @@ -15132,15 +17193,15 @@ class GetOrCreateUnfollowRequest(DataClassJsonMixin): # 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + keep_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_history") ) @@ -15150,7 +17211,7 @@ 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: "FollowResponse | None" = dc_field( + follow: "Optional[FollowResponse]" = dc_field( default=None, metadata=dc_config(field_name="follow") ) @@ -15160,7 +17221,7 @@ 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( + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @@ -15169,7 +17230,7 @@ class GetPinnedMessagesResponse(DataClassJsonMixin): class GetPredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - predefined_filter: "PredefinedFilterResponse | None" = dc_field( + predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @@ -15178,7 +17239,7 @@ class GetPredefinedFilterResponse(DataClassJsonMixin): class GetPushTemplatesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - templates: "list[PushTemplateResponse]" = dc_field( + templates: "List[PushTemplateResponse]" = dc_field( metadata=dc_config(field_name="templates") ) @@ -15187,31 +17248,31 @@ class GetPushTemplatesResponse(DataClassJsonMixin): class GetRateLimitsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Map of endpoint rate limits for the Android platform - android: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + 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: "dict[str, LimitInfoResponse] | None" = dc_field( + web: "Optional[Dict[str, LimitInfoResponse]]" = dc_field( default=None, metadata=dc_config(field_name="web") ) @@ -15220,7 +17281,7 @@ class GetRateLimitsResponse(DataClassJsonMixin): class GetReactionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of reactions - reactions: "list[ReactionResponse]" = dc_field( + reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) @@ -15229,7 +17290,7 @@ class GetReactionsResponse(DataClassJsonMixin): class GetRepliesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - messages: "list[MessageResponse]" = dc_field( + messages: "List[MessageResponse]" = dc_field( metadata=dc_config(field_name="messages") ) @@ -15238,22 +17299,27 @@ class GetRepliesResponse(DataClassJsonMixin): class GetRetentionPolicyResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - policies: "list[RetentionPolicy]" = dc_field( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -15262,15 +17328,15 @@ class GetRetentionPolicyRunsRequest(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "ReviewQueueItemResponse | None" = dc_field( + item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="item") ) @@ -15279,7 +17345,7 @@ class GetReviewQueueItemResponse(DataClassJsonMixin): class GetSegmentResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - segment: "SegmentResponse | None" = dc_field( + segment: "Optional[SegmentResponse]" = dc_field( default=None, metadata=dc_config(field_name="segment") ) @@ -15287,7 +17353,7 @@ class GetSegmentResponse(DataClassJsonMixin): @dataclass class GetSetupSessionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - setup_session: "SetupSession | None" = dc_field( + setup_session: "Optional[SetupSession]" = dc_field( default=None, metadata=dc_config(field_name="setup_session") ) @@ -15303,7 +17369,7 @@ class GetTaskResponse(DataClassJsonMixin): ) ) duration: str = dc_field(metadata=dc_config(field_name="duration")) - # Current status of task + # 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")) @@ -15315,11 +17381,11 @@ class GetTaskResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - error: "ErrorResult | None" = dc_field( + error: "Optional[ErrorResult]" = dc_field( default=None, metadata=dc_config(field_name="error") ) - # Result produced by task after completion - result: dict[str, object] | None = dc_field( + # 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") ) @@ -15333,7 +17399,7 @@ class GetThreadResponse(DataClassJsonMixin): @dataclass class GetUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - user_group: "UserGroupResponse | None" = dc_field( + user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -15341,39 +17407,39 @@ class GetUserGroupResponse(DataClassJsonMixin): @dataclass class GetUserInterestsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - # Top-N interest tags sorted by descending count, then alphabetically by tag - interests: "list[InterestTagResponse]" = dc_field( + # 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: str | None = dc_field( + recording_storage_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_storage_name") ) - start_closed_caption: bool | None = dc_field( + start_closed_caption: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_closed_caption") ) - start_composite_recording: bool | None = dc_field( + start_composite_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_composite_recording") ) - start_hls: bool | None = dc_field( + start_hls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_hls") ) - start_individual_recording: bool | None = dc_field( + start_individual_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_individual_recording") ) - start_raw_recording: bool | None = dc_field( + start_raw_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_raw_recording") ) - start_recording: bool | None = dc_field( + start_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_recording") ) - start_transcription: bool | None = dc_field( + start_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="start_transcription") ) - transcription_storage_name: str | None = dc_field( + transcription_storage_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="transcription_storage_name") ) @@ -15388,7 +17454,7 @@ class GoLiveResponse(DataClassJsonMixin): @dataclass class GoogleVisionConfig(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @@ -15396,39 +17462,54 @@ class GoogleVisionConfig(DataClassJsonMixin): @dataclass class GroupedChannelsBucket(DataClassJsonMixin): # Channels returned for this bucket - channels: "list[ChannelStateResponseFields]" = dc_field( + channels: "List[ChannelStateResponseFields]" = dc_field( metadata=dc_config(field_name="channels") ) # Cursor for the next page of this group - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for the previous page of this group - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - # Unread channels currently classified into this bucket - unread_channels: int | None = dc_field( + 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): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + # 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) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - user_id: str | None = dc_field( + # 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") ) - # Groups to return, keyed by group name. Each group can define limit, next, or prev. 'next' and 'prev' cursors are only allowed when the request contains exactly one group; multi-group pagination is rejected. - groups: "dict[str, GroupedChannelsGroupRequest] | None" = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -15437,8 +17518,8 @@ class GroupedQueryChannelsRequest(DataClassJsonMixin): class GroupedQueryChannelsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - # Predefined channel groups keyed by group name - groups: "dict[str, GroupedChannelsBucket]" = dc_field( + # Groups keyed by the requested stored group name + groups: "Dict[str, GroupedChannelsBucket]" = dc_field( metadata=dc_config(field_name="groups") ) @@ -15453,10 +17534,10 @@ class GroupedStatsResponse(DataClassJsonMixin): 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( + quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) - layout: "LayoutSettings | None" = dc_field( + layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -15464,18 +17545,18 @@ class HLSSettings(DataClassJsonMixin): @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( + quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) # Whether HLS broadcasting should start automatically - auto_on: bool | None = dc_field( + auto_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_on") ) # Whether HLS broadcasting is enabled - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - layout: "LayoutSettingsRequest | None" = dc_field( + layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -15484,7 +17565,7 @@ class HLSSettingsRequest(DataClassJsonMixin): 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( + quality_tracks: List[str] = dc_field( metadata=dc_config(field_name="quality_tracks") ) layout: "LayoutSettingsResponse" = dc_field(metadata=dc_config(field_name="layout")) @@ -15492,19 +17573,19 @@ class HLSSettingsResponse(DataClassJsonMixin): @dataclass class HarmConfig(DataClassJsonMixin): - cooldown_period: int | None = dc_field( + cooldown_period: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) - severity: int | None = dc_field( + severity: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - action_sequences: "list[ActionSequence] | None" = dc_field( + action_sequences: "Optional[List[ActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) - harm_types: list[str] | None = dc_field( + harm_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_types") ) @@ -15512,14 +17593,14 @@ class HarmConfig(DataClassJsonMixin): @dataclass class HideChannelRequest(DataClassJsonMixin): # Whether to clear message history of the channel or not - clear_history: bool | None = dc_field( + clear_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="clear_history") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -15531,56 +17612,84 @@ class HideChannelResponse(DataClassJsonMixin): @dataclass -class HuaweiConfig(DataClassJsonMixin): - disabled: bool | None = dc_field( - default=None, metadata=dc_config(field_name="Disabled") +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") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - secret: str | None = 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - secret: str | None = dc_field(default=None, metadata=dc_config(field_name="secret")) + 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: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @dataclass class IPFlagCountRuleParameters(DataClassJsonMixin): - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class ImageContentParameters(DataClassJsonMixin): - label_operator: str | None = dc_field( + label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) - min_confidence: float | None = dc_field( + min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @@ -15596,16 +17705,16 @@ class ImageData(DataClassJsonMixin): @dataclass class ImageRuleParameters(DataClassJsonMixin): - min_confidence: float | None = dc_field( + min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @@ -15613,23 +17722,29 @@ class ImageRuleParameters(DataClassJsonMixin): @dataclass class ImageSize(DataClassJsonMixin): # Crop mode. One of: top, bottom, left, right, center - crop: str | None = dc_field(default=None, metadata=dc_config(field_name="crop")) + crop: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="crop")) # Target image height - height: int | None = dc_field(default=None, metadata=dc_config(field_name="height")) + height: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="height") + ) # Resize method. One of: clip, crop, scale, fill - resize: str | None = dc_field(default=None, metadata=dc_config(field_name="resize")) + resize: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="resize") + ) # Target image width - width: int | None = dc_field(default=None, metadata=dc_config(field_name="width")) + width: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="width") + ) @dataclass class ImageUploadRequest(DataClassJsonMixin): - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) + file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) # field with JSON-encoded array of image size configurations - upload_sizes: "list[ImageSize] | None" = dc_field( + upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) - user: "OnlyUserID | None" = dc_field( + user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -15638,12 +17753,12 @@ class ImageUploadRequest(DataClassJsonMixin): class ImageUploadResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) - thumb_url: str | None = dc_field( + 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: "list[ImageSize] | None" = dc_field( + upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) @@ -15669,8 +17784,8 @@ class Images(DataClassJsonMixin): @dataclass class ImportBlockListRequest(DataClassJsonMixin): - items: list[str] = dc_field(metadata=dc_config(field_name="items")) - chunk_size: int | None = dc_field( + 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") ) @@ -15704,10 +17819,10 @@ class ImportTask(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - history: "list[ImportTaskHistory]" = dc_field( + history: "List[ImportTaskHistory]" = dc_field( metadata=dc_config(field_name="history") ) - size: int | None = dc_field(default=None, metadata=dc_config(field_name="size")) + size: Optional[int] = dc_field(default=None, metadata=dc_config(field_name="size")) @dataclass @@ -15749,34 +17864,38 @@ class ImportV2TaskItem(DataClassJsonMixin): settings: "ImportV2TaskSettings" = dc_field( metadata=dc_config(field_name="settings") ) - result: dict[str, object] | None = dc_field( + result: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="result") ) @dataclass class ImportV2TaskSettings(DataClassJsonMixin): - merge_custom: bool | None = dc_field( + merge_custom: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="merge_custom") ) - mode: str | None = dc_field(default=None, metadata=dc_config(field_name="mode")) - path: str | None = dc_field(default=None, metadata=dc_config(field_name="path")) - skip_references_check: bool | None = dc_field( + 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: bool | None = dc_field( + use_import_time_as_op_time: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="use_import_time_as_op_time") ) - s3: "ImportV2TaskSettingsS3 | None" = dc_field( + s3: "Optional[ImportV2TaskSettingsS3]" = dc_field( default=None, metadata=dc_config(field_name="s3") ) @dataclass class ImportV2TaskSettingsS3(DataClassJsonMixin): - bucket: str | None = dc_field(default=None, metadata=dc_config(field_name="bucket")) - dir: str | None = dc_field(default=None, metadata=dc_config(field_name="dir")) - region: str | None = dc_field(default=None, metadata=dc_config(field_name="region")) + 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 @@ -15791,8 +17910,9 @@ class Incident(DataClassJsonMixin): @dataclass class IndividualRecordSettings(DataClassJsonMixin): - mode: str = dc_field(metadata=dc_config(field_name="mode")) - output_types: list[str] | None = dc_field( + # 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") ) @@ -15805,17 +17925,18 @@ class IndividualRecordingResponse(DataClassJsonMixin): @dataclass class IndividualRecordingSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on - mode: str = dc_field(metadata=dc_config(field_name="mode")) + 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: list[str] | None = dc_field( + output_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="output_types") ) @dataclass class IndividualRecordingSettingsResponse(DataClassJsonMixin): - mode: str = dc_field(metadata=dc_config(field_name="mode")) - output_types: list[str] | None = dc_field( + # 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") ) @@ -15831,7 +17952,7 @@ class IngressAudioEncodingOptions(DataClassJsonMixin): 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: bool | None = dc_field( + enable_dtx: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_dtx") ) @@ -15865,41 +17986,41 @@ class IngressErrorEvent(DataClassJsonMixin): # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="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: "IngressAudioEncodingOptions | None" = dc_field( + audio_encoding_options: "Optional[IngressAudioEncodingOptions]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) - video_encoding_options: "dict[str, IngressVideoEncodingOptions] | None" = dc_field( - default=None, metadata=dc_config(field_name="video_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: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - audio_encoding_options: "IngressAudioEncodingOptionsRequest | None" = dc_field( + audio_encoding_options: "Optional[IngressAudioEncodingOptionsRequest]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) - video_encoding_options: "dict[str, IngressVideoEncodingOptionsRequest] | None" = ( - dc_field(default=None, metadata=dc_config(field_name="video_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: "IngressAudioEncodingResponse | None" = dc_field( + audio_encoding_options: "Optional[IngressAudioEncodingResponse]" = dc_field( default=None, metadata=dc_config(field_name="audio_encoding_options") ) - video_encoding_options: "dict[str, IngressVideoEncodingResponse] | None" = dc_field( - default=None, metadata=dc_config(field_name="video_encoding_options") + video_encoding_options: "Optional[Dict[str, IngressVideoEncodingResponse]]" = ( + dc_field(default=None, metadata=dc_config(field_name="video_encoding_options")) ) @@ -15948,15 +18069,15 @@ class IngressStartedEvent(DataClassJsonMixin): default="ingress.started", metadata=dc_config(field_name="type") ) # Client IP address - client_ip: str | None = dc_field( + 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: str | None = dc_field( + client_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="client_name") ) # Client software version - version: str | None = dc_field( + version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) @@ -15986,17 +18107,17 @@ class IngressStoppedEvent(DataClassJsonMixin): @dataclass class IngressVideoEncodingOptions(DataClassJsonMixin): - layers: "list[IngressVideoLayer]" = dc_field( + layers: "List[IngressVideoLayer]" = dc_field( metadata=dc_config(field_name="layers") ) - source: "IngressSource | None" = dc_field( + source: "Optional[IngressSource]" = dc_field( default=None, metadata=dc_config(field_name="source") ) @dataclass class IngressVideoEncodingOptionsRequest(DataClassJsonMixin): - layers: "list[IngressVideoLayerRequest]" = dc_field( + layers: "List[IngressVideoLayerRequest]" = dc_field( metadata=dc_config(field_name="layers") ) source: "IngressSourceRequest" = dc_field(metadata=dc_config(field_name="source")) @@ -16004,7 +18125,7 @@ class IngressVideoEncodingOptionsRequest(DataClassJsonMixin): @dataclass class IngressVideoEncodingResponse(DataClassJsonMixin): - layers: "list[IngressVideoLayerResponse]" = dc_field( + layers: "List[IngressVideoLayerResponse]" = dc_field( metadata=dc_config(field_name="layers") ) source: "IngressSourceResponse" = dc_field(metadata=dc_config(field_name="source")) @@ -16013,7 +18134,8 @@ class IngressVideoEncodingResponse(DataClassJsonMixin): @dataclass class IngressVideoLayer(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) - codec: str = dc_field(metadata=dc_config(field_name="codec")) + # 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")) @@ -16022,7 +18144,8 @@ class IngressVideoLayer(DataClassJsonMixin): @dataclass class IngressVideoLayerRequest(DataClassJsonMixin): bitrate: int = dc_field(metadata=dc_config(field_name="bitrate")) - codec: str = dc_field(metadata=dc_config(field_name="codec")) + # 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")) @@ -16050,17 +18173,19 @@ class InsertActionLogRequest(DataClassJsonMixin): # 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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + 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: str | None = dc_field( + 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: str | None = dc_field( + reporter_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="reporter_user_id") ) # Custom metadata for the action log - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -16070,19 +18195,101 @@ 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): - # Number of distinct reacted-to activities tagged with this value + # 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: "ActiveCallsLatencyStats | None" = dc_field( + latency: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="latency") ) @@ -16090,45 +18297,45 @@ class JoinCallAPIMetrics(DataClassJsonMixin): @dataclass class Joins(DataClassJsonMixin): reason: str = dc_field(metadata=dc_config(field_name="reason")) - disconnect_reasons: "dict[str, int]" = dc_field( + disconnect_reasons: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="disconnect_reasons") ) - failure_stages: "dict[str, int]" = dc_field( + failure_stages: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="failure_stages") ) - join_attempts: int | None = dc_field( + join_attempts: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_attempts") ) - join_success_rate: float | None = dc_field( + join_success_rate: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="join_success_rate") ) @dataclass class KeyframeOCRRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class KeyframeRuleParameters(DataClassJsonMixin): - min_confidence: float | None = dc_field( + min_confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="min_confidence") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @@ -16138,13 +18345,15 @@ 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="block")) + 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: str | None = dc_field( + kicked_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="kicked_by_id") ) # User request object - kicked_by: "UserRequest | None" = dc_field( + kicked_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="kicked_by") ) @@ -16173,24 +18382,32 @@ class KickedUserEvent(DataClassJsonMixin): default="call.kicked_user", metadata=dc_config(field_name="type") ) # User response object - kicked_by_user: "UserResponse | None" = dc_field( + kicked_by_user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="kicked_by_user") ) @dataclass class LLMConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - app_context: str | None = dc_field( + _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") ) - enabled: bool | None = dc_field( + 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") ) - rules: "list[LLMRule] | None" = dc_field( + 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: "dict[str, str] | None" = dc_field( + severity_descriptions: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="severity_descriptions") ) @@ -16198,11 +18415,13 @@ class LLMConfig(DataClassJsonMixin): @dataclass class LLMRule(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) - action: str | None = dc_field(default=None, metadata=dc_config(field_name="action")) - description: str | None = dc_field( + 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: "list[BodyguardSeverityRule] | None" = dc_field( + severity_rules: "Optional[List[BodyguardSeverityRule]]" = dc_field( default=None, metadata=dc_config(field_name="severity_rules") ) @@ -16210,10 +18429,10 @@ class LLMRule(DataClassJsonMixin): @dataclass class LabelResponse(DataClassJsonMixin): name: str = dc_field(metadata=dc_config(field_name="name")) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) - phrase_list_ids: "list[int] | None" = dc_field( + phrase_list_ids: "Optional[List[int]]" = dc_field( default=None, metadata=dc_config(field_name="phrase_list_ids") ) @@ -16247,26 +18466,28 @@ class LabelResultResponse(DataClassJsonMixin): # 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")) + labels: List[str] = dc_field(metadata=dc_config(field_name="labels")) # Customer-supplied identifier for the moderated content - content_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="masked_content") ) - policy: str | None = dc_field(default=None, metadata=dc_config(field_name="policy")) + policy: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="policy") + ) # Customer-supplied user identifier for the content author - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @@ -16274,9 +18495,13 @@ class LabelResultResponse(DataClassJsonMixin): @dataclass class LabelThresholds(DataClassJsonMixin): # Threshold for automatic message block - block: float | None = dc_field(default=None, metadata=dc_config(field_name="block")) + block: Optional[float] = dc_field( + default=None, metadata=dc_config(field_name="block") + ) # Threshold for automatic message flag - flag: float | None = dc_field(default=None, metadata=dc_config(field_name="flag")) + flag: Optional[float] = dc_field( + default=None, metadata=dc_config(field_name="flag") + ) @dataclass @@ -16284,25 +18509,27 @@ class LabelsRequest(DataClassJsonMixin): # Content to moderate content: str = dc_field(metadata=dc_config(field_name="content")) # Optional category for filtering (max 128 chars) - category: str | None = dc_field( + category: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="category") ) # Customer-supplied identifier for the moderated content, for tracing - content_id: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + 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-4.1-nano with a 24h Valkey verdict cache. Without a 'username:' prefix the request falls through to the standard Bodyguard Analyze v1 username path. - policy: str | None = dc_field(default=None, metadata=dc_config(field_name="policy")) + # 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) @@ -16315,65 +18542,78 @@ class LabelsResponse(DataClassJsonMixin): metadata=dc_config(field_name="recommended_action") ) # Customer-supplied identifier for the moderated content, for tracing - content_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + fully_masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="fully_masked_content") ) # High-level harm category - harm_type: str | None = dc_field( + harm_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="harm_type") ) # Detected language - language: str | None = dc_field( + 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: str | None = dc_field( + masked_content: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="masked_content") ) # Severity level - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) # Moderation labels detected - labels: list[str] | None = dc_field( + 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")) - name: str = dc_field(metadata=dc_config(field_name="name")) - detect_orientation: bool | None = dc_field( + # 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: dict[str, object] | None = dc_field( + options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @dataclass class LayoutSettingsRequest(DataClassJsonMixin): - name: str = dc_field(metadata=dc_config(field_name="name")) - detect_orientation: bool | None = dc_field( + # 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: str | None = dc_field( + external_app_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_app_url") ) - external_css_url: str | None = dc_field( + external_css_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_css_url") ) - options: dict[str, object] | None = dc_field( + options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="options") ) @@ -16382,15 +18622,30 @@ class LayoutSettingsRequest(DataClassJsonMixin): 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")) - name: str = dc_field(metadata=dc_config(field_name="name")) - detect_orientation: bool | None = dc_field( + # 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: dict[str, object] | None = dc_field( + 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 @@ -16403,48 +18658,48 @@ class LimitInfoResponse(DataClassJsonMixin): @dataclass class LimitsSettings(DataClassJsonMixin): - max_participants_exclude_roles: list[str] = dc_field( + max_participants_exclude_roles: List[str] = dc_field( metadata=dc_config(field_name="max_participants_exclude_roles") ) - max_duration_seconds: int | None = dc_field( + max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) - max_participants: int | None = dc_field( + max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) - max_participants_exclude_owner: bool | None = dc_field( + 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: int | None = dc_field( + max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) - max_participants: int | None = dc_field( + max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) - max_participants_exclude_owner: bool | None = dc_field( + max_participants_exclude_owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_owner") ) - max_participants_exclude_roles: list[str] | None = dc_field( + 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( + max_participants_exclude_roles: List[str] = dc_field( metadata=dc_config(field_name="max_participants_exclude_roles") ) - max_duration_seconds: int | None = dc_field( + max_duration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_duration_seconds") ) - max_participants: int | None = dc_field( + max_participants: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_participants") ) - max_participants_exclude_owner: bool | None = dc_field( + max_participants_exclude_owner: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="max_participants_exclude_owner") ) @@ -16453,10 +18708,10 @@ class LimitsSettingsResponse(DataClassJsonMixin): class ListBlockListResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - blocklists: "list[BlockListResponse]" = dc_field( + blocklists: "List[BlockListResponse]" = dc_field( metadata=dc_config(field_name="blocklists") ) - next_cursor: str | None = dc_field( + next_cursor: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="next_cursor") ) @@ -16464,7 +18719,7 @@ class ListBlockListResponse(DataClassJsonMixin): @dataclass class ListCallTypeResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - call_types: "dict[str, CallTypeResponse]" = dc_field( + call_types: "Dict[str, CallTypeResponse]" = dc_field( metadata=dc_config(field_name="call_types") ) @@ -16473,7 +18728,7 @@ class ListCallTypeResponse(DataClassJsonMixin): class ListChannelTypesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with all channel types - channel_types: "dict[str, ChannelTypeConfig | None]" = dc_field( + channel_types: "Dict[str, Optional[ChannelTypeConfig]]" = dc_field( metadata=dc_config(field_name="channel_types") ) @@ -16482,21 +18737,21 @@ class ListChannelTypesResponse(DataClassJsonMixin): 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")) + 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")) + 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( + external_storages: "Dict[str, ExternalStorageResponse]" = dc_field( metadata=dc_config(field_name="external_storages") ) @@ -16505,7 +18760,7 @@ class ListExternalStorageResponse(DataClassJsonMixin): 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( + groups: "Dict[str, FeedGroupResponse]" = dc_field( metadata=dc_config(field_name="groups") ) @@ -16514,7 +18769,7 @@ class ListFeedGroupsResponse(DataClassJsonMixin): 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( + views: "Dict[str, FeedViewResponse]" = dc_field( metadata=dc_config(field_name="views") ) @@ -16523,7 +18778,7 @@ class ListFeedViewsResponse(DataClassJsonMixin): 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( + feed_visibilities: "Dict[str, FeedVisibilityResponse]" = dc_field( metadata=dc_config(field_name="feed_visibilities") ) @@ -16532,18 +18787,18 @@ class ListFeedVisibilitiesResponse(DataClassJsonMixin): 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( + import_tasks: "List[ImportV2TaskItem]" = dc_field( metadata=dc_config(field_name="import_tasks") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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( + import_tasks: "List[ImportTask]" = dc_field( metadata=dc_config(field_name="import_tasks") ) @@ -16552,7 +18807,7 @@ class ListImportsResponse(DataClassJsonMixin): class ListPermissionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - permissions: "list[Permission]" = dc_field( + permissions: "List[Permission]" = dc_field( metadata=dc_config(field_name="permissions") ) @@ -16561,7 +18816,7 @@ class ListPermissionsResponse(DataClassJsonMixin): 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( + push_providers: "List[PushProviderResponse]" = dc_field( metadata=dc_config(field_name="push_providers") ) @@ -16570,7 +18825,7 @@ class ListPushProvidersResponse(DataClassJsonMixin): class ListQueuesResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - queues: "list[ModerationQueueResponse]" = dc_field( + queues: "List[ModerationQueueResponse]" = dc_field( metadata=dc_config(field_name="queues") ) @@ -16578,7 +18833,7 @@ class ListQueuesResponse(DataClassJsonMixin): @dataclass class ListRecordingsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - recordings: "list[CallRecording]" = dc_field( + recordings: "List[CallRecording]" = dc_field( metadata=dc_config(field_name="recordings") ) @@ -16587,14 +18842,14 @@ class ListRecordingsResponse(DataClassJsonMixin): 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")) + 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( + sip_inbound_routing_rules: "List[SIPInboundRoutingRuleResponse]" = dc_field( metadata=dc_config(field_name="sip_inbound_routing_rules") ) @@ -16603,7 +18858,7 @@ class ListSIPInboundRoutingRuleResponse(DataClassJsonMixin): 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( + sip_trunks: "List[SIPTrunkResponse]" = dc_field( metadata=dc_config(field_name="sip_trunks") ) @@ -16612,7 +18867,7 @@ class ListSIPTrunksResponse(DataClassJsonMixin): class ListTranscriptionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of transcriptions for the call - transcriptions: "list[CallTranscription]" = dc_field( + transcriptions: "List[CallTranscription]" = dc_field( metadata=dc_config(field_name="transcriptions") ) @@ -16621,7 +18876,7 @@ class ListTranscriptionsResponse(DataClassJsonMixin): class ListUserGroupsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of user groups - user_groups: "list[UserGroupResponse]" = dc_field( + user_groups: "List[UserGroupResponse]" = dc_field( metadata=dc_config(field_name="user_groups") ) @@ -16649,52 +18904,52 @@ class LocationResponse(DataClassJsonMixin): @dataclass class MarkActivityRequest(DataClassJsonMixin): # Whether to mark all activities as read - mark_all_read: bool | None = dc_field( + 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: bool | None = dc_field( + mark_all_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_all_seen") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + mark_watched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mark_watched") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkChannelsReadRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + 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: "dict[str, str] | None" = dc_field( + read_by_channel: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="read_by_channel") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MarkDeliveredRequest(DataClassJsonMixin): - latest_delivered_messages: "list[DeliveredMessagePayload] | None" = dc_field( + latest_delivered_messages: "Optional[List[DeliveredMessagePayload]]" = dc_field( default=None, metadata=dc_config(field_name="latest_delivered_messages") ) @@ -16708,18 +18963,18 @@ class MarkDeliveredResponse(DataClassJsonMixin): @dataclass class MarkReadRequest(DataClassJsonMixin): # ID of the message that is considered last read by client - message_id: str | None = dc_field( + 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: str | None = dc_field( + thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -16728,7 +18983,7 @@ class MarkReadRequest(DataClassJsonMixin): class MarkReadResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - event: "MarkReadResponseEvent | None" = dc_field( + event: "Optional[MarkReadResponseEvent]" = dc_field( default=None, metadata=dc_config(field_name="event") ) @@ -16747,7 +19002,7 @@ class MarkReadResponseEvent(DataClassJsonMixin): ) ) type: str = dc_field(metadata=dc_config(field_name="type")) - channel_last_message_at: datetime | None = dc_field( + channel_last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="channel_last_message_at", @@ -16756,18 +19011,18 @@ class MarkReadResponseEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - last_read_message_id: str | None = dc_field( + last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - thread: "ThreadResponse | None" = dc_field( + thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -16775,28 +19030,32 @@ class MarkReadResponseEvent(DataClassJsonMixin): @dataclass class MarkReviewedRequestPayload(DataClassJsonMixin): # Maximum content items to mark as reviewed - content_to_mark_as_reviewed_limit: int | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + 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: datetime | None = dc_field( + message_timestamp: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_timestamp", @@ -16806,14 +19065,14 @@ class MarkUnreadRequest(DataClassJsonMixin): ), ) # Mark a thread unread, specify one of the thread, message timestamp, or message id - thread_id: str | None = dc_field( + thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -16834,20 +19093,20 @@ class MatchedContent(DataClassJsonMixin): # 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: float | None = dc_field( + 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: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + 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: "list[Classification] | None" = dc_field( + 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: "list[Classification] | None" = dc_field( + ocr_classifications: "Optional[List[Classification]]" = dc_field( default=None, metadata=dc_config(field_name="ocr_classifications") ) @@ -16862,11 +19121,11 @@ class MaxStreakChangedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -16877,6 +19136,18 @@ class MaxStreakChangedEvent(DataClassJsonMixin): ) +@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 @@ -16890,29 +19161,29 @@ class MemberAddedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -16922,11 +19193,11 @@ class MemberAddedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -16944,31 +19215,31 @@ class MemberRemovedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -16978,11 +19249,11 @@ class MemberRemovedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -16990,9 +19261,9 @@ class MemberRemovedEvent(DataClassJsonMixin): @dataclass class MemberRequest(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) + role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # Custom data for this object - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -17019,11 +19290,11 @@ class MemberResponse(DataClassJsonMixin): ) 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")) + 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: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -17032,7 +19303,7 @@ class MemberResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) + role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) @dataclass @@ -17048,31 +19319,31 @@ class MemberUpdatedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -17082,11 +19353,11 @@ class MemberUpdatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17094,25 +19365,28 @@ class MemberUpdatedEvent(DataClassJsonMixin): @dataclass class MemberUserRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - invisible: bool | None = dc_field( + 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: str | None = dc_field( + language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) - teams: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -17122,7 +19396,7 @@ 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( + members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) @@ -17154,13 +19428,13 @@ class MembershipLevelResponse(DataClassJsonMixin): ) ) # Activity tags this membership level gives access to - tags: list[str] = dc_field(metadata=dc_config(field_name="tags")) + tags: List[str] = dc_field(metadata=dc_config(field_name="tags")) # Description of the membership level - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Custom data for the membership level - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -17168,12 +19442,12 @@ class MembershipLevelResponse(DataClassJsonMixin): @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: str | None = dc_field( + 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17183,7 +19457,7 @@ class MessageActionResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -17219,7 +19493,7 @@ class MessageDeletedEvent(DataClassJsonMixin): # 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")) + 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 @@ -17227,28 +19501,28 @@ class MessageDeletedEvent(DataClassJsonMixin): default="message.deleted", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent - channel_id: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + 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: bool | None = dc_field( + deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -17258,11 +19532,11 @@ class MessageDeletedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17288,7 +19562,7 @@ class MessageFlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - approved_at: datetime | None = dc_field( + approved_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="approved_at", @@ -17297,8 +19571,10 @@ class MessageFlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - rejected_at: datetime | None = dc_field( + 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", @@ -17307,7 +19583,7 @@ class MessageFlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - reviewed_at: datetime | None = dc_field( + reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", @@ -17316,29 +19592,29 @@ class MessageFlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - details: "FlagDetailsResponse | None" = dc_field( + details: "Optional[FlagDetailsResponse]" = dc_field( default=None, metadata=dc_config(field_name="details") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - moderation_feedback: "FlagFeedbackResponse | None" = dc_field( + moderation_feedback: "Optional[FlagFeedbackResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_feedback") ) # Result of the message moderation - moderation_result: "MessageModerationResult | None" = dc_field( + moderation_result: "Optional[MessageModerationResult]" = dc_field( default=None, metadata=dc_config(field_name="moderation_result") ) # User response object - reviewed_by: "UserResponse | None" = dc_field( + reviewed_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="reviewed_by") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17362,26 +19638,28 @@ class MessageFlaggedEvent(DataClassJsonMixin): default="message.flagged", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent - channel_id: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The reason for the flag - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - received_at: datetime | None = dc_field( + 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", @@ -17391,26 +19669,26 @@ class MessageFlaggedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The total number of flags for the user - total_flags: int | None = dc_field( + total_flags: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="total_flags") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Custom data - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Result of the message moderation - details: "MessageModerationResult | None" = dc_field( + details: "Optional[MessageModerationResult]" = dc_field( default=None, metadata=dc_config(field_name="details") ) - flag: "FlagResponse | None" = dc_field( + flag: "Optional[FlagResponse]" = dc_field( default=None, metadata=dc_config(field_name="flag") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17431,10 +19709,10 @@ class MessageHistoryEntryResponse(DataClassJsonMixin): metadata=dc_config(field_name="message_updated_by_id") ) text: str = dc_field(metadata=dc_config(field_name="text")) - attachments: "list[Attachment]" = dc_field( + attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) @dataclass @@ -17466,22 +19744,23 @@ class MessageModerationResult(DataClassJsonMixin): # Karma of the user user_karma: float = dc_field(metadata=dc_config(field_name="user_karma")) # Word that was blocked - blocked_word: str | None = dc_field( + blocked_word: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocked_word") ) # Name of the blocklist - blocklist_name: str | None = dc_field( + blocklist_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_name") ) # User who moderated the message - moderated_by: str | None = dc_field( + moderated_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderated_by") ) - ai_moderation_response: "ModerationResponse | None" = dc_field( + # 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: "Thresholds | None" = dc_field( + moderation_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="moderation_thresholds") ) @@ -17500,34 +19779,34 @@ class MessageNewEvent(DataClassJsonMixin): 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The author of the parent message - parent_author: str | None = dc_field( + parent_author: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_author") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -17537,42 +19816,42 @@ class MessageNewEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - total_unread_count: int | None = dc_field( + 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: int | None = dc_field( + unread_channels: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_channels") ) # The number of unread messages - unread_count: int | None = dc_field( + unread_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_count") ) # The participants of the thread - thread_participants: "list[UserResponseCommonFields] | None" = dc_field( + thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) - grouped_unread_channels: "dict[str, int] | None" = dc_field( + grouped_unread_channels: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="grouped_unread_channels") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class MessageOptions(DataClassJsonMixin): - include_thread_participants: bool | None = dc_field( + include_thread_participants: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_thread_participants") ) - member_custom_include: list[str] | None = dc_field( + member_custom_include: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="member_custom_include") ) @@ -17580,7 +19859,7 @@ class MessageOptions(DataClassJsonMixin): @dataclass class MessagePaginationParams(DataClassJsonMixin): # The timestamp to get messages with a created_at timestamp greater than - created_at_after: datetime | None = dc_field( + created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", @@ -17590,7 +19869,7 @@ class MessagePaginationParams(DataClassJsonMixin): ), ) # The timestamp to get messages with a created_at timestamp greater than or equal to - created_at_after_or_equal: datetime | None = dc_field( + created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", @@ -17600,7 +19879,7 @@ class MessagePaginationParams(DataClassJsonMixin): ), ) # 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: datetime | None = dc_field( + created_at_around: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_around", @@ -17610,7 +19889,7 @@ class MessagePaginationParams(DataClassJsonMixin): ), ) # The timestamp to get messages with a created_at timestamp smaller than - created_at_before: datetime | None = dc_field( + created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", @@ -17620,7 +19899,7 @@ class MessagePaginationParams(DataClassJsonMixin): ), ) # The timestamp to get messages with a created_at timestamp smaller than or equal to - created_at_before_or_equal: datetime | None = dc_field( + created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", @@ -17630,19 +19909,29 @@ class MessagePaginationParams(DataClassJsonMixin): ), ) # 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id_gt")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id_gte")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id_lt")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id_lte")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) @dataclass @@ -17656,32 +19945,32 @@ class MessageReadEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the last read message - last_read_message_id: str | None = dc_field( + last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -17691,18 +19980,18 @@ class MessageReadEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) - thread: "ThreadResponse | None" = dc_field( + thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17710,23 +19999,23 @@ class MessageReadEvent(DataClassJsonMixin): @dataclass class MessageRequest(DataClassJsonMixin): # Contains HTML markup of the message. Can only be set when using server-side API - html: str | None = dc_field(default=None, metadata=dc_config(field_name="html")) + html: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="html")) # Message ID is unique string identifier of the message - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - mentioned_channel: bool | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) + mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires - pin_expires: datetime | None = dc_field( + pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", @@ -17736,11 +20025,11 @@ class MessageRequest(DataClassJsonMixin): ), ) # Whether message is pinned or not - pinned: bool | None = dc_field( + pinned: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pinned") ) # Date when message got pinned - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -17750,54 +20039,54 @@ class MessageRequest(DataClassJsonMixin): ), ) # Identifier of the poll to include in the message - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + 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: bool | None = dc_field( + show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) # Whether message is silent or not - silent: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # Contains type of the message. One of: regular, system - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - user_id: str | None = dc_field( + 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: "list[Attachment] | None" = dc_field( + 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: list[str] | None = dc_field( + mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) - mentioned_roles: list[str] | None = dc_field( + mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) # Array of user IDs to mention - mentioned_users: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + restricted_visibility: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="restricted_visibility") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - shared_location: "SharedLocation | None" = dc_field( + shared_location: "Optional[SharedLocation]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -17850,42 +20139,42 @@ class MessageResponse(DataClassJsonMixin): ) ) # Array of message attachments - attachments: "list[Attachment]" = dc_field( + 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( + latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # List of mentioned users - mentioned_users: "list[UserResponse]" = dc_field( + 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( + 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( + 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")) + 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( + 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( + 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: str | None = dc_field( + command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) # Date/time of deletion - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -17894,10 +20183,10 @@ class MessageResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_for_me: bool | None = dc_field( + deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) - message_text_updated_at: datetime | None = dc_field( + message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", @@ -17907,13 +20196,13 @@ class MessageResponse(DataClassJsonMixin): ), ) # Should be empty if `text` is provided. Can only be set when using server-side API - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) + mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires - pin_expires: datetime | None = dc_field( + pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", @@ -17923,7 +20212,7 @@ class MessageResponse(DataClassJsonMixin): ), ) # Date when message got pinned - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -17933,80 +20222,80 @@ class MessageResponse(DataClassJsonMixin): ), ) # Identifier of the poll to include in the message - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + 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: bool | None = dc_field( + 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: list[str] | None = dc_field( + 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: "list[UserGroupResponse] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: "list[UserResponse] | None" = dc_field( + thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - draft: "DraftResponse | None" = dc_field( + 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: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) # Contains image moderation information - image_labels: "dict[str, list[str]] | None" = dc_field( + image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) - member: "ChannelMemberPartialResponse | None" = dc_field( + 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: "dict[str, ChannelMemberPartialResponse] | None" = ( + mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object - pinned_by: "UserResponse | None" = dc_field( + pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message - quoted_message: "MessageResponse | None" = dc_field( + quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) - reaction_groups: "dict[str, ReactionGroupResponse | None] | None" = dc_field( + reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) - reminder: "ReminderResponseData | None" = dc_field( + reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) - shared_location: "SharedLocationResponseData | None" = dc_field( + shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @dataclass class MessageStatsResponse(DataClassJsonMixin): - count_over_time: "list[CountByMinuteResponse] | None" = dc_field( + count_over_time: "Optional[List[CountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) @@ -18023,7 +20312,7 @@ class MessageUnblockedEvent(DataClassJsonMixin): ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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 @@ -18031,8 +20320,8 @@ class MessageUnblockedEvent(DataClassJsonMixin): default="message.unblocked", metadata=dc_config(field_name="type") ) # The CID of the channel where the message was unblocked - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -18041,7 +20330,7 @@ class MessageUnblockedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -18058,7 +20347,7 @@ class MessageUndeletedEvent(DataClassJsonMixin): ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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 @@ -18066,24 +20355,24 @@ class MessageUndeletedEvent(DataClassJsonMixin): default="message.undeleted", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent - channel_id: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -18093,18 +20382,18 @@ class MessageUndeletedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: str | None = dc_field( + old_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="old_text") ) - change_set: "MessageChangeSet | None" = dc_field( + change_set: "Optional[MessageChangeSet]" = dc_field( default=None, metadata=dc_config(field_name="change_set") ) @@ -18121,7 +20410,7 @@ class MessageUpdatedEvent(DataClassJsonMixin): ) ) message_id: str = dc_field(metadata=dc_config(field_name="message_id")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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 @@ -18129,24 +20418,24 @@ class MessageUpdatedEvent(DataClassJsonMixin): default="message.updated", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent - channel_id: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -18156,14 +20445,14 @@ class MessageUpdatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "MessageUpdate | None" = dc_field( + message_update: "Optional[MessageUpdate]" = dc_field( default=None, metadata=dc_config(field_name="message_update") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -18216,44 +20505,44 @@ class MessageWithChannelResponse(DataClassJsonMixin): ) ) # Array of message attachments - attachments: "list[Attachment]" = dc_field( + 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( + latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) # List of mentioned users - mentioned_users: "list[UserResponse]" = dc_field( + 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( + 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( + 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")) + 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( + 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( + 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: str | None = dc_field( + command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) # Date/time of deletion - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -18262,10 +20551,10 @@ class MessageWithChannelResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_for_me: bool | None = dc_field( + deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) - message_text_updated_at: datetime | None = dc_field( + message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", @@ -18275,13 +20564,13 @@ class MessageWithChannelResponse(DataClassJsonMixin): ), ) # Should be empty if `text` is provided. Can only be set when using server-side API - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) + mml: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="mml")) # ID of parent message (thread) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) # Date when pinned message expires - pin_expires: datetime | None = dc_field( + pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", @@ -18291,7 +20580,7 @@ class MessageWithChannelResponse(DataClassJsonMixin): ), ) # Date when message got pinned - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -18301,73 +20590,73 @@ class MessageWithChannelResponse(DataClassJsonMixin): ), ) # Identifier of the poll to include in the message - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + 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: bool | None = dc_field( + 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: list[str] | None = dc_field( + 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: "list[UserGroupResponse] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: "list[UserResponse] | None" = dc_field( + thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - draft: "DraftResponse | None" = dc_field( + 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: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) # Contains image moderation information - image_labels: "dict[str, list[str]] | None" = dc_field( + image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) - member: "ChannelMemberPartialResponse | None" = dc_field( + 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: "dict[str, ChannelMemberPartialResponse] | None" = ( + mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object - pinned_by: "UserResponse | None" = dc_field( + pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message - quoted_message: "MessageResponse | None" = dc_field( + quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) - reaction_groups: "dict[str, ReactionGroupResponse | None] | None" = dc_field( + reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) - reminder: "ReminderResponseData | None" = dc_field( + reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) - shared_location: "SharedLocationResponseData | None" = dc_field( + shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @@ -18375,10 +20664,10 @@ class MessageWithChannelResponse(DataClassJsonMixin): @dataclass class MetricDescriptor(DataClassJsonMixin): label: str = dc_field(metadata=dc_config(field_name="label")) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - unit: str | None = dc_field(default=None, metadata=dc_config(field_name="unit")) + unit: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="unit")) @dataclass @@ -18386,7 +20675,7 @@ 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: "list[DailyValue] | None" = dc_field( + daily: "Optional[List[DailyValue]]" = dc_field( default=None, metadata=dc_config(field_name="daily") ) @@ -18396,38 +20685,50 @@ 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: str | None = dc_field( + value_unit: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="value_unit") ) - window_seconds: int | None = dc_field( + window_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="window_seconds") ) @dataclass class MetricTimeSeries(DataClassJsonMixin): - data_points: "list[list[float]] | None" = dc_field( + data_points: "Optional[List[List[float]]]" = dc_field( default=None, metadata=dc_config(field_name="data_points") ) @dataclass class MetricsPct(DataClassJsonMixin): - freezes: float | None = dc_field( + freezes: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="freezes") ) - geo: float | None = dc_field(default=None, metadata=dc_config(field_name="geo")) - jitter: float | None = dc_field( + 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: float | None = dc_field( + latency: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latency") ) - quality_score: float | None = dc_field( + 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 @@ -18440,13 +20741,13 @@ class ModerationActionConfigResponse(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + id: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="id")) # Queue type this action config belongs to - queue_type: str | None = dc_field( + queue_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="queue_type") ) # Custom data for the action - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -18465,22 +20766,22 @@ class ModerationAnalysisFailedEvent(DataClassJsonMixin): default="moderation.analysis.failed", metadata=dc_config(field_name="type") ) # The moderation policy key the request targeted. - config_key: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18490,11 +20791,11 @@ class ModerationAnalysisFailedEvent(DataClassJsonMixin): ), ) # 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: "dict[str, str] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -18533,14 +20834,14 @@ class ModerationCallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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: str | None = dc_field( + 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: datetime | None = dc_field( + ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ended_at", @@ -18549,13 +20850,13 @@ class ModerationCallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - join_ahead_time_seconds: int | None = dc_field( + join_ahead_time_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="join_ahead_time_seconds") ) - routing_number: str | None = dc_field( + routing_number: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="routing_number") ) - starts_at: datetime | None = dc_field( + starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", @@ -18564,9 +20865,9 @@ class ModerationCallResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @@ -18593,11 +20894,11 @@ class ModerationCheckCompletedEvent(DataClassJsonMixin): 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18610,8 +20911,10 @@ class ModerationCheckCompletedEvent(DataClassJsonMixin): @dataclass class ModerationConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - created_at: datetime | None = dc_field( + _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", @@ -18620,9 +20923,9 @@ class ModerationConfig(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - key: str | None = dc_field(default=None, metadata=dc_config(field_name="key")) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - updated_at: datetime | None = dc_field( + 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", @@ -18631,47 +20934,50 @@ class ModerationConfig(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - supported_video_call_harm_types: list[str] | None = dc_field( + 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: "AIImageConfig | None" = dc_field( + ai_image_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_config") ) - ai_image_lite_config: "BodyguardImageAnalysisConfig | None" = dc_field( + ai_image_lite_config: "Optional[BodyguardImageAnalysisConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_lite_config") ) - ai_text_config: "AITextConfig | None" = dc_field( + ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) - ai_video_config: "AIVideoConfig | None" = dc_field( + ai_video_config: "Optional[AIVideoConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) - automod_platform_circumvention_config: "AutomodPlatformCircumventionConfig | None" = dc_field( + automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) - automod_semantic_filters_config: "AutomodSemanticFiltersConfig | None" = dc_field( - default=None, metadata=dc_config(field_name="automod_semantic_filters_config") + automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( + dc_field( + default=None, + metadata=dc_config(field_name="automod_semantic_filters_config"), + ) ) - automod_toxicity_config: "AutomodToxicityConfig | None" = dc_field( + automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) - block_list_config: "BlockListConfig | None" = dc_field( + block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) - flood_config: "FloodConfig | None" = dc_field( + flood_config: "Optional[FloodConfig]" = dc_field( default=None, metadata=dc_config(field_name="flood_config") ) - google_vision_config: "GoogleVisionConfig | None" = dc_field( + google_vision_config: "Optional[GoogleVisionConfig]" = dc_field( default=None, metadata=dc_config(field_name="google_vision_config") ) - llm_config: "LLMConfig | None" = dc_field( + llm_config: "Optional[LLMConfig]" = dc_field( default=None, metadata=dc_config(field_name="llm_config") ) - velocity_filter_config: "VelocityFilterConfig | None" = dc_field( + velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) - video_call_rule_config: "VideoCallRuleConfig | None" = dc_field( + video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @@ -18688,14 +20994,14 @@ class ModerationCustomActionEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18705,64 +21011,237 @@ class ModerationCustomActionEvent(DataClassJsonMixin): ), ) # Additional options passed to the custom action - action_options: dict[str, object] | None = dc_field( + action_options: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="action_options") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class ModerationDashboardPreferences(DataClassJsonMixin): - async_review_queue_upsert: bool | None = dc_field( + async_review_queue_upsert: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async_review_queue_upsert") ) - block_foreign_cdn_attachments: bool | None = dc_field( + block_foreign_cdn_attachments: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="block_foreign_cdn_attachments") ) - custom_views_enabled: bool | None = dc_field( + custom_views_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_views_enabled") ) - disable_audit_logs: bool | None = dc_field( + 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: bool | None = dc_field( + disable_flagging_reviewed_entity: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_flagging_reviewed_entity") ) - enforce_shadow_server_side: bool | None = dc_field( + enforce_shadow_server_side: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_shadow_server_side") ) - escalation_queue_enabled: bool | None = dc_field( + escalation_queue_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="escalation_queue_enabled") ) - flag_user_on_flagged_content: bool | None = dc_field( + flag_user_on_flagged_content: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="flag_user_on_flagged_content") ) - include_attachment_payload: bool | None = dc_field( + include_attachment_payload: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_attachment_payload") ) - media_queue_blur_enabled: bool | None = dc_field( + media_queue_blur_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="media_queue_blur_enabled") ) - allowed_moderation_action_reasons: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + escalation_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="escalation_reasons") ) - filterable_custom_keys: list[str] | None = dc_field( + filterable_custom_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filterable_custom_keys") ) - keyframe_classifications_map: "dict[str, dict[str, bool]] | None" = dc_field( + keyframe_classifications_map: "Optional[Dict[str, Dict[str, bool]]]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_classifications_map") ) - overview_dashboard: "OverviewDashboardConfig | None" = dc_field( + 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( @@ -18785,10 +21264,10 @@ class ModerationFlagResponse(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - result: "list[dict[str, object]]" = dc_field( + result: "List[Dict[str, object]]" = dc_field( metadata=dc_config(field_name="result") ) - content_published_at: datetime | None = dc_field( + content_published_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="content_published_at", @@ -18797,28 +21276,32 @@ class ModerationFlagResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - entity_creator_id: str | None = dc_field( + entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - review_queue_item_id: str | None = dc_field( + # 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: list[str] | None = dc_field( + labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Content payload for moderation - moderation_payload: "ModerationPayloadResponse | None" = dc_field( + moderation_payload: "Optional[ModerationPayloadResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) - review_queue_item: "ReviewQueueItemResponse | None" = dc_field( + review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -18837,11 +21320,11 @@ class ModerationFlaggedEvent(DataClassJsonMixin): ) # 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18867,22 +21350,22 @@ class ModerationImageAnalysisCompleteEvent(DataClassJsonMixin): metadata=dc_config(field_name="type"), ) # The moderation policy key that was applied. - config_key: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18892,19 +21375,19 @@ class ModerationImageAnalysisCompleteEvent(DataClassJsonMixin): ), ) # Review queue row ID for deep-linking into the dashboard. - review_queue_item_id: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + 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: "dict[str, AnalyzeImageField] | None" = dc_field( + 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: "dict[str, AnalyzeTextField] | None" = dc_field( + texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @@ -18919,12 +21402,12 @@ class ModerationMarkReviewedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -18934,41 +21417,47 @@ class ModerationMarkReviewedEvent(DataClassJsonMixin): ), ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class ModerationPayload(DataClassJsonMixin): - audios: list[str] | None = dc_field( + 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") ) - image_ordered_keys: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + images: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="images") ) - other_media: list[str] | None = dc_field( + other_media: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="other_media") ) - text_ordered_keys: list[str] | None = dc_field( + text_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_ordered_keys") ) - texts: list[str] | None = dc_field( + texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) - videos: list[str] | None = dc_field( + videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - image_ids: "dict[str, str] | None" = dc_field( + image_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="image_ids") ) - text_ids: "dict[str, str] | None" = dc_field( + text_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="text_ids") ) @@ -18976,23 +21465,23 @@ class ModerationPayload(DataClassJsonMixin): @dataclass class ModerationPayloadRequest(DataClassJsonMixin): # Audio URLs to moderate - audios: list[str] | None = dc_field( + audios: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="audios") ) # Image URLs to moderate (max 30) - images: list[str] | None = dc_field( + images: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="images") ) # Text content to moderate - texts: list[str] | None = dc_field( + texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) # Video URLs to moderate - videos: list[str] | None = dc_field( + videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) # Custom data for moderation - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -19000,43 +21489,43 @@ class ModerationPayloadRequest(DataClassJsonMixin): @dataclass class ModerationPayloadResponse(DataClassJsonMixin): # Audio URLs to moderate - audios: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + image_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_ordered_keys") ) # Image URLs to moderate - images: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + text_ordered_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_ordered_keys") ) # Text content to moderate - texts: list[str] | None = dc_field( + texts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="texts") ) # Video URLs to moderate - videos: list[str] | None = dc_field( + videos: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="videos") ) # Custom data for moderation - custom: dict[str, object] | None = dc_field( + 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: "dict[str, str] | None" = dc_field( + 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: "dict[str, str] | None" = dc_field( + text_ids: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="text_ids") ) @@ -19065,15 +21554,19 @@ class ModerationQueueResponse(DataClassJsonMixin): 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")) + 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")) @@ -19109,21 +21602,23 @@ class ModerationRuleV2Response(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - config_keys: list[str] = dc_field(metadata=dc_config(field_name="config_keys")) - cooldown_period: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="logic")) - action_sequences: "list[CallRuleActionSequence] | None" = dc_field( + 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: "list[RuleBuilderCondition] | None" = dc_field( + conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) - groups: "list[RuleBuilderConditionGroup] | None" = dc_field( + groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) - action: "RuleBuilderAction | None" = dc_field( + action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) @@ -19145,15 +21640,27 @@ class ModerationRulesTriggeredEvent(DataClassJsonMixin): # 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( + 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")) + 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") ) - received_at: datetime | None = dc_field( + # 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", @@ -19163,17 +21670,47 @@ class ModerationRulesTriggeredEvent(DataClassJsonMixin): ), ) # The review queue item ID if applicable - review_queue_item_id: str | None = dc_field( + 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: int | None = dc_field( + 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: "list[MatchedContent] | None" = dc_field( + 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 @@ -19191,22 +21728,22 @@ class ModerationTextAnalysisCompleteEvent(DataClassJsonMixin): metadata=dc_config(field_name="type"), ) # The moderation policy key that was applied. - config_key: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + entity_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_type") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -19216,15 +21753,15 @@ class ModerationTextAnalysisCompleteEvent(DataClassJsonMixin): ), ) # Review queue row ID for deep-linking into the dashboard. - review_queue_item_id: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + 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: "dict[str, AnalyzeTextField] | None" = dc_field( + texts: "Optional[Dict[str, AnalyzeTextField]]" = dc_field( default=None, metadata=dc_config(field_name="texts") ) @@ -19233,22 +21770,22 @@ class ModerationTextAnalysisCompleteEvent(DataClassJsonMixin): 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: str | None = dc_field( + blocklist_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist_matched") ) - platform_circumvented: bool | None = dc_field( + platform_circumvented: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="platform_circumvented") ) - semantic_filter_matched: str | None = dc_field( + semantic_filter_matched: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_matched") ) - blocklists_matched: list[str] | None = dc_field( + blocklists_matched: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklists_matched") ) - image_harms: list[str] | None = dc_field( + image_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_harms") ) - text_harms: list[str] | None = dc_field( + text_harms: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="text_harms") ) @@ -19256,18 +21793,18 @@ class ModerationV2Response(DataClassJsonMixin): @dataclass class MuteChannelRequest(DataClassJsonMixin): # Duration of mute in milliseconds - expiration: int | None = dc_field( + expiration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="expiration") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Channel CIDs to mute (if multiple channels) - channel_cids: list[str] | None = dc_field( + channel_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_cids") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -19276,13 +21813,13 @@ class MuteChannelRequest(DataClassJsonMixin): class MuteChannelResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with mutes (if multiple channels were muted) - channel_mutes: "list[ChannelMute] | None" = dc_field( + channel_mutes: "Optional[List[ChannelMute]]" = dc_field( default=None, metadata=dc_config(field_name="channel_mutes") ) - channel_mute: "ChannelMute | None" = dc_field( + channel_mute: "Optional[ChannelMute]" = dc_field( default=None, metadata=dc_config(field_name="channel_mute") ) - own_user: "OwnUserResponse | None" = dc_field( + own_user: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_user") ) @@ -19290,16 +21827,16 @@ class MuteChannelResponse(DataClassJsonMixin): @dataclass class MuteRequest(DataClassJsonMixin): # User IDs to mute (if multiple users) - target_ids: list[str] = dc_field(metadata=dc_config(field_name="target_ids")) + target_ids: List[str] = dc_field(metadata=dc_config(field_name="target_ids")) # Duration of mute in minutes - timeout: int | None = dc_field( + timeout: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="timeout") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -19308,39 +21845,43 @@ class MuteRequest(DataClassJsonMixin): class MuteResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Object with mutes (if multiple users were muted) - mutes: "list[UserMuteResponse] | None" = dc_field( + 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: list[str] | None = dc_field( + non_existing_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="non_existing_users") ) - own_user: "OwnUserResponse | None" = dc_field( + own_user: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="own_user") ) @dataclass class MuteUsersRequest(DataClassJsonMixin): - audio: bool | None = dc_field(default=None, metadata=dc_config(field_name="audio")) - mute_all_users: bool | None = dc_field( + 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: str | None = dc_field( + muted_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="muted_by_id") ) - screenshare: bool | None = dc_field( + screenshare: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="screenshare") ) - screenshare_audio: bool | None = dc_field( + screenshare_audio: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="screenshare_audio") ) - video: bool | None = dc_field(default=None, metadata=dc_config(field_name="video")) - user_ids: list[str] | None = dc_field( + 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: "UserRequest | None" = dc_field( + muted_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="muted_by") ) @@ -19353,31 +21894,40 @@ class MuteUsersResponse(DataClassJsonMixin): @dataclass class NetworkMetricsReportResponse(DataClassJsonMixin): - average_connection_time: float | None = dc_field( + average_connection_time: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_connection_time") ) - average_jitter: float | None = dc_field( + average_jitter: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_jitter") ) - average_latency: float | None = dc_field( + average_latency: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_latency") ) - average_time_to_reconnect: float | None = dc_field( + average_time_to_reconnect: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="average_time_to_reconnect") ) @dataclass class NoiseCancellationSettings(DataClassJsonMixin): - mode: str = dc_field(metadata=dc_config(field_name="mode")) + # 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")) - attachments: "list[Attachment] | None" = dc_field( + # 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") ) @@ -19385,25 +21935,25 @@ class NotificationComment(DataClassJsonMixin): @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: str | None = dc_field( + deduplication_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="deduplication_window") ) # Whether to track read status - track_read: bool | None = dc_field( + track_read: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_read") ) # Whether to track seen status - track_seen: bool | None = dc_field( + track_seen: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_seen") ) @dataclass class NotificationContext(DataClassJsonMixin): - target: "NotificationTarget | None" = dc_field( + target: "Optional[NotificationTarget]" = dc_field( default=None, metadata=dc_config(field_name="target") ) - trigger: "NotificationTrigger | None" = dc_field( + trigger: "Optional[NotificationTrigger]" = dc_field( default=None, metadata=dc_config(field_name="trigger") ) @@ -19421,15 +21971,16 @@ class NotificationFeedUpdatedEvent(DataClassJsonMixin): ) # 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -19439,13 +21990,13 @@ class NotificationFeedUpdatedEvent(DataClassJsonMixin): ), ) # Aggregated activities for notification feeds - aggregated_activities: "list[AggregatedActivityResponse] | None" = dc_field( + aggregated_activities: "Optional[List[AggregatedActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="aggregated_activities") ) - notification_status: "NotificationStatusResponse | None" = dc_field( + notification_status: "Optional[NotificationStatusResponse]" = dc_field( default=None, metadata=dc_config(field_name="notification_status") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -19461,34 +22012,34 @@ class NotificationMarkUnreadEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + 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: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The ID of the first unread message - first_unread_message_id: str | None = dc_field( + 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: datetime | None = dc_field( + last_read_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_read_at", @@ -19498,10 +22049,10 @@ class NotificationMarkUnreadEvent(DataClassJsonMixin): ), ) # The ID of the last read message - last_read_message_id: str | None = dc_field( + last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -19511,46 +22062,46 @@ class NotificationMarkUnreadEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + 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: str | None = dc_field( + thread_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thread_id") ) # The total number of unread messages - total_unread_count: int | None = dc_field( + 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: int | None = dc_field( + unread_channels: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_channels") ) # The total number of unread messages - unread_count: int | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + unread_thread_messages: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_thread_messages") ) # The number of unread threads - unread_threads: int | None = dc_field( + unread_threads: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_threads") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) - grouped_unread_channels: "dict[str, int] | None" = dc_field( + grouped_unread_channels: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="grouped_unread_channels") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -19558,12 +22109,12 @@ class NotificationMarkUnreadEvent(DataClassJsonMixin): @dataclass class NotificationParentActivity(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - user_id: str | None = dc_field( + 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: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) @@ -19590,22 +22141,22 @@ class NotificationSettings(DataClassJsonMixin): @dataclass class NotificationSettingsRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - call_live_started: "EventNotificationSettingsRequest | None" = dc_field( + call_live_started: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_live_started") ) - call_missed: "EventNotificationSettingsRequest | None" = dc_field( + call_missed: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_missed") ) - call_notification: "EventNotificationSettingsRequest | None" = dc_field( + call_notification: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_notification") ) - call_ring: "EventNotificationSettingsRequest | None" = dc_field( + call_ring: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_ring") ) - session_started: "EventNotificationSettingsRequest | None" = dc_field( + session_started: "Optional[EventNotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="session_started") ) @@ -19637,7 +22188,7 @@ class NotificationStatusResponse(DataClassJsonMixin): # Number of unseen notifications unseen: int = dc_field(metadata=dc_config(field_name="unseen")) # When notifications were last read - last_read_at: datetime | None = dc_field( + last_read_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_read_at", @@ -19647,7 +22198,7 @@ class NotificationStatusResponse(DataClassJsonMixin): ), ) # When notifications were last seen - last_seen_at: datetime | None = dc_field( + last_seen_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_seen_at", @@ -19657,11 +22208,11 @@ class NotificationStatusResponse(DataClassJsonMixin): ), ) # 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + seen_activities: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="seen_activities") ) @@ -19671,27 +22222,27 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # The text content of the target activity (for activity targets) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) + text: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="text")) # The type of the target activity (for activity targets) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Attachments on the target activity (for activity targets) - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) - comment: "NotificationComment | None" = dc_field( + comment: "Optional[NotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data from the target activity - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - parent_activity: "NotificationParentActivity | None" = dc_field( + parent_activity: "Optional[NotificationParentActivity]" = dc_field( default=None, metadata=dc_config(field_name="parent_activity") ) @@ -19714,7 +22265,7 @@ class NotificationThreadMessageNewEvent(DataClassJsonMixin): 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")) + 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 @@ -19722,25 +22273,25 @@ class NotificationThreadMessageNewEvent(DataClassJsonMixin): default="notification.thread_message_new", metadata=dc_config(field_name="type") ) # The ID of the channel where the message was sent - channel_id: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_member_count: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - parent_author: str | None = dc_field( + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -19750,18 +22301,18 @@ class NotificationThreadMessageNewEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - unread_thread_messages: int | None = dc_field( + 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: int | None = dc_field( + unread_threads: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="unread_threads") ) # The participants of the thread - thread_participants: "list[UserResponseCommonFields] | None" = dc_field( + thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) @@ -19772,31 +22323,32 @@ class NotificationTrigger(DataClassJsonMixin): 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: "NotificationComment | None" = dc_field( + comment: "Optional[NotificationComment]" = dc_field( default=None, metadata=dc_config(field_name="comment") ) # Custom data from the trigger object (comment, reaction, etc.) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class OCRContentParameters(DataClassJsonMixin): - label_operator: str | None = dc_field( + label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @dataclass class OCRRule(DataClassJsonMixin): - action: str = dc_field(metadata=dc_config(field_name="action")) + # 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")) @@ -19807,10 +22359,10 @@ class OnlyUserID(DataClassJsonMixin): @dataclass class OverviewDashboardConfig(DataClassJsonMixin): - default_date_range_days: int | None = dc_field( + default_date_range_days: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="default_date_range_days") ) - visible_charts: list[str] | None = dc_field( + visible_charts: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="visible_charts") ) @@ -19818,16 +22370,16 @@ class OverviewDashboardConfig(DataClassJsonMixin): @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: str | None = dc_field( + 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: list[str] | None = dc_field( + fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="fields") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -19836,7 +22388,7 @@ class OwnBatchRequest(DataClassJsonMixin): 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")) + data: "Dict[str, FeedOwnData]" = dc_field(metadata=dc_config(field_name="data")) OwnCapabilityType = NewType("OwnCapabilityType", str) @@ -19905,6 +22457,8 @@ class OwnUserResponse(DataClassJsonMixin): 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( @@ -19915,17 +22469,20 @@ class OwnUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - channel_mutes: "list[ChannelMute]" = dc_field( + 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: int | None = dc_field( + 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: datetime | None = dc_field( + deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", @@ -19934,7 +22491,7 @@ class OwnUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -19943,8 +22500,10 @@ class OwnUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - last_active: datetime | None = dc_field( + 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", @@ -19953,8 +22512,8 @@ class OwnUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - revoke_tokens_issued_before: datetime | None = dc_field( + 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", @@ -19963,55 +22522,74 @@ class OwnUserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - blocked_user_ids: list[str] | None = dc_field( - default=None, metadata=dc_config(field_name="blocked_user_ids") - ) - latest_hidden_channels: list[str] | None = dc_field( + latest_hidden_channels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="latest_hidden_channels") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - push_preferences: "PushPreferencesResponse | None" = dc_field( + # The push preference details. + push_preferences: "Optional[PushPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_preferences") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) - total_unread_count_by_team: "dict[str, int] | None" = dc_field( + 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 PagerRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) +class PagerDefaults(DataClassJsonMixin): + # Number of records returned when `limit` is omitted. + limit: int = dc_field(metadata=dc_config(field_name="limit")) @dataclass -class PagerResponse(DataClassJsonMixin): - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) +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 PaginationParams(DataClassJsonMixin): - id_gt: int | None = dc_field(default=None, metadata=dc_config(field_name="id_gt")) - id_gte: int | None = dc_field(default=None, metadata=dc_config(field_name="id_gte")) - id_lt: int | None = dc_field(default=None, metadata=dc_config(field_name="id_lt")) - id_lte: int | None = dc_field(default=None, metadata=dc_config(field_name="id_lte")) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) +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 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: "list[SortParamRequest] | None" = dc_field( - default=None, metadata=dc_config(field_name="sort") +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") ) @@ -20033,7 +22611,7 @@ class ParticipantCountByMinuteResponse(DataClassJsonMixin): @dataclass class ParticipantCountOverTimeResponse(DataClassJsonMixin): - by_minute: "list[ParticipantCountByMinuteResponse] | None" = dc_field( + by_minute: "Optional[List[ParticipantCountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_minute") ) @@ -20042,66 +22620,66 @@ class ParticipantCountOverTimeResponse(DataClassJsonMixin): 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: int | None = dc_field( + max_concurrent: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_concurrent") ) - by_browser: "list[GroupedStatsResponse] | None" = dc_field( + by_browser: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_browser") ) - by_country: "list[GroupedStatsResponse] | None" = dc_field( + by_country: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_country") ) - by_device: "list[GroupedStatsResponse] | None" = dc_field( + by_device: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_device") ) - by_operating_system: "list[GroupedStatsResponse] | None" = dc_field( + by_operating_system: "Optional[List[GroupedStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_operating_system") ) - count_over_time: "ParticipantCountOverTimeResponse | None" = dc_field( + count_over_time: "Optional[ParticipantCountOverTimeResponse]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) - publishers: "PublisherStatsResponse | None" = dc_field( + publishers: "Optional[PublisherStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) - subscribers: "SubscriberStatsResponse | None" = dc_field( + subscribers: "Optional[SubscriberStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @dataclass class ParticipantSeriesPublisherStats(DataClassJsonMixin): - global_metrics_order: list[str] | None = dc_field( + global_metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="global_metrics_order") ) - _global: "dict[str, list[list[float]]] | None" = dc_field( + _global: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="global") ) - global_meta: "dict[str, MetricDescriptor] | None" = dc_field( + global_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="global_meta") ) - global_thresholds: "dict[str, list[MetricThreshold]] | None" = dc_field( + global_thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="global_thresholds") ) - tracks: "dict[str, list[ParticipantSeriesTrackMetrics]] | None" = dc_field( + tracks: "Optional[Dict[str, List[ParticipantSeriesTrackMetrics]]]" = dc_field( default=None, metadata=dc_config(field_name="tracks") ) @dataclass class ParticipantSeriesSubscriberStats(DataClassJsonMixin): - global_metrics_order: list[str] | None = dc_field( + global_metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="global_metrics_order") ) - subscriptions: "list[ParticipantSeriesSubscriptionTrackMetrics] | None" = dc_field( - default=None, metadata=dc_config(field_name="subscriptions") + subscriptions: "Optional[List[ParticipantSeriesSubscriptionTrackMetrics]]" = ( + dc_field(default=None, metadata=dc_config(field_name="subscriptions")) ) - _global: "dict[str, list[list[float]]] | None" = dc_field( + _global: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="global") ) - global_meta: "dict[str, MetricDescriptor] | None" = dc_field( + global_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="global_meta") ) - global_thresholds: "dict[str, list[MetricThreshold]] | None" = dc_field( + global_thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="global_thresholds") ) @@ -20111,13 +22689,13 @@ class ParticipantSeriesSubscriptionTrackMetrics(DataClassJsonMixin): publisher_user_id: str = dc_field( metadata=dc_config(field_name="publisher_user_id") ) - publisher_name: str | None = dc_field( + publisher_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_name") ) - publisher_user_session_id: str | None = dc_field( + publisher_user_session_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="publisher_user_session_id") ) - tracks: "dict[str, list[ParticipantSeriesTrackMetrics]] | None" = dc_field( + tracks: "Optional[Dict[str, List[ParticipantSeriesTrackMetrics]]]" = dc_field( default=None, metadata=dc_config(field_name="tracks") ) @@ -20147,38 +22725,42 @@ class ParticipantSeriesTimeframe(DataClassJsonMixin): @dataclass class ParticipantSeriesTrackMetrics(DataClassJsonMixin): track_id: str = dc_field(metadata=dc_config(field_name="track_id")) - codec: str | None = dc_field(default=None, metadata=dc_config(field_name="codec")) - label: str | None = dc_field(default=None, metadata=dc_config(field_name="label")) - rid: str | None = dc_field(default=None, metadata=dc_config(field_name="rid")) - track_type: str | None = dc_field( + 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: list[str] | None = dc_field( + metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="metrics_order") ) - metrics: "dict[str, list[list[float]]] | None" = dc_field( + metrics: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) - metrics_meta: "dict[str, MetricDescriptor] | None" = dc_field( + metrics_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="metrics_meta") ) - thresholds: "dict[str, list[MetricThreshold]] | None" = dc_field( + thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="thresholds") ) @dataclass class ParticipantSeriesUserStats(DataClassJsonMixin): - metrics_order: list[str] | None = dc_field( + metrics_order: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="metrics_order") ) - metrics: "dict[str, list[list[float]]] | None" = dc_field( + metrics: "Optional[Dict[str, List[List[float]]]]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) - metrics_meta: "dict[str, MetricDescriptor] | None" = dc_field( + metrics_meta: "Optional[Dict[str, MetricDescriptor]]" = dc_field( default=None, metadata=dc_config(field_name="metrics_meta") ) - thresholds: "dict[str, list[MetricThreshold]] | None" = dc_field( + thresholds: "Optional[Dict[str, List[MetricThreshold]]]" = dc_field( default=None, metadata=dc_config(field_name="thresholds") ) @@ -20188,11 +22770,11 @@ 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: int | None = dc_field( + 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: datetime | None = dc_field( + joined_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="joined_at", @@ -20201,7 +22783,7 @@ class ParticipantSessionDetails(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - left_at: datetime | None = dc_field( + left_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="left_at", @@ -20225,12 +22807,12 @@ class PendingMessageEvent(DataClassJsonMixin): ) # 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -20240,19 +22822,19 @@ class PendingMessageEvent(DataClassJsonMixin): ), ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Metadata attached to the pending message - metadata: "dict[str, str] | None" = dc_field( + metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="metadata") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -20260,18 +22842,18 @@ class PendingMessageEvent(DataClassJsonMixin): @dataclass class PendingMessageResponse(DataClassJsonMixin): # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - metadata: "dict[str, str] | None" = dc_field( + metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="metadata") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -20279,33 +22861,33 @@ class PendingMessageResponse(DataClassJsonMixin): @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")) + by_version: "Dict[str, int]" = dc_field(metadata=dc_config(field_name="by_version")) @dataclass class Percentiles(DataClassJsonMixin): - p50: float | None = dc_field(default=None, metadata=dc_config(field_name="p50")) - p95: float | None = dc_field(default=None, metadata=dc_config(field_name="p95")) + 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( + indexed_fields: List[str] = dc_field( metadata=dc_config(field_name="indexed_fields") ) - recommendations: list[str] = dc_field( + recommendations: List[str] = dc_field( metadata=dc_config(field_name="recommendations") ) - unindexed_fields: list[str] = dc_field( + unindexed_fields: List[str] = dc_field( metadata=dc_config(field_name="unindexed_fields") ) - unindexed_sort_fields: list[str] = dc_field( + 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: datetime | None = dc_field( + 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", @@ -20314,7 +22896,7 @@ class PerformanceAnalysisResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - scan_type: str | None = dc_field( + scan_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="scan_type") ) @@ -20340,9 +22922,9 @@ class Permission(DataClassJsonMixin): # 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")) + tags: List[str] = dc_field(metadata=dc_config(field_name="tags")) # MongoDB style condition which decides whether or not the permission is granted - condition: dict[str, object] | None = dc_field( + condition: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="condition") ) @@ -20354,15 +22936,17 @@ class PermissionRequest(DataClassJsonMixin): # 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")) + condition: Dict[str, object] = dc_field(metadata=dc_config(field_name="condition")) # Description of the permission - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether this permission applies to resource owner or not - owner: bool | None = dc_field(default=None, metadata=dc_config(field_name="owner")) + 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: bool | None = dc_field( + same_team: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="same_team") ) @@ -20379,7 +22963,7 @@ class PermissionRequestEvent(DataClassJsonMixin): ) ) # The list of permissions requested by the user - permissions: list[str] = dc_field(metadata=dc_config(field_name="permissions")) + 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 @@ -20391,14 +22975,14 @@ class PermissionRequestEvent(DataClassJsonMixin): @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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -20465,8 +23049,8 @@ class Policy(DataClassJsonMixin): 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")) + resources: List[str] = dc_field(metadata=dc_config(field_name="resources")) + roles: List[str] = dc_field(metadata=dc_config(field_name="roles")) @dataclass @@ -20484,9 +23068,9 @@ class PolicyRequest(DataClassJsonMixin): # 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")) + 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")) + roles: List[str] = dc_field(metadata=dc_config(field_name="roles")) @dataclass @@ -20510,43 +23094,45 @@ class PolicyTestResult(DataClassJsonMixin): 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: str | None = dc_field( + actual_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="actual_action") ) - expected_action: str | None = dc_field( + expected_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="expected_action") ) - failure_reason: str | None = dc_field( + failure_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="failure_reason") ) - passed: bool | None = dc_field( + passed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="passed") ) - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - actual_labels: list[str] | None = dc_field( + actual_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="actual_labels") ) - expected_labels: list[str] | None = dc_field( + expected_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="expected_labels") ) - raw_response: dict[str, object] | None = dc_field( + raw_response: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="raw_response") ) @dataclass class PolicyTestRow(DataClassJsonMixin): - content_type: str | None = dc_field( + content_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="content_type") ) - policy: str | None = dc_field(default=None, metadata=dc_config(field_name="policy")) - recommended_action: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - labels: list[str] | None = dc_field( + 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") ) @@ -20569,7 +23155,7 @@ class PolicyTestRun(DataClassJsonMixin): 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: datetime | None = dc_field( + completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", @@ -20578,7 +23164,7 @@ class PolicyTestRun(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - config_updated_at: datetime | None = dc_field( + config_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="config_updated_at", @@ -20587,10 +23173,10 @@ class PolicyTestRun(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - error_message: str | None = dc_field( + error_message: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="error_message") ) - started_at: datetime | None = dc_field( + started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="started_at", @@ -20599,7 +23185,7 @@ class PolicyTestRun(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - metrics: "PolicyTestRunMetrics | None" = dc_field( + metrics: "Optional[PolicyTestRunMetrics]" = dc_field( default=None, metadata=dc_config(field_name="metrics") ) @@ -20608,7 +23194,7 @@ class PolicyTestRun(DataClassJsonMixin): 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: "dict[str, PolicyTestLabelDrift] | None" = dc_field( + by_label: "Optional[Dict[str, PolicyTestLabelDrift]]" = dc_field( default=None, metadata=dc_config(field_name="by_label") ) @@ -20617,10 +23203,10 @@ class PolicyTestRunMetrics(DataClassJsonMixin): class PolicyTestRunResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Per-row results (only present once the run has finished) - results: "list[PolicyTestResult] | None" = dc_field( + results: "Optional[List[PolicyTestResult]]" = dc_field( default=None, metadata=dc_config(field_name="results") ) - run: "PolicyTestRun | None" = dc_field( + run: "Optional[PolicyTestRun]" = dc_field( default=None, metadata=dc_config(field_name="run") ) @@ -20630,7 +23216,7 @@ 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: list[str] | None = dc_field( + labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="labels") ) @@ -20659,11 +23245,11 @@ class PolicyTestSet(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - rows: "list[PolicyTestRow] | None" = dc_field( + 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: "PolicyTestRun | None" = dc_field( + last_run: "Optional[PolicyTestRun]" = dc_field( default=None, metadata=dc_config(field_name="last_run") ) @@ -20672,21 +23258,21 @@ class PolicyTestSet(DataClassJsonMixin): 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")) + 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: str | None = dc_field( + 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: "list[PolicyTestRun] | None" = dc_field( + recent_runs: "Optional[List[PolicyTestRun]]" = dc_field( default=None, metadata=dc_config(field_name="recent_runs") ) - set: "PolicyTestSet | None" = dc_field( + set: "Optional[PolicyTestSet]" = dc_field( default=None, metadata=dc_config(field_name="set") ) @@ -20700,10 +23286,80 @@ class PolicyTestTotals(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - custom: dict[str, object] | None = dc_field( + 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") ) @@ -20711,8 +23367,8 @@ class PollOptionInput(DataClassJsonMixin): @dataclass class PollOptionRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - custom: dict[str, object] | None = dc_field( + 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") ) @@ -20730,7 +23386,10 @@ class PollOptionResponse(DataClassJsonMixin): 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")) + 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 @@ -20772,45 +23431,206 @@ class PollResponseData(DataClassJsonMixin): ) vote_count: int = dc_field(metadata=dc_config(field_name="vote_count")) # Voting visibility of the poll - voting_visibility: str = dc_field( + voting_visibility: "VotingVisibility" = dc_field( metadata=dc_config(field_name="voting_visibility") ) - latest_answers: "list[PollVoteResponseData]" = dc_field( + latest_answers: "List[PollVoteResponseData]" = dc_field( metadata=dc_config(field_name="latest_answers") ) - options: "list[PollOptionResponseData]" = dc_field( + options: "List[PollOptionResponseData]" = dc_field( metadata=dc_config(field_name="options") ) - own_votes: "list[PollVoteResponseData]" = dc_field( + 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( + 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( + vote_counts_by_option: "Dict[str, int]" = dc_field( metadata=dc_config(field_name="vote_counts_by_option") ) - is_closed: bool | None = dc_field( + is_closed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_closed") ) - max_votes_allowed: int | None = dc_field( + max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) # User response object - created_by: "UserResponse | None" = dc_field( + 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: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) - vote: "PollVoteResponseData | None" = dc_field( + vote: "Optional[PollVoteResponseData]" = dc_field( default=None, metadata=dc_config(field_name="vote") ) @@ -20836,17 +23656,20 @@ class PollVoteResponseData(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - answer_text: str | None = dc_field( + answer_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="answer_text") ) - is_answer: bool | None = dc_field( + is_answer: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_answer") ) - user_id: str | None = dc_field( + 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: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -20856,11 +23679,11 @@ 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( + votes: "List[PollVoteResponseData]" = dc_field( metadata=dc_config(field_name="votes") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 @@ -20881,7 +23704,7 @@ class PoorTail(DataClassJsonMixin): metadata=dc_config(field_name="poor_by_cause") ) supporting: "Supporting" = dc_field(metadata=dc_config(field_name="supporting")) - healthy_pct: float | None = dc_field( + healthy_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="healthy_pct") ) @@ -20906,20 +23729,20 @@ class PredefinedFilterResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - filter: dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) - description: str | None = dc_field( + 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: int | None = dc_field( + query_id: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="query_id") ) - sort: "list[SortParam] | None" = dc_field( + sort: "Optional[List[SortParam]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) - performance: "PerformanceAnalysisResponse | None" = dc_field( + performance: "Optional[PerformanceAnalysisResponse]" = dc_field( default=None, metadata=dc_config(field_name="performance") ) - stats: "PredefinedFilterStatsResponse | None" = dc_field( + stats: "Optional[PredefinedFilterStatsResponse]" = dc_field( default=None, metadata=dc_config(field_name="stats") ) @@ -20928,7 +23751,7 @@ class PredefinedFilterResponse(DataClassJsonMixin): 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: datetime | None = dc_field( + last_seen: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_seen", @@ -20941,13 +23764,16 @@ class PredefinedFilterStatsResponse(DataClassJsonMixin): @dataclass class PrivacySettingsResponse(DataClassJsonMixin): - delivery_receipts: "DeliveryReceiptsResponse | None" = dc_field( + # The settings for the delivery receipt events. + delivery_receipts: "Optional[DeliveryReceiptsResponse]" = dc_field( default=None, metadata=dc_config(field_name="delivery_receipts") ) - read_receipts: "ReadReceiptsResponse | None" = dc_field( + # The settings for the read receipt events. + read_receipts: "Optional[ReadReceiptsResponse]" = dc_field( default=None, metadata=dc_config(field_name="read_receipts") ) - typing_indicators: "TypingIndicatorsResponse | None" = dc_field( + # The settings for typing indicator events. + typing_indicators: "Optional[TypingIndicatorsResponse]" = dc_field( default=None, metadata=dc_config(field_name="typing_indicators") ) @@ -20964,43 +23790,45 @@ class PublishedTrackFlags(DataClassJsonMixin): @dataclass class PublishedTrackMetrics(DataClassJsonMixin): - codec: str | None = dc_field(default=None, metadata=dc_config(field_name="codec")) - track_id: str | None = dc_field( + 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: str | None = dc_field( + track_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="track_type") ) - warnings: "list[SessionWarningResponse] | None" = dc_field( + warnings: "Optional[List[SessionWarningResponse]]" = dc_field( default=None, metadata=dc_config(field_name="warnings") ) - bitrate: "MetricTimeSeries | None" = dc_field( + bitrate: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) - framerate: "MetricTimeSeries | None" = dc_field( + framerate: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="framerate") ) - resolution: "ResolutionMetricsTimeSeries | None" = dc_field( + resolution: "Optional[ResolutionMetricsTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="resolution") ) @dataclass class PublisherAllMetrics(DataClassJsonMixin): - audio: "PublisherAudioMetrics | None" = dc_field( + audio: "Optional[PublisherAudioMetrics]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) - rtt_ms: "ActiveCallsLatencyStats | None" = dc_field( + rtt_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="rtt_ms") ) - video: "PublisherVideoMetrics | None" = dc_field( + video: "Optional[PublisherVideoMetrics]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class PublisherAudioMetrics(DataClassJsonMixin): - jitter_ms: "ActiveCallsLatencyStats | None" = dc_field( + jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) @@ -21013,22 +23841,24 @@ class PublisherSession(DataClassJsonMixin): ) 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: float | None = dc_field( + avg_jitter_ms: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="avg_jitter_ms") ) - browser: str | None = dc_field( + browser: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="browser") ) - delivery_zone: str | None = dc_field( + delivery_zone: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="delivery_zone") ) - ingest: str | None = dc_field(default=None, metadata=dc_config(field_name="ingest")) - os: str | None = dc_field(default=None, metadata=dc_config(field_name="os")) - send_quality_score: float | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="tool")) - encoding: "EncodingProfile | None" = dc_field( + 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") ) @@ -21037,33 +23867,33 @@ class PublisherSession(DataClassJsonMixin): 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: "list[TrackStatsResponse] | None" = dc_field( + by_track: "Optional[List[TrackStatsResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_track") ) @dataclass class PublisherVideoMetrics(DataClassJsonMixin): - bitrate: "ActiveCallsBitrateStats | None" = dc_field( + bitrate: "Optional[ActiveCallsBitrateStats]" = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) - fps_30: "ActiveCallsFPSStats | None" = dc_field( + fps_30: "Optional[ActiveCallsFPSStats]" = dc_field( default=None, metadata=dc_config(field_name="fps_30") ) - frame_encoding_time_ms: "ActiveCallsLatencyStats | None" = dc_field( + frame_encoding_time_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="frame_encoding_time_ms") ) - jitter_ms: "ActiveCallsLatencyStats | None" = dc_field( + jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) - resolution: "ActiveCallsResolutionStats | None" = dc_field( + resolution: "Optional[ActiveCallsResolutionStats]" = dc_field( default=None, metadata=dc_config(field_name="resolution") ) @dataclass class PublishersMetrics(DataClassJsonMixin): - all: "PublisherAllMetrics | None" = dc_field( + all: "Optional[PublisherAllMetrics]" = dc_field( default=None, metadata=dc_config(field_name="all") ) @@ -21071,19 +23901,30 @@ class PublishersMetrics(DataClassJsonMixin): @dataclass class PushConfig(DataClassJsonMixin): version: str = dc_field(metadata=dc_config(field_name="version")) - offline_only: bool | None = dc_field( + 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: bool | None = dc_field( + 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: list[str] | None = dc_field( + push_types: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="push_types") ) @@ -21098,17 +23939,17 @@ class PushNotificationFields(DataClassJsonMixin): ) huawei: "HuaweiConfigFields" = dc_field(metadata=dc_config(field_name="huawei")) xiaomi: "XiaomiConfigFields" = dc_field(metadata=dc_config(field_name="xiaomi")) - providers: "list[PushProvider] | None" = dc_field( + providers: "Optional[List[PushProvider]]" = dc_field( default=None, metadata=dc_config(field_name="providers") ) @dataclass class PushNotificationSettingsResponse(DataClassJsonMixin): - disabled: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disabled") ) - disabled_until: datetime | None = dc_field( + disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", @@ -21122,19 +23963,19 @@ class PushNotificationSettingsResponse(DataClassJsonMixin): @dataclass class PushPreferenceInput(DataClassJsonMixin): # Set the level of call push notifications for the user. One of: all, none, default - call_level: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) # Disable push notifications till a certain time - disabled_until: datetime | None = dc_field( + disabled_until: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_until", @@ -21144,34 +23985,44 @@ class PushPreferenceInput(DataClassJsonMixin): ), ) # Set the level of feeds push notifications for the user. One of: all, none, default - feeds_level: str | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - chat_preferences: "ChatPreferencesInput | None" = dc_field( + chat_preferences: "Optional[ChatPreferencesInput]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) - feeds_preferences: "FeedsPreferences | None" = dc_field( + 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: str | None = dc_field( + call_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="call_level") ) - chat_level: str | None = dc_field( + # The scope level of the push notifications. + chat_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_level") ) - disabled_until: datetime | None = dc_field( + # 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", @@ -21180,15 +24031,19 @@ class PushPreferencesResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - feeds_level: str | None = dc_field( + feeds_level: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feeds_level") ) - chat_preferences: "ChatPreferencesResponse | None" = dc_field( + chat_preferences: "Optional[ChatPreferencesResponse]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) - feeds_preferences: "FeedsPreferencesResponse | None" = dc_field( + 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 @@ -21211,37 +24066,37 @@ class PushProvider(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - apn_auth_key: str | None = dc_field( + apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) - apn_auth_type: str | None = dc_field( + apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) - apn_development: bool | None = dc_field( + apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) - apn_host: str | None = dc_field( + apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) - apn_key_id: str | None = dc_field( + apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) - apn_notification_template: str | None = dc_field( + apn_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_notification_template") ) - apn_p12_cert: str | None = dc_field( + apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) - apn_team_id: str | None = dc_field( + apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) - apn_topic: str | None = dc_field( + apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - disabled_at: datetime | None = dc_field( + disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", @@ -21250,81 +24105,91 @@ class PushProvider(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - disabled_reason: str | None = dc_field( + disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) - firebase_apn_template: str | None = dc_field( + firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) - firebase_credentials: str | None = dc_field( + firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) - firebase_data_template: str | None = dc_field( + firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) - firebase_host: str | None = dc_field( + firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) - firebase_notification_template: str | None = dc_field( + firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) - firebase_server_key: str | None = dc_field( + firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) - huawei_app_id: str | None = dc_field( + huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) - huawei_app_secret: str | None = dc_field( + huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) - huawei_host: str | None = dc_field( + huawei_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_host") ) - xiaomi_app_secret: str | None = dc_field( + xiaomi_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_app_secret") ) - xiaomi_package_name: str | None = dc_field( + xiaomi_package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_package_name") ) - push_templates: "list[PushTemplate] | None" = dc_field( + 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: str | None = dc_field( + apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) - apn_auth_type: str | None = dc_field( + apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) - apn_development: bool | None = dc_field( + apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) - apn_host: str | None = dc_field( + apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) - apn_key_id: str | None = dc_field( + apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) - apn_notification_template: str | None = dc_field( + apn_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_notification_template") ) - apn_p12_cert: str | None = dc_field( + apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) - apn_team_id: str | None = dc_field( + apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) - apn_topic: str | None = dc_field( + apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - disabled_at: datetime | None = dc_field( + disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", @@ -21333,38 +24198,38 @@ class PushProviderRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - disabled_reason: str | None = dc_field( + disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) - firebase_apn_template: str | None = dc_field( + firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) - firebase_credentials: str | None = dc_field( + firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) - firebase_data_template: str | None = dc_field( + firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) - firebase_host: str | None = dc_field( + firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) - firebase_notification_template: str | None = dc_field( + firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) - firebase_server_key: str | None = dc_field( + firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) - huawei_app_id: str | None = dc_field( + huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) - huawei_app_secret: str | None = dc_field( + huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - xiaomi_app_secret: str | None = dc_field( + 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: str | None = dc_field( + xiaomi_package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_package_name") ) @@ -21389,43 +24254,43 @@ class PushProviderResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - apn_auth_key: str | None = dc_field( + apn_auth_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_key") ) - apn_auth_type: str | None = dc_field( + apn_auth_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_auth_type") ) - apn_development: bool | None = dc_field( + apn_development: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_development") ) - apn_host: str | None = dc_field( + apn_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_host") ) - apn_key_id: str | None = dc_field( + apn_key_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_key_id") ) - apn_p12_cert: str | None = dc_field( + apn_p12_cert: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_p12_cert") ) - apn_sandbox_certificate: bool | None = dc_field( + apn_sandbox_certificate: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_sandbox_certificate") ) - apn_supports_remote_notifications: bool | None = dc_field( + apn_supports_remote_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_supports_remote_notifications") ) - apn_supports_voip_notifications: bool | None = dc_field( + apn_supports_voip_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="apn_supports_voip_notifications") ) - apn_team_id: str | None = dc_field( + apn_team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_team_id") ) - apn_topic: str | None = dc_field( + apn_topic: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="apn_topic") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - disabled_at: datetime | None = dc_field( + disabled_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="disabled_at", @@ -21434,41 +24299,63 @@ class PushProviderResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - disabled_reason: str | None = dc_field( + disabled_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="disabled_reason") ) - firebase_apn_template: str | None = dc_field( + firebase_apn_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_apn_template") ) - firebase_credentials: str | None = dc_field( + firebase_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_credentials") ) - firebase_data_template: str | None = dc_field( + firebase_data_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_data_template") ) - firebase_host: str | None = dc_field( + firebase_host: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_host") ) - firebase_notification_template: str | None = dc_field( + firebase_notification_template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_notification_template") ) - firebase_server_key: str | None = dc_field( + firebase_server_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="firebase_server_key") ) - huawei_app_id: str | None = dc_field( + huawei_app_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_id") ) - huawei_app_secret: str | None = dc_field( + huawei_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="huawei_app_secret") ) - xiaomi_app_secret: str | None = dc_field( + xiaomi_app_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="xiaomi_app_secret") ) - xiaomi_package_name: str | None = dc_field( + 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( @@ -21489,7 +24376,7 @@ class PushTemplate(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - template: str | None = dc_field( + template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @@ -21523,7 +24410,7 @@ class PushTemplateResponse(DataClassJsonMixin): ) ) # The push notification template - template: str | None = dc_field( + template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @@ -21533,7 +24420,7 @@ class Quality(DataClassJsonMixin): viewer_interruption_note: str = dc_field( metadata=dc_config(field_name="viewer_interruption_note") ) - interruption_incidents: "list[Incident]" = dc_field( + interruption_incidents: "List[Incident]" = dc_field( metadata=dc_config(field_name="interruption_incidents") ) connection_avg_jitter_ms: "Percentiles" = dc_field( @@ -21548,63 +24435,69 @@ class Quality(DataClassJsonMixin): score_bands_by_watch_time_pct: "ScoreBands" = dc_field( metadata=dc_config(field_name="score_bands_by_watch_time_pct") ) - p50_quality_score: float | None = dc_field( + p50_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p50_quality_score") ) - p5_quality_score: float | None = dc_field( + p5_quality_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="p5_quality_score") ) - viewer_interruption_rate_pct: float | None = dc_field( + 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( + histogram: "List[ReportByHistogramBucket]" = dc_field( metadata=dc_config(field_name="histogram") ) @dataclass class QualityScoreReportResponse(DataClassJsonMixin): - daily: "list[DailyAggregateQualityScoreReportResponse]" = dc_field( + daily: "List[DailyAggregateQualityScoreReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @dataclass class QueryActivitiesRequest(DataClassJsonMixin): - enrich_own_fields: bool | None = dc_field( + 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: bool | None = dc_field( + include_expired_activities: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_expired_activities") ) - include_private_activities: bool | None = dc_field( + # 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. - include_soft_deleted_activities: bool | None = dc_field( + # 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -21613,25 +24506,27 @@ class QueryActivitiesRequest(DataClassJsonMixin): class QueryActivitiesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of activities matching the query - activities: "list[ActivityResponse]" = dc_field( + activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryActivityReactionsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - sort: "list[SortParamRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -21640,27 +24535,27 @@ class QueryActivityReactionsRequest(DataClassJsonMixin): class QueryActivityReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reactions: "list[FeedsReactionResponse]" = dc_field( + reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="from")) - to: str | None = dc_field(default=None, metadata=dc_config(field_name="to")) - report_types: list[str] | None = dc_field( + _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") ) @@ -21669,49 +24564,51 @@ class QueryAggregateCallStatsRequest(DataClassJsonMixin): class QueryAggregateCallStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - call_duration_report: "CallDurationReportResponse | None" = dc_field( + call_duration_report: "Optional[CallDurationReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="call_duration_report") ) - call_participant_count_report: "CallParticipantCountReportResponse | None" = ( + call_participant_count_report: "Optional[CallParticipantCountReportResponse]" = ( dc_field( default=None, metadata=dc_config(field_name="call_participant_count_report") ) ) - calls_per_day_report: "CallsPerDayReportResponse | None" = dc_field( + calls_per_day_report: "Optional[CallsPerDayReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="calls_per_day_report") ) - network_metrics_report: "NetworkMetricsReportResponse | None" = dc_field( + network_metrics_report: "Optional[NetworkMetricsReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="network_metrics_report") ) - quality_score_report: "QualityScoreReportResponse | None" = dc_field( + quality_score_report: "Optional[QualityScoreReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="quality_score_report") ) - sdk_usage_report: "SDKUsageReportResponse | None" = dc_field( + sdk_usage_report: "Optional[SDKUsageReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="sdk_usage_report") ) - user_feedback_report: "UserFeedbackReportResponse | None" = dc_field( + user_feedback_report: "Optional[UserFeedbackReportResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_feedback_report") ) @dataclass class QueryAppealsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for appeals - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -21720,18 +24617,18 @@ class QueryAppealsRequest(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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( + filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) - created_at_after: datetime | None = dc_field( + created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", @@ -21740,7 +24637,7 @@ class QueryBannedUsersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_after_or_equal: datetime | None = dc_field( + created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", @@ -21749,7 +24646,7 @@ class QueryBannedUsersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before: datetime | None = dc_field( + created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", @@ -21758,7 +24655,7 @@ class QueryBannedUsersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before_or_equal: datetime | None = dc_field( + created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", @@ -21768,22 +24665,26 @@ class QueryBannedUsersPayload(DataClassJsonMixin): ), ) # Whether to exclude expired bans or not - exclude_expired_bans: bool | None = dc_field( + exclude_expired_bans: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_expired_bans") ) # Number of records to return - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) # Number of records to offset - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -21793,20 +24694,22 @@ 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")) + bans: "List[BanResponse]" = dc_field(metadata=dc_config(field_name="bans")) @dataclass class QueryBookmarkFoldersRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -21815,36 +24718,38 @@ class QueryBookmarkFoldersRequest(DataClassJsonMixin): 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( + bookmark_folders: "List[BookmarkFolderResponse]" = dc_field( metadata=dc_config(field_name="bookmark_folders") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryBookmarksRequest(DataClassJsonMixin): - enrich_own_fields: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -21853,28 +24758,30 @@ class QueryBookmarksRequest(DataClassJsonMixin): class QueryBookmarksResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of bookmarks matching the query - bookmarks: "list[BookmarkResponse]" = dc_field( + bookmarks: "List[BookmarkResponse]" = dc_field( metadata=dc_config(field_name="bookmarks") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -21883,9 +24790,9 @@ class QueryCallMembersRequest(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 @@ -21901,12 +24808,12 @@ class QueryCallParticipantSessionsResponse(DataClassJsonMixin): total_participant_sessions: int = dc_field( metadata=dc_config(field_name="total_participant_sessions") ) - participants_sessions: "list[ParticipantSessionDetails]" = dc_field( + participants_sessions: "List[ParticipantSessionDetails]" = dc_field( metadata=dc_config(field_name="participants_sessions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - session: "CallSessionResponse | None" = dc_field( + 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") ) @@ -21914,7 +24821,7 @@ class QueryCallParticipantSessionsResponse(DataClassJsonMixin): @dataclass class QueryCallParticipantsRequest(DataClassJsonMixin): # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -21925,18 +24832,50 @@ class QueryCallParticipantsResponse(DataClassJsonMixin): 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( + 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( + 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")) @@ -21944,13 +24883,13 @@ class QueryCallSessionParticipantStatsResponse(DataClassJsonMixin): 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( + participants: "List[CallStatsParticipant]" = dc_field( metadata=dc_config(field_name="participants") ) counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) - call_ended_at: datetime | None = dc_field( + call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", @@ -21959,7 +24898,7 @@ class QueryCallSessionParticipantStatsResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - call_started_at: datetime | None = dc_field( + call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", @@ -21968,12 +24907,12 @@ class QueryCallSessionParticipantStatsResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - tmp_data_source: str | None = dc_field( + 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: "list[CallLevelEventPayload] | None" = dc_field( + call_events: "Optional[List[CallLevelEventPayload]]" = dc_field( default=None, metadata=dc_config(field_name="call_events") ) @@ -21987,22 +24926,24 @@ class QueryCallSessionParticipantStatsTimelineResponse(DataClassJsonMixin): 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( + events: "List[CallParticipantTimeline]" = dc_field( metadata=dc_config(field_name="events") ) @dataclass class QueryCallSessionStatsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -22011,11 +24952,11 @@ class QueryCallSessionStatsRequest(DataClassJsonMixin): 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( + call_stats: "List[CallStatsSessionResponse]" = dc_field( metadata=dc_config(field_name="call_stats") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 @@ -22028,7 +24969,7 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): counts: "CallStatsParticipantCounts" = dc_field( metadata=dc_config(field_name="counts") ) - call_ended_at: datetime | None = dc_field( + call_ended_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_ended_at", @@ -22037,7 +24978,7 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - call_started_at: datetime | None = dc_field( + call_started_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="call_started_at", @@ -22046,10 +24987,10 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - data_source: str | None = dc_field( + data_source: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="data_source") ) - end_time: datetime | None = dc_field( + end_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_time", @@ -22058,7 +24999,7 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - generated_at: datetime | None = dc_field( + generated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="generated_at", @@ -22067,7 +25008,7 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - start_time: datetime | None = dc_field( + start_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="start_time", @@ -22076,28 +25017,30 @@ class QueryCallStatsMapResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - publishers: "CallStatsMapPublishers | None" = dc_field( + publishers: "Optional[CallStatsMapPublishers]" = dc_field( default=None, metadata=dc_config(field_name="publishers") ) - sfus: "CallStatsMapSFUs | None" = dc_field( + sfus: "Optional[CallStatsMapSFUs]" = dc_field( default=None, metadata=dc_config(field_name="sfus") ) - subscribers: "CallStatsMapSubscribers | None" = dc_field( + subscribers: "Optional[CallStatsMapSubscribers]" = dc_field( default=None, metadata=dc_config(field_name="subscribers") ) @dataclass class QueryCallStatsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -22106,24 +25049,26 @@ class QueryCallStatsRequest(DataClassJsonMixin): class QueryCallStatsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reports: "list[CallStatsReportSummaryResponse]" = dc_field( + reports: "List[CallStatsReportSummaryResponse]" = dc_field( metadata=dc_config(field_name="reports") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -22132,26 +25077,28 @@ class QueryCallsRequest(DataClassJsonMixin): class QueryCallsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - calls: "list[CallStateResponseFields]" = dc_field( + calls: "List[CallStateResponseFields]" = dc_field( metadata=dc_config(field_name="calls") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_limit: int | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22160,57 +25107,124 @@ class QueryCampaignsRequest(DataClassJsonMixin): class QueryCampaignsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - campaigns: "list[CampaignResponse]" = dc_field( + campaigns: "List[CampaignResponse]" = dc_field( metadata=dc_config(field_name="campaigns") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 QueryChannelsRequest(DataClassJsonMixin): - # Number of channels to limit - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - # Number of members to limit - member_limit: int | None = dc_field( - default=None, metadata=dc_config(field_name="member_limit") +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") ) - # Number of messages to limit - message_limit: int | None = dc_field( - default=None, metadata=dc_config(field_name="message_limit") + # 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") ) - # Channel pagination offset - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) - # ID of a predefined filter to use instead of filter_conditions - predefined_filter: str | None = dc_field( - default=None, metadata=dc_config(field_name="predefined_filter") + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") ) - # Whether to update channel state or not - state: bool | None = dc_field(default=None, metadata=dc_config(field_name="state")) - user_id: str | None = dc_field( + 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") ) - # 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: list[str] | None = dc_field( - default=None, metadata=dc_config(field_name="member_custom_include") - ) - # List of sort parameters - sort: "list[SortParamRequest] | None" = dc_field( - default=None, metadata=dc_config(field_name="sort") - ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + 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: dict[str, object] | None = dc_field( - default=None, metadata=dc_config(field_name="filter_values") + # 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") ) - sort_values: dict[str, object] | None = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22220,32 +25234,34 @@ 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( + channels: "List[ChannelStateResponseFields]" = dc_field( metadata=dc_config(field_name="channels") ) - predefined_filter: "ParsedPredefinedFilterResponse | None" = dc_field( + predefined_filter: "Optional[ParsedPredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class QueryCollectionsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22254,25 +25270,27 @@ class QueryCollectionsRequest(DataClassJsonMixin): class QueryCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of collections matching the query - collections: "list[CollectionResponse]" = dc_field( + collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryCommentReactionsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - sort: "list[SortParamRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22281,32 +25299,38 @@ class QueryCommentReactionsRequest(DataClassJsonMixin): class QueryCommentReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reactions: "list[FeedsReactionResponse]" = dc_field( + reactions: "List[FeedsReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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")) + 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: str | None = dc_field( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="sort")) - user_id: str | None = dc_field( + 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22315,33 +25339,67 @@ class QueryCommentsRequest(DataClassJsonMixin): class QueryCommentsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of comments matching the query - comments: "list[CommentResponse]" = dc_field( + comments: "List[CommentResponse]" = dc_field( metadata=dc_config(field_name="comments") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22351,22 +25409,24 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter parameters for the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22375,13 +25435,13 @@ class QueryFeedMembersRequest(DataClassJsonMixin): class QueryFeedMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of feed members - members: "list[FeedMemberResponse]" = dc_field( + members: "List[FeedMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass @@ -22407,7 +25467,7 @@ class QueryFeedModerationTemplate(DataClassJsonMixin): ) ) # Configuration for a feeds moderation template - config: "FeedsModerationTemplateConfigPayload | None" = dc_field( + config: "Optional[FeedsModerationTemplateConfigPayload]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @@ -22416,27 +25476,31 @@ class QueryFeedModerationTemplate(DataClassJsonMixin): class QueryFeedModerationTemplatesResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation templates - templates: "list[QueryFeedModerationTemplate]" = dc_field( + templates: "List[QueryFeedModerationTemplate]" = dc_field( metadata=dc_config(field_name="templates") ) @dataclass class QueryFeedsRequest(DataClassJsonMixin): - enrich_own_fields: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="watch")) + watch: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="watch") + ) # Sorting parameters for the query - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22445,19 +25509,19 @@ class QueryFeedsRequest(DataClassJsonMixin): 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")) + feeds: "List[FeedResponse]" = dc_field(metadata=dc_config(field_name="feeds")) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="from")) + _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: str | None = dc_field(default=None, metadata=dc_config(field_name="to")) + to: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="to")) @dataclass @@ -22469,28 +25533,43 @@ class QueryFeedsUsageStatsResponse(DataClassJsonMixin): 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") ) - emau: "EMAUStatsResponse | None" = dc_field( + 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): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + # 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22499,16 +25578,20 @@ class QueryFollowsRequest(DataClassJsonMixin): 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")) + follows: "List[FollowResponse]" = dc_field(metadata=dc_config(field_name="follows")) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: datetime | None = dc_field( + created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", @@ -22517,7 +25600,7 @@ class QueryFutureChannelBansPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_after_or_equal: datetime | None = dc_field( + created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", @@ -22526,7 +25609,7 @@ class QueryFutureChannelBansPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before: datetime | None = dc_field( + created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", @@ -22535,7 +25618,7 @@ class QueryFutureChannelBansPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before_or_equal: datetime | None = dc_field( + created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", @@ -22545,26 +25628,30 @@ class QueryFutureChannelBansPayload(DataClassJsonMixin): ), ) # Whether to exclude expired bans or not - exclude_expired_bans: bool | None = dc_field( + 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: bool | None = dc_field( + include_total: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_total") ) # Number of records to return - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) # Number of records to offset - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="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: str | None = dc_field( + target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22574,31 +25661,35 @@ 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( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="total")) + total: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="total") + ) @dataclass class QueryLabelResultsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22607,17 +25698,17 @@ class QueryLabelResultsRequest(DataClassJsonMixin): class QueryLabelResultsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of moderation label results - label_results: "list[LabelResultResponse]" = dc_field( + label_results: "List[LabelResultResponse]" = dc_field( metadata=dc_config(field_name="label_results") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: datetime | None = dc_field( + created_at_after: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after", @@ -22626,7 +25717,7 @@ class QueryMembersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_after_or_equal: datetime | None = dc_field( + created_at_after_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_after_or_equal", @@ -22635,7 +25726,7 @@ class QueryMembersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before: datetime | None = dc_field( + created_at_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before", @@ -22644,7 +25735,7 @@ class QueryMembersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_at_before_or_equal: datetime | None = dc_field( + created_at_before_or_equal: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at_before_or_equal", @@ -22653,52 +25744,58 @@ class QueryMembersPayload(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) - user_id: str | None = dc_field( + 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: str | None = dc_field( + user_id_gt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_gt") ) - user_id_gte: str | None = dc_field( + user_id_gte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_gte") ) - user_id_lt: str | None = dc_field( + user_id_lt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_lt") ) - user_id_lte: str | None = dc_field( + user_id_lte: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id_lte") ) - members: "list[ChannelMemberRequest] | None" = dc_field( + members: "Optional[List[ChannelMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) # Array of sort parameters - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class QueryMembershipLevelsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22706,36 +25803,40 @@ class QueryMembershipLevelsRequest(DataClassJsonMixin): @dataclass class QueryMembershipLevelsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - membership_levels: "list[MembershipLevelResponse]" = dc_field( + membership_levels: "List[MembershipLevelResponse]" = dc_field( metadata=dc_config(field_name="membership_levels") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryMessageFlagsPayload(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) + 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: bool | None = dc_field( + show_deleted_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_deleted_messages") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22745,7 +25846,7 @@ 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( + flags: "List[MessageFlagResponse]" = dc_field( metadata=dc_config(field_name="flags") ) @@ -22753,12 +25854,14 @@ class QueryMessageFlagsResponse(DataClassJsonMixin): @dataclass class QueryMessageHistoryRequest(DataClassJsonMixin): # Filter to apply to the query - filter: dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @@ -22768,31 +25871,33 @@ 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( + message_history: "List[MessageHistoryEntryResponse]" = dc_field( metadata=dc_config(field_name="message_history") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation configs - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22801,21 +25906,65 @@ class QueryModerationConfigsRequest(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - sort: "list[SortParamRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22824,31 +25973,33 @@ class QueryModerationFlagsRequest(DataClassJsonMixin): class QueryModerationFlagsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - flags: "list[ModerationFlagResponse]" = dc_field( + flags: "List[ModerationFlagResponse]" = dc_field( metadata=dc_config(field_name="flags") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation logs - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22857,29 +26008,31 @@ class QueryModerationLogsRequest(DataClassJsonMixin): 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions for moderation rules - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -22888,100 +26041,125 @@ class QueryModerationRulesRequest(DataClassJsonMixin): 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( + 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( + 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( + 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")) + ocr_labels: List[str] = dc_field(metadata=dc_config(field_name="ocr_labels")) # List of moderation rules - rules: "list[ModerationRuleV2Response]" = dc_field( + 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( + 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( + 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( + 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( + keyframe_label_classifications: "Dict[str, List[str]]" = dc_field( metadata=dc_config(field_name="keyframe_label_classifications") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + # 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filters to apply to the query - filter: dict[str, object] | None = dc_field( + 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( + pinned_activities: "List[ActivityPinResponse]" = dc_field( metadata=dc_config(field_name="pinned_activities") ) # Cursor for next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Cursor for previous page - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) @dataclass class QueryPollVotesRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @dataclass class QueryPollsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -22991,9 +26169,9 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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 @@ -23001,31 +26179,33 @@ 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( + predefined_filters: "List[PredefinedFilterResponse]" = dc_field( metadata=dc_config(field_name="predefined_filters") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23034,31 +26214,33 @@ class QueryReactionsRequest(DataClassJsonMixin): class QueryReactionsResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - reactions: "list[ReactionResponse]" = dc_field( + reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="reactions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - user_id: str | None = dc_field( + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23068,50 +26250,52 @@ 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( + reminders: "List[ReminderResponseData]" = dc_field( metadata=dc_config(field_name="reminders") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: bool | None = dc_field( + exclude_default_action_config: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="exclude_default_action_config") ) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) # Number of items to lock (1-25) - lock_count: int | None = dc_field( + lock_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="lock_count") ) # Duration for which items should be locked - lock_duration: int | None = dc_field( + 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: bool | None = dc_field( + lock_items: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="lock_items") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: bool | None = dc_field( + stats_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stats_only") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Sorting parameters for the results - sort: "list[SortParamRequest] | None" = dc_field( + 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. - filter: dict[str, object] | None = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23120,21 +26304,21 @@ class QueryReviewQueueRequest(DataClassJsonMixin): class QueryReviewQueueResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of review queue items - items: "list[ReviewQueueItemResponse]" = dc_field( + items: "List[ReviewQueueItemResponse]" = dc_field( metadata=dc_config(field_name="items") ) # Configuration for moderation actions - action_config: "dict[str, list[ModerationActionConfigResponse]]" = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - default_action_config: "dict[str, list[ModerationActionConfigResponse]] | None" = ( - dc_field(default=None, metadata=dc_config(field_name="default_action_config")) + 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: "FilterConfigResponse | None" = dc_field( + filter_config: "Optional[FilterConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="filter_config") ) @@ -23142,12 +26326,14 @@ class QueryReviewQueueResponse(DataClassJsonMixin): @dataclass class QueryRevisionHistoryRequest(DataClassJsonMixin): # Filter to apply to the query - filter: dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @@ -23157,25 +26343,64 @@ 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( + revisions: "List[RevisionHistoryResponse]" = dc_field( metadata=dc_config(field_name="revisions") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) # Next - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Prev - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) - sort: "list[SortParamRequest] | None" = dc_field( + 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: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="Filter") ) @@ -23185,22 +26410,24 @@ 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( + targets: "List[SegmentTargetResponse]" = dc_field( metadata=dc_config(field_name="targets") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @@ -23210,31 +26437,35 @@ 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( + segments: "List[SegmentResponse]" = dc_field( metadata=dc_config(field_name="segments") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: str | None = dc_field( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="month")) + month: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="month") + ) # Cursor for pagination to fetch next page of teams - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) @dataclass @@ -23242,40 +26473,42 @@ 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")) + teams: "List[TeamUsageStats]" = dc_field(metadata=dc_config(field_name="teams")) # Cursor for pagination to fetch next page - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) @dataclass class QueryThreadsRequest(DataClassJsonMixin): - limit: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - member_limit: int | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Limit the number of participants returned per each thread - participant_limit: int | None = dc_field( + participant_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="participant_limit") ) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + prev: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="prev")) # Limit the number of replies returned per each thread - reply_limit: int | None = dc_field( + reply_limit: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reply_limit") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23285,24 +26518,26 @@ 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( + threads: "List[ThreadStateResponse]" = dc_field( metadata=dc_config(field_name="threads") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Filter conditions to apply to the query - filter_conditions: dict[str, object] | None = dc_field( + filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter_conditions") ) @@ -23311,40 +26546,52 @@ class QueryUserFeedbackRequest(DataClassJsonMixin): 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( + user_feedback: "List[UserFeedbackResponse]" = dc_field( metadata=dc_config(field_name="user_feedback") ) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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( + filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) - id_gt: str | None = dc_field(default=None, metadata=dc_config(field_name="id_gt")) - id_gte: str | None = dc_field(default=None, metadata=dc_config(field_name="id_gte")) - id_lt: str | None = dc_field(default=None, metadata=dc_config(field_name="id_lt")) - id_lte: str | None = dc_field(default=None, metadata=dc_config(field_name="id_lte")) - include_deactivated_users: bool | None = dc_field( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) - presence: bool | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of sort parameters - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23354,18 +26601,42 @@ 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")) + 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: "ModerationQueueResponse | None" = dc_field( + 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 @@ -23373,14 +26644,14 @@ class RTMPBroadcastRequest(DataClassJsonMixin): # 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: str | None = dc_field( + 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: str | None = dc_field( + stream_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="stream_key") ) - layout: "LayoutSettingsRequest | None" = dc_field( + layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -23400,13 +26671,13 @@ class RTMPLocation(DataClassJsonMixin): @dataclass class RTMPSettings(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - quality_name: str | None = dc_field( + quality_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality_name") ) - layout: "LayoutSettings | None" = dc_field( + layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) - location: "RTMPLocation | None" = dc_field( + location: "Optional[RTMPLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -23414,14 +26685,14 @@ class RTMPSettings(DataClassJsonMixin): @dataclass class RTMPSettingsRequest(DataClassJsonMixin): # Whether RTMP broadcasting is enabled - enabled: bool | None = dc_field( + 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: str | None = dc_field( + quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) - layout: "LayoutSettingsRequest | None" = dc_field( + layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -23437,22 +26708,35 @@ class RTMPSettingsResponse(DataClassJsonMixin): class RankingConfig(DataClassJsonMixin): # Type of ranking algorithm. Required. One of: expression, interest type: str = dc_field(metadata=dc_config(field_name="type")) - # Scoring formula. Required when type is 'expression' or 'interest' - score: str | None = dc_field(default=None, metadata=dc_config(field_name="score")) + # 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: dict[str, object] | None = dc_field( + 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: "dict[str, DecayFunctionConfig] | None" = dc_field( + functions: "Optional[Dict[str, DecayFunctionConfig]]" = dc_field( default=None, metadata=dc_config(field_name="functions") ) @dataclass class RawRecordSettings(DataClassJsonMixin): - mode: str = dc_field(metadata=dc_config(field_name="mode")) - audio_only: bool | None = dc_field( + # 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") ) @@ -23465,17 +26749,18 @@ class RawRecordingResponse(DataClassJsonMixin): @dataclass class RawRecordingSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on - mode: str = dc_field(metadata=dc_config(field_name="mode")) + mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) # If true, only audio tracks will be recorded - audio_only: bool | None = dc_field( + audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) @dataclass class RawRecordingSettingsResponse(DataClassJsonMixin): - mode: str = dc_field(metadata=dc_config(field_name="mode")) - audio_only: bool | None = dc_field( + # 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") ) @@ -23501,7 +26786,7 @@ class Reaction(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -23510,31 +26795,37 @@ class Reaction(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - parent: str | None = dc_field(default=None, metadata=dc_config(field_name="parent")) - score: float | None = dc_field(default=None, metadata=dc_config(field_name="score")) - target_feeds: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + children_counts: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="children_counts") ) - data: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) - latest_children: "dict[str, list[Reaction]] | None" = dc_field( + latest_children: "Optional[Dict[str, List[Reaction]]]" = dc_field( default=None, metadata=dc_config(field_name="latest_children") ) - moderation: dict[str, object] | None = dc_field( + moderation: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="moderation") ) - own_children: "dict[str, list[Reaction]] | None" = dc_field( + own_children: "Optional[Dict[str, List[Reaction]]]" = dc_field( default=None, metadata=dc_config(field_name="own_children") ) - target_feeds_extra_data: dict[str, object] | None = dc_field( + target_feeds_extra_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="target_feeds_extra_data") ) - user: "User | None" = dc_field(default=None, metadata=dc_config(field_name="user")) + user: "Optional[User]" = dc_field( + default=None, metadata=dc_config(field_name="user") + ) @dataclass @@ -23550,33 +26841,33 @@ class ReactionDeletedEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - message_id: str | None = dc_field( + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -23586,22 +26877,22 @@ class ReactionDeletedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The participants of the thread - thread_participants: "list[UserResponseCommonFields] | None" = dc_field( + thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - reaction: "ReactionResponse | None" = dc_field( + reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23631,7 +26922,7 @@ class ReactionGroupResponse(DataClassJsonMixin): # 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( + latest_reactions_by: "List[ReactionGroupUserResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions_by") ) @@ -23650,7 +26941,7 @@ class ReactionGroupUserResponse(DataClassJsonMixin): # The ID of the user who reacted. user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23668,31 +26959,31 @@ class ReactionNewEvent(DataClassJsonMixin): ) # 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")) + 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: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - message_id: str | None = dc_field( + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -23702,22 +26993,22 @@ class ReactionNewEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + team: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="team")) # The participants of the thread - thread_participants: "list[UserResponseCommonFields] | None" = dc_field( + thread_participants: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) - channel_custom: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - reaction: "ReactionResponse | None" = dc_field( + reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23727,7 +27018,7 @@ 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: datetime | None = dc_field( + created_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="created_at", @@ -23737,9 +27028,11 @@ class ReactionRequest(DataClassJsonMixin): ), ) # Reaction score. If not specified reaction has score of 1 - score: int | None = dc_field(default=None, metadata=dc_config(field_name="score")) + score: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="score") + ) # Date/time of the last update - updated_at: datetime | None = dc_field( + updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="updated_at", @@ -23748,14 +27041,14 @@ class ReactionRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23789,7 +27082,7 @@ class ReactionResponse(DataClassJsonMixin): # 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")) + 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")) @@ -23808,7 +27101,7 @@ class ReactionUpdatedEvent(DataClassJsonMixin): 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")) + 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 @@ -23816,24 +27109,24 @@ class ReactionUpdatedEvent(DataClassJsonMixin): default="reaction.updated", metadata=dc_config(field_name="type") ) # The ID of the channel containing the message - channel_id: str | None = dc_field( + 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: int | None = dc_field( + 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: int | None = dc_field( + 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: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) # The CID of the channel containing the message - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -23843,14 +27136,14 @@ class ReactionUpdatedEvent(DataClassJsonMixin): ), ) # The team ID - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "ReactionResponse | None" = dc_field( + reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23858,13 +27151,13 @@ class ReactionUpdatedEvent(DataClassJsonMixin): @dataclass class ReactivateUserRequest(DataClassJsonMixin): # ID of the user who's reactivating the user - created_by_id: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Restore previously deleted messages - restore_messages: bool | None = dc_field( + restore_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_messages") ) @@ -23874,7 +27167,7 @@ class ReactivateUserResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -23882,16 +27175,16 @@ class ReactivateUserResponse(DataClassJsonMixin): @dataclass class ReactivateUsersRequest(DataClassJsonMixin): # User IDs to reactivate - user_ids: list[str] = dc_field(metadata=dc_config(field_name="user_ids")) + 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: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) - restore_channels: bool | None = dc_field( + restore_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_channels") ) # Restore previously deleted messages - restore_messages: bool | None = dc_field( + restore_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="restore_messages") ) @@ -23907,7 +27200,7 @@ class ReactivateUsersResponse(DataClassJsonMixin): class ReadCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of collections matching the references - collections: "list[CollectionResponse]" = dc_field( + collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @@ -23930,7 +27223,7 @@ class ReadStateResponse(DataClassJsonMixin): 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: datetime | None = dc_field( + last_delivered_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_delivered_at", @@ -23939,10 +27232,10 @@ class ReadStateResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - last_delivered_message_id: str | None = dc_field( + last_delivered_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_delivered_message_id") ) - last_read_message_id: str | None = dc_field( + last_read_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="last_read_message_id") ) @@ -23950,13 +27243,13 @@ class ReadStateResponse(DataClassJsonMixin): @dataclass class RecordSettings(DataClassJsonMixin): mode: str = dc_field(metadata=dc_config(field_name="mode")) - audio_only: bool | None = dc_field( + audio_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="audio_only") ) - quality: str | None = dc_field( + quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) - layout: "LayoutSettings | None" = dc_field( + layout: "Optional[LayoutSettings]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -23964,16 +27257,16 @@ class RecordSettings(DataClassJsonMixin): @dataclass class RecordSettingsRequest(DataClassJsonMixin): # Recording mode. One of: available, disabled, auto-on - mode: str = dc_field(metadata=dc_config(field_name="mode")) + mode: "FeatureActivationMode" = dc_field(metadata=dc_config(field_name="mode")) # Whether to record audio only - audio_only: bool | None = dc_field( + 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: str | None = dc_field( + quality: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quality") ) - layout: "LayoutSettingsRequest | None" = dc_field( + layout: "Optional[LayoutSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="layout") ) @@ -23981,11 +27274,21 @@ class RecordSettingsRequest(DataClassJsonMixin): @dataclass class RecordSettingsResponse(DataClassJsonMixin): audio_only: bool = dc_field(metadata=dc_config(field_name="audio_only")) - mode: str = dc_field(metadata=dc_config(field_name="mode")) + # 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 @@ -23994,11 +27297,11 @@ class RejectAppealRequestPayload(DataClassJsonMixin): @dataclass class RejectFeedMemberInviteRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -24040,7 +27343,7 @@ class ReminderCreatedEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @@ -24049,10 +27352,10 @@ class ReminderCreatedEvent(DataClassJsonMixin): 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: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24080,7 +27383,7 @@ class ReminderDeletedEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @@ -24089,10 +27392,10 @@ class ReminderDeletedEvent(DataClassJsonMixin): 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: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24120,7 +27423,7 @@ class ReminderNotificationEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @@ -24128,10 +27431,10 @@ class ReminderNotificationEvent(DataClassJsonMixin): type: str = dc_field( default="notification.reminder_due", metadata=dc_config(field_name="type") ) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24163,7 +27466,16 @@ class ReminderResponseData(DataClassJsonMixin): ) ) user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - remind_at: datetime | None = dc_field( + 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", @@ -24173,15 +27485,15 @@ class ReminderResponseData(DataClassJsonMixin): ), ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -24203,7 +27515,7 @@ class ReminderUpdatedEvent(DataClassJsonMixin): 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) reminder: "ReminderResponseData" = dc_field( metadata=dc_config(field_name="reminder") ) @@ -24212,10 +27524,10 @@ class ReminderUpdatedEvent(DataClassJsonMixin): 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: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24229,8 +27541,8 @@ class ReminderUpdatedEvent(DataClassJsonMixin): @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: str | None = dc_field( + 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") ) @@ -24238,7 +27550,7 @@ class RemoveUserGroupMembersRequest(DataClassJsonMixin): @dataclass class RemoveUserGroupMembersResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - user_group: "UserGroupResponse | None" = dc_field( + user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -24252,7 +27564,7 @@ class RepliesMeta(DataClassJsonMixin): # 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: str | None = dc_field( + next_cursor: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="next_cursor") ) @@ -24262,10 +27574,10 @@ 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: "Bound | None" = dc_field( + lower_bound: "Optional[Bound]" = dc_field( default=None, metadata=dc_config(field_name="lower_bound") ) - upper_bound: "Bound | None" = dc_field( + upper_bound: "Optional[Bound]" = dc_field( default=None, metadata=dc_config(field_name="upper_bound") ) @@ -24273,7 +27585,7 @@ class ReportByHistogramBucket(DataClassJsonMixin): @dataclass class ReportClientEventRequest(DataClassJsonMixin): # Client-side events to report (1-100 per request) - events: "list[ClientEvent]" = dc_field(metadata=dc_config(field_name="events")) + events: "List[ClientEvent]" = dc_field(metadata=dc_config(field_name="events")) @dataclass @@ -24295,10 +27607,10 @@ class ReportResponse(DataClassJsonMixin): @dataclass class ResolutionMetricsTimeSeries(DataClassJsonMixin): - height: "MetricTimeSeries | None" = dc_field( + height: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="height") ) - width: "MetricTimeSeries | None" = dc_field( + width: "Optional[MetricTimeSeries]" = dc_field( default=None, metadata=dc_config(field_name="width") ) @@ -24312,11 +27624,11 @@ class ResolveSipAuthRequest(DataClassJsonMixin): # 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: str | None = dc_field( + 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: str | None = dc_field( + source_ip: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="source_ip") ) @@ -24327,15 +27639,15 @@ class ResolveSipAuthResponse(DataClassJsonMixin): 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: str | None = dc_field( + password: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="password") ) # ID of the matched SIP trunk - trunk_id: str | None = dc_field( + 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: str | None = dc_field( + username: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="username") ) @@ -24349,19 +27661,19 @@ class ResolveSipInboundRequest(DataClassJsonMixin): # 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: str | None = dc_field( + 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: str | None = dc_field( + trunk_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="trunk_id") ) # SIP digest challenge authentication data - challenge: "SIPChallengeRequest | None" = dc_field( + challenge: "Optional[SIPChallengeRequest]" = dc_field( default=None, metadata=dc_config(field_name="challenge") ) # Optional SIP headers as key-value pairs - sip_headers: "dict[str, str] | None" = dc_field( + sip_headers: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="sip_headers") ) @@ -24374,11 +27686,11 @@ class ResolveSipInboundResponse(DataClassJsonMixin): metadata=dc_config(field_name="credentials") ) # SIP Inbound Routing Rule response - sip_routing_rule: "SIPInboundRoutingRuleResponse | None" = dc_field( + sip_routing_rule: "Optional[SIPInboundRoutingRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_routing_rule") ) # SIP trunk information - sip_trunk: "SIPTrunkResponse | None" = dc_field( + sip_trunk: "Optional[SIPTrunkResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_trunk") ) @@ -24392,18 +27704,22 @@ class Response(DataClassJsonMixin): @dataclass class RestoreActionRequestPayload(DataClassJsonMixin): # Reason for the appeal decision - decision_reason: str | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -24416,11 +27732,11 @@ class RestoreActivityResponse(DataClassJsonMixin): @dataclass class RestoreCommentRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -24432,11 +27748,6 @@ class RestoreCommentResponse(DataClassJsonMixin): comment: "CommentResponse" = dc_field(metadata=dc_config(field_name="comment")) -@dataclass -class RestoreFeedGroupRequest(DataClassJsonMixin): - pass - - @dataclass class RestoreFeedGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) @@ -24447,7 +27758,16 @@ class RestoreFeedGroupResponse(DataClassJsonMixin): @dataclass class RestoreUsersRequest(DataClassJsonMixin): - user_ids: list[str] = dc_field(metadata=dc_config(field_name="user_ids")) + 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 @@ -24465,12 +27785,48 @@ class RetentionPolicy(DataClassJsonMixin): 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 @@ -24483,11 +27839,11 @@ class ReviewQueueItemNewEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24497,13 +27853,13 @@ class ReviewQueueItemNewEvent(DataClassJsonMixin): ), ) # The flags associated with this review queue item - flags: "list[ModerationFlagResponse] | None" = dc_field( + flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) - action: "ActionLogResponse | None" = dc_field( + action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="action") ) - review_queue_item: "ReviewQueueItemResponse | None" = dc_field( + review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) @@ -24553,19 +27909,23 @@ class ReviewQueueItemResponse(DataClassJsonMixin): ) ) # Moderation actions taken - actions: "list[ActionLogResponse]" = dc_field( + 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")) + bans: "List[BanInfoResponse]" = dc_field(metadata=dc_config(field_name="bans")) # Associated flag records - flags: "list[ModerationFlagResponse]" = dc_field( + 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")) + 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: datetime | None = dc_field( + completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", @@ -24575,18 +27935,21 @@ class ReviewQueueItemResponse(DataClassJsonMixin): ), ) # Highest per-label confidence (0-1) any provider reported across the item's flags; absent when no flag carried one - confidence_score: float | None = dc_field( + confidence_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence_score") ) - config_key: str | None = dc_field( + 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: str | None = dc_field( + entity_creator_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="entity_creator_id") ) # When the item was escalated - escalated_at: datetime | None = dc_field( + escalated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="escalated_at", @@ -24596,11 +27959,11 @@ class ReviewQueueItemResponse(DataClassJsonMixin): ), ) # ID of the moderator who escalated the item - escalated_by: str | None = dc_field( + escalated_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="escalated_by") ) # When the item was reviewed - reviewed_at: datetime | None = dc_field( + reviewed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="reviewed_at", @@ -24609,49 +27972,59 @@ class ReviewQueueItemResponse(DataClassJsonMixin): 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: list[str] | None = dc_field( + teams: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="teams") ) - activity: "EnrichedActivity | None" = dc_field( + activity: "Optional[EnrichedActivity]" = dc_field( default=None, metadata=dc_config(field_name="activity") ) - appeal: "AppealItemResponse | None" = dc_field( + appeal: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal") ) # User response object - assigned_to: "UserResponse | None" = dc_field( + assigned_to: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="assigned_to") ) - call: "ModerationCallResponse | None" = dc_field( + call: "Optional[ModerationCallResponse]" = dc_field( default=None, metadata=dc_config(field_name="call") ) - entity_creator: "EntityCreatorResponse | None" = dc_field( + entity_creator: "Optional[EntityCreatorResponse]" = dc_field( default=None, metadata=dc_config(field_name="entity_creator") ) - escalation_metadata: "EscalationMetadata | None" = dc_field( + escalation_metadata: "Optional[EscalationMetadata]" = dc_field( default=None, metadata=dc_config(field_name="escalation_metadata") ) - feeds_v2_activity: "EnrichedActivity | None" = dc_field( + feeds_v2_activity: "Optional[EnrichedActivity]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_activity") ) - feeds_v2_reaction: "Reaction | None" = dc_field( + feeds_v2_reaction: "Optional[Reaction]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_reaction") ) - feeds_v3_activity: "FeedsV3ActivityResponse | None" = dc_field( + feeds_v3_activity: "Optional[FeedsV3ActivityResponse]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v3_activity") ) - feeds_v3_comment: "FeedsV3CommentResponse | None" = dc_field( + feeds_v3_comment: "Optional[FeedsV3CommentResponse]" = dc_field( default=None, metadata=dc_config(field_name="feeds_v3_comment") ) - message: "ChatMessageResponse | None" = dc_field( + message: "Optional[ChatMessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Content payload for moderation - moderation_payload: "ModerationPayloadResponse | None" = dc_field( + moderation_payload: "Optional[ModerationPayloadResponse]" = dc_field( default=None, metadata=dc_config(field_name="moderation_payload") ) - reaction: "Reaction | None" = dc_field( + 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") ) @@ -24666,11 +28039,11 @@ class ReviewQueueItemUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -24680,13 +28053,13 @@ class ReviewQueueItemUpdatedEvent(DataClassJsonMixin): ), ) # The flags associated with this review queue item - flags: "list[ModerationFlagResponse] | None" = dc_field( + flags: "Optional[List[ModerationFlagResponse]]" = dc_field( default=None, metadata=dc_config(field_name="flags") ) - action: "ActionLogResponse | None" = dc_field( + action: "Optional[ActionLogResponse]" = dc_field( default=None, metadata=dc_config(field_name="action") ) - review_queue_item: "ReviewQueueItemResponse | None" = dc_field( + review_queue_item: "Optional[ReviewQueueItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="review_queue_item") ) @@ -24706,36 +28079,204 @@ class RevisionHistoryResponse(DataClassJsonMixin): 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: list[str] | None = dc_field( + changed_fields: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="changed_fields") ) - previous_obj_serialized: dict[str, object] | None = dc_field( + previous_obj_serialized: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="previous_obj_serialized") ) @dataclass -class RingCallRequest(DataClassJsonMixin): - # Indicate if call should be video - video: bool | None = 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: list[str] | None = dc_field( - default=None, metadata=dc_config(field_name="members_ids") +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 RingCallResponse(DataClassJsonMixin): +class RewindChannelResponse(DataClassJsonMixin): + # Duration of the request in milliseconds 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")) + # 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 RingSettings(DataClassJsonMixin): - auto_cancel_timeout_ms: int = dc_field( - metadata=dc_config(field_name="auto_cancel_timeout_ms") - ) +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") ) @@ -24755,7 +28296,7 @@ class RingSettingsRequest(DataClassJsonMixin): 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: int | None = dc_field( + missed_call_timeout_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="missed_call_timeout_ms") ) @@ -24773,6 +28314,43 @@ class RingSettingsResponse(DataClassJsonMixin): ) +@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 @@ -24798,139 +28376,177 @@ class Role(DataClassJsonMixin): ) ) # 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")) + scopes: List[str] = dc_field(metadata=dc_config(field_name="scopes")) @dataclass class RuleBuilderAction(DataClassJsonMixin): - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - skip_inbox: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - ban_options: "BanOptions | None" = dc_field( + 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: "CallActionOptions | None" = dc_field( + call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) - flag_user_options: "FlagUserOptions | None" = dc_field( + flag_user_options: "Optional[FlagUserOptions]" = dc_field( default=None, metadata=dc_config(field_name="flag_user_options") ) @dataclass class RuleBuilderCondition(DataClassJsonMixin): - confidence: float | None = dc_field( + confidence: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="confidence") ) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) - call_custom_property_params: "CallCustomPropertyParameters | None" = dc_field( + 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: "CallTypeRuleParameters | None" = dc_field( + call_type_rule_params: "Optional[CallTypeRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="call_type_rule_params") ) - call_violation_count_params: "CallViolationCountParameters | None" = dc_field( + call_violation_count_params: "Optional[CallViolationCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="call_violation_count_params") ) - channel_message_count_rule_params: "ChannelMessageCountRuleParameters | None" = ( + 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: "ClosedCaptionRuleParameters | None" = dc_field( + closed_caption_rule_params: "Optional[ClosedCaptionRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="closed_caption_rule_params") ) - content_count_rule_params: "ContentCountRuleParameters | None" = dc_field( + content_count_rule_params: "Optional[ContentCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_count_rule_params") ) - content_custom_property_count_params: "ContentCustomPropertyCountParameters | None" = dc_field( + 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: "ContentCustomPropertyParameters | None" = dc_field( - default=None, metadata=dc_config(field_name="content_custom_property_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: "FlagCountRuleParameters | None" = dc_field( + content_flag_count_rule_params: "Optional[FlagCountRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="content_flag_count_rule_params") ) - flood_identical_params: "FloodIdenticalRuleParameters | None" = dc_field( + flood_identical_params: "Optional[FloodIdenticalRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="flood_identical_params") ) - flood_similar_params: "FloodSimilarRuleParameters | None" = dc_field( + flood_similar_params: "Optional[FloodSimilarRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="flood_similar_params") ) - image_content_params: "ImageContentParameters | None" = dc_field( + image_content_params: "Optional[ImageContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="image_content_params") ) - image_rule_params: "ImageRuleParameters | None" = dc_field( + image_rule_params: "Optional[ImageRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="image_rule_params") ) - ip_content_count_rule_params: "IPContentCountRuleParameters | None" = dc_field( + # 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: "IPFlagCountRuleParameters | None" = dc_field( + 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: "KeyframeOCRRuleParameters | None" = dc_field( + keyframe_ocr_rule_params: "Optional[KeyframeOCRRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_ocr_rule_params") ) - keyframe_rule_params: "KeyframeRuleParameters | None" = dc_field( + keyframe_rule_params: "Optional[KeyframeRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="keyframe_rule_params") ) - ocr_content_params: "OCRContentParameters | None" = dc_field( + ocr_content_params: "Optional[OCRContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="ocr_content_params") ) - text_content_params: "TextContentParameters | None" = dc_field( + text_content_params: "Optional[TextContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="text_content_params") ) - text_rule_params: "TextRuleParameters | None" = dc_field( + text_rule_params: "Optional[TextRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="text_rule_params") ) - user_created_within_params: "UserCreatedWithinParameters | None" = dc_field( + 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: "UserCustomPropertyParameters | None" = dc_field( + user_custom_property_params: "Optional[UserCustomPropertyParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_custom_property_params") ) - user_flag_count_rule_params: "FlagCountRuleParameters | None" = dc_field( + 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: "UserIdenticalContentCountParameters | None" = dc_field( + user_identical_content_count_params: "Optional[UserIdenticalContentCountParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_identical_content_count_params"), ) - user_reaction_count_params: "UserReactionCountRuleParameters | None" = dc_field( + 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: "UserRoleParameters | None" = dc_field( + user_role_params: "Optional[UserRoleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_role_params") ) - user_rule_params: "UserRuleParameters | None" = dc_field( + user_rule_params: "Optional[UserRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="user_rule_params") ) - video_content_params: "VideoContentParameters | None" = dc_field( + video_content_params: "Optional[VideoContentParameters]" = dc_field( default=None, metadata=dc_config(field_name="video_content_params") ) - video_rule_params: "VideoRuleParameters | None" = dc_field( + video_rule_params: "Optional[VideoRuleParameters]" = dc_field( default=None, metadata=dc_config(field_name="video_rule_params") ) @dataclass class RuleBuilderConditionGroup(DataClassJsonMixin): - logic: str | None = dc_field(default=None, metadata=dc_config(field_name="logic")) - conditions: "list[RuleBuilderCondition] | None" = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - rules: "list[RuleBuilderRule] | None" = dc_field( + _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") ) @@ -24938,34 +28554,36 @@ class RuleBuilderConfig(DataClassJsonMixin): @dataclass class RuleBuilderRule(DataClassJsonMixin): rule_type: str = dc_field(metadata=dc_config(field_name="rule_type")) - cooldown_period: str | None = dc_field( + cooldown_period: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - logic: str | None = dc_field(default=None, metadata=dc_config(field_name="logic")) - action_sequences: "list[CallRuleActionSequence] | None" = dc_field( + 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: "list[RuleBuilderCondition] | None" = dc_field( + conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) - groups: "list[RuleBuilderConditionGroup] | None" = dc_field( + groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) - action: "RuleBuilderAction | None" = dc_field( + action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) @dataclass class RunStats(DataClassJsonMixin): - activities_deleted: int | None = dc_field( + activities_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="activities_deleted") ) - channels_deleted: int | None = dc_field( + channels_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channels_deleted") ) - messages_deleted: int | None = dc_field( + messages_deleted: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="messages_deleted") ) @@ -24975,29 +28593,29 @@ 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + s3_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_secret") ) @dataclass class SDKUsageReport(DataClassJsonMixin): - per_sdk_usage: "dict[str, PerSDKUsageReport | None]" = dc_field( + 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( + daily: "List[DailyAggregateSDKUsageReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @@ -25012,13 +28630,15 @@ class SFULocationResponse(DataClassJsonMixin): ) # Geographic location metadata location: "LocationResponse" = dc_field(metadata=dc_config(field_name="location")) - count: int | None = dc_field(default=None, metadata=dc_config(field_name="count")) + 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: dict[str, object] | None = dc_field( + custom_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_data") ) @@ -25026,7 +28646,7 @@ class SIPCallConfigsRequest(DataClassJsonMixin): @dataclass class SIPCallConfigsResponse(DataClassJsonMixin): # Custom data associated with the call - custom_data: dict[str, object] = dc_field( + custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="custom_data") ) @@ -25036,7 +28656,7 @@ 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: dict[str, object] | None = dc_field( + custom_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom_data") ) @@ -25046,7 +28666,7 @@ 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( + custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="custom_data") ) @@ -25054,49 +28674,63 @@ class SIPCallerConfigsResponse(DataClassJsonMixin): @dataclass class SIPChallengeRequest(DataClassJsonMixin): # Deprecated: A1 hash for backward compatibility - a1: str | None = dc_field(default=None, metadata=dc_config(field_name="a1")) + a1: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="a1")) # Hash algorithm (e.g., MD5, SHA-256) - algorithm: str | None = dc_field( + algorithm: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="algorithm") ) # Character set - charset: str | None = dc_field( + charset: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="charset") ) # Client nonce for qop=auth - cnonce: str | None = dc_field(default=None, metadata=dc_config(field_name="cnonce")) + cnonce: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="cnonce") + ) # SIP method (e.g., INVITE) - method: str | None = dc_field(default=None, metadata=dc_config(field_name="method")) + method: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="method") + ) # Nonce count for qop=auth - nc: str | None = dc_field(default=None, metadata=dc_config(field_name="nc")) + nc: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="nc")) # Server nonce - nonce: str | None = dc_field(default=None, metadata=dc_config(field_name="nonce")) + nonce: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="nonce") + ) # Opaque value - opaque: str | None = dc_field(default=None, metadata=dc_config(field_name="opaque")) + opaque: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="opaque") + ) # Authentication realm - realm: str | None = dc_field(default=None, metadata=dc_config(field_name="realm")) + realm: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="realm") + ) # Digest response hash from client - response: str | None = dc_field( + response: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="response") ) # Whether the nonce is stale - stale: bool | None = dc_field(default=None, metadata=dc_config(field_name="stale")) + stale: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="stale") + ) # Request URI - uri: str | None = dc_field(default=None, metadata=dc_config(field_name="uri")) + uri: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="uri")) # Whether to hash the username - userhash: bool | None = dc_field( + userhash: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="userhash") ) # Username for authentication - username: str | None = dc_field( + username: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="username") ) # Domain list - domain: list[str] | None = dc_field( + domain: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="domain") ) # Quality of protection options - qop: list[str] | None = dc_field(default=None, metadata=dc_config(field_name="qop")) + qop: Optional[List[str]] = dc_field( + default=None, metadata=dc_config(field_name="qop") + ) @dataclass @@ -25118,23 +28752,23 @@ class SIPDirectRoutingRuleCallConfigsResponse(DataClassJsonMixin): @dataclass class SIPInboundRoutingRulePinConfigsRequest(DataClassJsonMixin): # Optional webhook URL for custom PIN handling - custom_webhook_url: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + pin_hangup_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_hangup_prompt") ) # Prompt message for PIN input - pin_prompt: str | None = dc_field( + pin_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_prompt") ) # Prompt message for successful PIN input - pin_success_prompt: str | None = dc_field( + pin_success_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_success_prompt") ) @@ -25142,23 +28776,23 @@ class SIPInboundRoutingRulePinConfigsRequest(DataClassJsonMixin): @dataclass class SIPInboundRoutingRulePinConfigsResponse(DataClassJsonMixin): # Optional webhook URL for custom PIN handling - custom_webhook_url: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + pin_hangup_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_hangup_prompt") ) # Prompt message for PIN input - pin_prompt: str | None = dc_field( + pin_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_prompt") ) # Prompt message for successful PIN input - pin_success_prompt: str | None = dc_field( + pin_success_prompt: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="pin_success_prompt") ) @@ -25168,33 +28802,33 @@ 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")) + 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: list[str] | None = dc_field( + called_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="called_numbers") ) # List of caller numbers (optional) - caller_numbers: list[str] | None = dc_field( + caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # Configuration for SIP call settings - call_configs: "SIPCallConfigsRequest | None" = dc_field( + call_configs: "Optional[SIPCallConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # Configuration for direct routing rule calls - direct_routing_configs: "SIPDirectRoutingRuleCallConfigsRequest | None" = dc_field( - default=None, metadata=dc_config(field_name="direct_routing_configs") + 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: "SIPPinProtectionConfigsRequest | None" = dc_field( + 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: "SIPInboundRoutingRulePinConfigsRequest | None" = dc_field( + pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @@ -25225,33 +28859,33 @@ class SIPInboundRoutingRuleResponse(DataClassJsonMixin): ) ) # List of called numbers - called_numbers: list[str] = dc_field( + 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")) + trunk_ids: List[str] = dc_field(metadata=dc_config(field_name="trunk_ids")) # List of caller numbers - caller_numbers: list[str] | None = dc_field( + caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # SIP call configuration response - call_configs: "SIPCallConfigsResponse | None" = dc_field( + call_configs: "Optional[SIPCallConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # SIP caller configuration response - caller_configs: "SIPCallerConfigsResponse | None" = dc_field( + caller_configs: "Optional[SIPCallerConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="caller_configs") ) # Direct routing rule call configuration response - direct_routing_configs: "SIPDirectRoutingRuleCallConfigsResponse | None" = dc_field( - default=None, metadata=dc_config(field_name="direct_routing_configs") + direct_routing_configs: "Optional[SIPDirectRoutingRuleCallConfigsResponse]" = ( + dc_field(default=None, metadata=dc_config(field_name="direct_routing_configs")) ) # PIN protection configuration response - pin_protection_configs: "SIPPinProtectionConfigsResponse | None" = dc_field( + 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: "SIPInboundRoutingRulePinConfigsResponse | None" = dc_field( + pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsResponse]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @@ -25259,19 +28893,19 @@ class SIPInboundRoutingRuleResponse(DataClassJsonMixin): @dataclass class SIPPinProtectionConfigsRequest(DataClassJsonMixin): # Default PIN to use if there is no PIN set on the call object - default_pin: str | None = dc_field( + default_pin: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_pin") ) # Whether PIN protection is enabled - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Maximum number of PIN attempts allowed - max_attempts: int | None = dc_field( + 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: int | None = dc_field( + required_pin_digits: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="required_pin_digits") ) @@ -25281,15 +28915,15 @@ 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: str | None = dc_field( + default_pin: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="default_pin") ) # Maximum number of PIN attempts allowed - max_attempts: int | None = dc_field( + 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: int | None = dc_field( + required_pin_digits: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="required_pin_digits") ) @@ -25325,9 +28959,9 @@ class SIPTrunkResponse(DataClassJsonMixin): # 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")) + 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")) + numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) @dataclass @@ -25335,11 +28969,306 @@ 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: float | None = dc_field(default=None, metadata=dc_config(field_name="good")) - ok: float | None = dc_field(default=None, metadata=dc_config(field_name="ok")) - poor: float | None = dc_field(default=None, metadata=dc_config(field_name="poor")) + 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 @@ -25348,20 +29277,20 @@ class ScreensharingSettings(DataClassJsonMixin): metadata=dc_config(field_name="access_request_enabled") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - target_resolution: "TargetResolution | None" = dc_field( + target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @dataclass class ScreensharingSettingsRequest(DataClassJsonMixin): - access_request_enabled: bool | None = dc_field( + access_request_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="access_request_enabled") ) - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - target_resolution: "TargetResolution | None" = dc_field( + target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @@ -25372,7 +29301,7 @@ class ScreensharingSettingsResponse(DataClassJsonMixin): metadata=dc_config(field_name="access_request_enabled") ) enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) - target_resolution: "TargetResolution | None" = dc_field( + target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @@ -25380,32 +29309,38 @@ class ScreensharingSettingsResponse(DataClassJsonMixin): @dataclass class SearchPayload(DataClassJsonMixin): # Channel filter conditions - filter_conditions: dict[str, object] = dc_field( + filter_conditions: Dict[str, object] = dc_field( metadata=dc_config(field_name="filter_conditions") ) - force_default_search: bool | None = dc_field( + force_default_search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_default_search") ) - force_sql_v2_backend: bool | None = dc_field( + 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) + limit: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="limit") + ) # Pagination parameter. Cannot be used with non-zero offset. - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + next: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="next")) # Pagination offset. Cannot be used with sort or next. - offset: int | None = dc_field(default=None, metadata=dc_config(field_name="offset")) + offset: Optional[int] = dc_field( + default=None, metadata=dc_config(field_name="offset") + ) # Search phrase - query: str | None = dc_field(default=None, metadata=dc_config(field_name="query")) + query: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="query") + ) # Sort parameters. Cannot be used with non-zero offset - sort: "list[SortParamRequest] | None" = dc_field( + sort: "Optional[List[SortParamRequest]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) # Message filter conditions - message_filter_conditions: dict[str, object] | None = dc_field( + message_filter_conditions: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="message_filter_conditions") ) - message_options: "MessageOptions | None" = dc_field( + message_options: "Optional[MessageOptions]" = dc_field( default=None, metadata=dc_config(field_name="message_options") ) @@ -25415,21 +29350,21 @@ 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")) + results: "List[SearchResult]" = dc_field(metadata=dc_config(field_name="results")) # Value to pass to the next search query in order to paginate - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) + 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: str | None = dc_field( + previous: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="previous") ) - results_warning: "SearchWarning | None" = dc_field( + results_warning: "Optional[SearchWarning]" = dc_field( default=None, metadata=dc_config(field_name="results_warning") ) @dataclass class SearchResult(DataClassJsonMixin): - message: "SearchResultMessage | None" = dc_field( + message: "Optional[SearchResultMessage]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -25468,34 +29403,34 @@ class SearchResultMessage(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - attachments: "list[Attachment]" = dc_field( + attachments: "List[Attachment]" = dc_field( metadata=dc_config(field_name="attachments") ) - latest_reactions: "list[ReactionResponse]" = dc_field( + latest_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="latest_reactions") ) - mentioned_users: "list[UserResponse]" = dc_field( + mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) - own_reactions: "list[ReactionResponse]" = dc_field( + own_reactions: "List[ReactionResponse]" = dc_field( metadata=dc_config(field_name="own_reactions") ) - restricted_visibility: list[str] = dc_field( + 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( + 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( + 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: str | None = dc_field( + command: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="command") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -25504,10 +29439,10 @@ class SearchResultMessage(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_for_me: bool | None = dc_field( + deleted_for_me: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="deleted_for_me") ) - message_text_updated_at: datetime | None = dc_field( + message_text_updated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="message_text_updated_at", @@ -25516,11 +29451,11 @@ class SearchResultMessage(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - mml: str | None = dc_field(default=None, metadata=dc_config(field_name="mml")) - parent_id: str | None = dc_field( + 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: datetime | None = dc_field( + pin_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pin_expires", @@ -25529,7 +29464,7 @@ class SearchResultMessage(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - pinned_at: datetime | None = dc_field( + pinned_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="pinned_at", @@ -25538,69 +29473,69 @@ class SearchResultMessage(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - poll_id: str | None = dc_field( + poll_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="poll_id") ) - quoted_message_id: str | None = dc_field( + quoted_message_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="quoted_message_id") ) - show_in_channel: bool | None = dc_field( + show_in_channel: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_in_channel") ) - mentioned_group_ids: list[str] | None = dc_field( + mentioned_group_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_group_ids") ) - mentioned_groups: "list[UserGroupResponse] | None" = dc_field( + mentioned_groups: "Optional[List[UserGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_groups") ) - mentioned_roles: list[str] | None = dc_field( + mentioned_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_roles") ) - thread_participants: "list[UserResponse] | None" = dc_field( + thread_participants: "Optional[List[UserResponse]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) - draft: "DraftResponse | None" = dc_field( + draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) - i18n: "dict[str, str] | None" = dc_field( + i18n: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="i18n") ) - image_labels: "dict[str, list[str]] | None" = dc_field( + image_labels: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="image_labels") ) - member: "ChannelMemberPartialResponse | None" = dc_field( + member: "Optional[ChannelMemberPartialResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) - mentioned_channel_members: "dict[str, ChannelMemberPartialResponse] | None" = ( + mentioned_channel_members: "Optional[Dict[str, ChannelMemberPartialResponse]]" = ( dc_field( default=None, metadata=dc_config(field_name="mentioned_channel_members") ) ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) # User response object - pinned_by: "UserResponse | None" = dc_field( + pinned_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="pinned_by") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) # Represents any chat message - quoted_message: "MessageResponse | None" = dc_field( + quoted_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="quoted_message") ) - reaction_groups: "dict[str, ReactionGroupResponse | None] | None" = dc_field( + reaction_groups: "Optional[Dict[str, Optional[ReactionGroupResponse]]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) - reminder: "ReminderResponseData | None" = dc_field( + reminder: "Optional[ReminderResponseData]" = dc_field( default=None, metadata=dc_config(field_name="reminder") ) - shared_location: "SharedLocationResponseData | None" = dc_field( + shared_location: "Optional[SharedLocationResponseData]" = dc_field( default=None, metadata=dc_config(field_name="shared_location") ) @@ -25609,14 +29544,14 @@ class SearchResultMessage(DataClassJsonMixin): 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")) + 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( + user_groups: "List[UserGroupResponse]" = dc_field( metadata=dc_config(field_name="user_groups") ) @@ -25630,11 +29565,11 @@ class SearchWarning(DataClassJsonMixin): metadata=dc_config(field_name="warning_description") ) # Number of channels searched - channel_search_count: int | None = dc_field( + 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: list[str] | None = dc_field( + channel_search_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_search_cids") ) @@ -25665,7 +29600,7 @@ class Segment(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -25674,13 +29609,13 @@ class Segment(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - task_id: str | None = dc_field( + task_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="task_id") ) - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -25720,7 +29655,7 @@ class SegmentResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - filter: dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) + filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) @dataclass @@ -25743,29 +29678,29 @@ class Segments(DataClassJsonMixin): by_country_reason: str = dc_field( metadata=dc_config(field_name="by_country_reason") ) - by_browser: "list[BroadcastSegment]" = dc_field( + by_browser: "List[BroadcastSegment]" = dc_field( metadata=dc_config(field_name="by_browser") ) - by_country: "list[BroadcastSegment]" = dc_field( + by_country: "List[BroadcastSegment]" = dc_field( metadata=dc_config(field_name="by_country") ) - by_delivery_zone: "list[DeliveryZoneSegment]" = dc_field( + 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")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -25780,7 +29715,7 @@ class SendCallEventResponse(DataClassJsonMixin): 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: datetime | None = dc_field( + end_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_time", @@ -25789,13 +29724,13 @@ class SendClosedCaptionRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - language: str | None = dc_field( + language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) - service: str | None = dc_field( + service: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="service") ) - start_time: datetime | None = dc_field( + start_time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="start_time", @@ -25804,14 +29739,14 @@ class SendClosedCaptionRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - translated: bool | None = dc_field( + translated: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="translated") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -25830,30 +29765,40 @@ class SendEventRequest(DataClassJsonMixin): class SendMessageRequest(DataClassJsonMixin): # Message data for creating or updating a message message: "MessageRequest" = dc_field(metadata=dc_config(field_name="message")) - force_moderation: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + include_mentioned_members: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="include_mentioned_members") ) - keep_channel_hidden: bool | None = dc_field( + keep_channel_hidden: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_channel_hidden") ) - pending: bool | None = dc_field( + pending: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="pending") ) - skip_enrich_url: bool | None = dc_field( + # 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: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - pending_message_metadata: "dict[str, str] | None" = dc_field( + pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @@ -25865,17 +29810,21 @@ class SendMessageResponse(DataClassJsonMixin): # Represents any chat message message: "MessageResponse" = dc_field(metadata=dc_config(field_name="message")) # Slim channel object: identity plus creator - channel_context: "ChannelContextResponse | None" = dc_field( + 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: "dict[str, bool] | None" = dc_field( + mentioned_members: "Optional[Dict[str, bool]]" = dc_field( default=None, metadata=dc_config(field_name="mentioned_members") ) # Pending message metadata - pending_message_metadata: "dict[str, str] | None" = dc_field( + 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 @@ -25883,11 +29832,11 @@ 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: bool | None = dc_field( + enforce_unique: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique") ) # Skips any mobile push notifications - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) @@ -25901,6 +29850,16 @@ class SendReactionResponse(DataClassJsonMixin): 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")) @@ -25908,15 +29867,15 @@ class SendUserCustomEventRequest(DataClassJsonMixin): @dataclass class SessionClient(DataClassJsonMixin): - ip: str | None = dc_field(default=None, metadata=dc_config(field_name="ip")) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - network_type: str | None = dc_field( + 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: str | None = dc_field( + version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="version") ) - location: "CallStatsLocation | None" = dc_field( + location: "Optional[CallStatsLocation]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -25946,7 +29905,7 @@ class SessionSettingsResponse(DataClassJsonMixin): class SessionWarningResponse(DataClassJsonMixin): code: str = dc_field(metadata=dc_config(field_name="code")) warning: str = dc_field(metadata=dc_config(field_name="warning")) - time: datetime | None = dc_field( + time: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="time", @@ -25958,9 +29917,47 @@ class SessionWarningResponse(DataClassJsonMixin): @dataclass -class SetRetentionPolicyRequest(DataClassJsonMixin): +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 @@ -25968,6 +29965,9 @@ 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 @@ -25980,8 +29980,10 @@ class SetupSession(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - current_step: str = dc_field(metadata=dc_config(field_name="current_step")) - status: str = dc_field(metadata=dc_config(field_name="status")) + # 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", @@ -25990,10 +29992,10 @@ class SetupSession(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - setup_data: dict[str, object] = dc_field( + setup_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="setup_data") ) - completed_at: datetime | None = dc_field( + completed_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="completed_at", @@ -26004,10 +30006,30 @@ class SetupSession(DataClassJsonMixin): ) +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: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) + reason: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="reason") + ) @dataclass @@ -26031,10 +30053,10 @@ class ShareResponse(DataClassJsonMixin): 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: str | None = dc_field( + created_by_device_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_device_id") ) - end_at: datetime | None = dc_field( + end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", @@ -26081,7 +30103,7 @@ class SharedLocationResponse(DataClassJsonMixin): # User ID user_id: str = dc_field(metadata=dc_config(field_name="user_id")) # Time when the live location expires - end_at: datetime | None = dc_field( + end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", @@ -26091,18 +30113,20 @@ class SharedLocationResponse(DataClassJsonMixin): ), ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + 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", @@ -26111,12 +30135,17 @@ class SharedLocationResponseData(DataClassJsonMixin): 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", @@ -26125,8 +30154,11 @@ class SharedLocationResponseData(DataClassJsonMixin): 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")) - end_at: datetime | None = dc_field( + # 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", @@ -26136,11 +30168,11 @@ class SharedLocationResponseData(DataClassJsonMixin): ), ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -26148,18 +30180,18 @@ class SharedLocationResponseData(DataClassJsonMixin): @dataclass class SharedLocationsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - active_live_locations: "list[SharedLocationResponseData]" = dc_field( + active_live_locations: "List[SharedLocationResponseData]" = dc_field( metadata=dc_config(field_name="active_live_locations") ) @dataclass class ShowChannelRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -26175,7 +30207,7 @@ 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: bool | None = dc_field( + notification_created: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="notification_created") ) @@ -26193,11 +30225,11 @@ class SipInboundCredentials(DataClassJsonMixin): # 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( + 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( + user_custom_data: Dict[str, object] = dc_field( metadata=dc_config(field_name="user_custom_data") ) @@ -26212,23 +30244,36 @@ class SortParam(DataClassJsonMixin): @dataclass class SortParamRequest(DataClassJsonMixin): # Direction of sorting, 1 for Ascending, -1 for Descending, default is 1. One of: -1, 1 - direction: int | None = dc_field( + direction: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="direction") ) # Name of field to sort by - field: str | None = dc_field(default=None, metadata=dc_config(field_name="field")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + 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( + interruptions: "List[SourceInterruption]" = dc_field( metadata=dc_config(field_name="interruptions") ) - publisher_sessions: "list[PublisherSession]" = dc_field( + publisher_sessions: "List[PublisherSession]" = dc_field( metadata=dc_config(field_name="publisher_sessions") ) @@ -26238,24 +30283,24 @@ 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: bool | None = dc_field( + seamless: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="seamless") ) @dataclass class SpeechSegmentConfig(DataClassJsonMixin): - max_speech_caption_ms: int | None = dc_field( + max_speech_caption_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_speech_caption_ms") ) - silence_duration_ms: int | None = dc_field( + silence_duration_ms: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="silence_duration_ms") ) @dataclass class StartCampaignRequest(DataClassJsonMixin): - scheduled_for: datetime | None = dc_field( + scheduled_for: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="scheduled_for", @@ -26264,7 +30309,7 @@ class StartCampaignRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - stop_at: datetime | None = dc_field( + stop_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="stop_at", @@ -26279,10 +30324,10 @@ class StartCampaignRequest(DataClassJsonMixin): class StartCampaignResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - campaign: "CampaignResponse | None" = dc_field( + campaign: "Optional[CampaignResponse]" = dc_field( default=None, metadata=dc_config(field_name="campaign") ) - users: "PagerResponse | None" = dc_field( + users: "Optional[PagerResponse]" = dc_field( default=None, metadata=dc_config(field_name="users") ) @@ -26290,18 +30335,18 @@ class StartCampaignResponse(DataClassJsonMixin): @dataclass class StartClosedCaptionsRequest(DataClassJsonMixin): # Enable transcriptions along with closed captions - enable_transcription: bool | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) - speech_segment_config: "SpeechSegmentConfig | None" = dc_field( + speech_segment_config: "Optional[SpeechSegmentConfig]" = dc_field( default=None, metadata=dc_config(field_name="speech_segment_config") ) @@ -26313,7 +30358,7 @@ class StartClosedCaptionsResponse(DataClassJsonMixin): @dataclass class StartFrameRecordingRequest(DataClassJsonMixin): - recording_external_storage: str | None = dc_field( + recording_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_external_storage") ) @@ -26324,27 +30369,17 @@ class StartFrameRecordingResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) -@dataclass -class StartHLSBroadcastingRequest(DataClassJsonMixin): - pass - - @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 StartPolicyTestRunRequest(DataClassJsonMixin): - pass + 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( + broadcasts: "List[RTMPBroadcastRequest]" = dc_field( metadata=dc_config(field_name="broadcasts") ) @@ -26357,7 +30392,7 @@ class StartRTMPBroadcastsResponse(DataClassJsonMixin): @dataclass class StartRecordingRequest(DataClassJsonMixin): - recording_external_storage: str | None = dc_field( + recording_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="recording_external_storage") ) @@ -26371,15 +30406,15 @@ class StartRecordingResponse(DataClassJsonMixin): @dataclass class StartTranscriptionRequest(DataClassJsonMixin): # Enable closed captions along with transcriptions - enable_closed_captions: bool | None = dc_field( + 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: str | None = dc_field( + language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) # Store transcriptions in this external storage - transcription_external_storage: str | None = dc_field( + transcription_external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="transcription_external_storage") ) @@ -26390,11 +30425,6 @@ class StartTranscriptionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) -@dataclass -class StopAllRTMPBroadcastsRequest(DataClassJsonMixin): - pass - - @dataclass class StopAllRTMPBroadcastsResponse(DataClassJsonMixin): # Duration of the request in milliseconds @@ -26402,13 +30432,17 @@ class StopAllRTMPBroadcastsResponse(DataClassJsonMixin): @dataclass -class StopCampaignRequest(DataClassJsonMixin): - pass +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: bool | None = dc_field( + stop_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stop_transcription") ) @@ -26419,22 +30453,12 @@ class StopClosedCaptionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) -@dataclass -class StopFrameRecordingRequest(DataClassJsonMixin): - pass - - @dataclass class StopFrameRecordingResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) -@dataclass -class StopHLSBroadcastingRequest(DataClassJsonMixin): - pass - - @dataclass class StopHLSBroadcastingResponse(DataClassJsonMixin): # Duration of the request in milliseconds @@ -26443,28 +30467,28 @@ class StopHLSBroadcastingResponse(DataClassJsonMixin): @dataclass class StopLiveRequest(DataClassJsonMixin): - continue_closed_caption: bool | None = dc_field( + continue_closed_caption: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_closed_caption") ) - continue_composite_recording: bool | None = dc_field( + continue_composite_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_composite_recording") ) - continue_hls: bool | None = dc_field( + continue_hls: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_hls") ) - continue_individual_recording: bool | None = dc_field( + continue_individual_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_individual_recording") ) - continue_raw_recording: bool | None = dc_field( + continue_raw_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_raw_recording") ) - continue_recording: bool | None = dc_field( + continue_recording: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_recording") ) - continue_rtmp_broadcasts: bool | None = dc_field( + continue_rtmp_broadcasts: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_rtmp_broadcasts") ) - continue_transcription: bool | None = dc_field( + continue_transcription: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="continue_transcription") ) @@ -26500,7 +30524,7 @@ class StopRecordingResponse(DataClassJsonMixin): @dataclass class StopTranscriptionRequest(DataClassJsonMixin): - stop_closed_captions: bool | None = dc_field( + stop_closed_captions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="stop_closed_captions") ) @@ -26514,11 +30538,11 @@ class StopTranscriptionResponse(DataClassJsonMixin): @dataclass class StoriesConfig(DataClassJsonMixin): # Whether to skip already watched stories - skip_watched: bool | None = dc_field( + skip_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_watched") ) # Whether to track watched status for stories - track_watched: bool | None = dc_field( + track_watched: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="track_watched") ) @@ -26536,15 +30560,16 @@ class StoriesFeedUpdatedEvent(DataClassJsonMixin): ) # 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")) + 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") ) - feed_visibility: str | None = dc_field( + # Who can see and follow a feed. + feed_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="feed_visibility") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -26554,105 +30579,118 @@ class StoriesFeedUpdatedEvent(DataClassJsonMixin): ), ) # Individual activities for stories feeds - activities: "list[ActivityResponse] | None" = dc_field( + activities: "Optional[List[ActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="activities") ) # Aggregated activities for stories feeds - aggregated_activities: "list[AggregatedActivityResponse] | None" = dc_field( + aggregated_activities: "Optional[List[AggregatedActivityResponse]]" = dc_field( default=None, metadata=dc_config(field_name="aggregated_activities") ) - user: "UserResponseCommonFields | None" = dc_field( + 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, ban, custom, unban, restore, delete_user, delete_user_messages, unblock, block, shadow_block, unmask, kick_user, end_call, escalate, de_escalate + # 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: str | None = dc_field( + 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: str | None = dc_field( + item_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="item_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Configuration for ban moderation action - ban: "BanActionRequestPayload | None" = dc_field( + ban: "Optional[BanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="ban") ) # Configuration for block action - block: "BlockActionRequestPayload | None" = dc_field( + block: "Optional[BlockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="block") ) - bypass: "BypassActionRequest | None" = dc_field( + bypass: "Optional[BypassActionRequest]" = dc_field( default=None, metadata=dc_config(field_name="bypass") ) # Configuration for custom moderation action - custom: "CustomActionRequestPayload | None" = dc_field( + custom: "Optional[CustomActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="custom") ) # Configuration for activity deletion action - delete_activity: "DeleteActivityRequestPayload | None" = dc_field( + delete_activity: "Optional[DeleteActivityRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_activity") ) # Configuration for comment deletion action - delete_comment: "DeleteCommentRequestPayload | None" = dc_field( + delete_comment: "Optional[DeleteCommentRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_comment") ) # Configuration for message deletion action - delete_message: "DeleteMessageRequestPayload | None" = dc_field( + 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: "DeleteReactionRequestPayload | None" = dc_field( + delete_reaction: "Optional[DeleteReactionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_reaction") ) # Configuration for user deletion action - delete_user: "DeleteUserRequestPayload | None" = dc_field( + 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: "DeleteUserMessagesRequestPayload | None" = dc_field( + delete_user_messages: "Optional[DeleteUserMessagesRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="delete_user_messages") ) # Configuration for escalation action - escalate: "EscalatePayload | None" = dc_field( + escalate: "Optional[EscalatePayload]" = dc_field( default=None, metadata=dc_config(field_name="escalate") ) - flag: "FlagRequest | None" = dc_field( + flag: "Optional[FlagRequest]" = dc_field( default=None, metadata=dc_config(field_name="flag") ) # Configuration for mark reviewed action - mark_reviewed: "MarkReviewedRequestPayload | None" = dc_field( + mark_reviewed: "Optional[MarkReviewedRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="mark_reviewed") ) # Configuration for rejecting an appeal - reject_appeal: "RejectAppealRequestPayload | None" = dc_field( + 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: "RestoreActionRequestPayload | None" = dc_field( + restore: "Optional[RestoreActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="restore") ) # Configuration for shadow block action - shadow_block: "ShadowBlockActionRequestPayload | None" = dc_field( + shadow_block: "Optional[ShadowBlockActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="shadow_block") ) # Configuration for unban moderation action - unban: "UnbanActionRequestPayload | None" = dc_field( + unban: "Optional[UnbanActionRequestPayload]" = dc_field( default=None, metadata=dc_config(field_name="unban") ) - # Deprecated: use restore instead — it now also reverses a block or shadow block. Configuration for unblock action. - unblock: "UnblockActionRequestPayload | None" = dc_field( + # 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -26661,78 +30699,167 @@ class SubmitActionRequest(DataClassJsonMixin): 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: str | None = dc_field( + auto_restore_warning: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="auto_restore_warning") ) - appeal_item: "AppealItemResponse | None" = dc_field( + appeal_item: "Optional[AppealItemResponse]" = dc_field( default=None, metadata=dc_config(field_name="appeal_item") ) - item: "ReviewQueueItemResponse | None" = dc_field( + 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): - # The moderated content the moderator is providing feedback on - message: str = dc_field(metadata=dc_config(field_name="message")) - # Original publication time of the moderated content (RFC3339) - published_at: str = dc_field(metadata=dc_config(field_name="published_at")) - # Provider-side reference identifying the moderated content - reference: str = dc_field(metadata=dc_config(field_name="reference")) # Optional moderation channel UUID for context - channel_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + 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: "SubscriberAudioMetrics | None" = dc_field( + audio: "Optional[SubscriberAudioMetrics]" = dc_field( default=None, metadata=dc_config(field_name="audio") ) - rtt_ms: "ActiveCallsLatencyStats | None" = dc_field( + rtt_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="rtt_ms") ) - video: "SubscriberVideoMetrics | None" = dc_field( + video: "Optional[SubscriberVideoMetrics]" = dc_field( default=None, metadata=dc_config(field_name="video") ) @dataclass class SubscriberAudioMetrics(DataClassJsonMixin): - concealment_pct: "ActiveCallsLatencyStats | None" = dc_field( + concealment_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="concealment_pct") ) - jitter_ms: "ActiveCallsLatencyStats | None" = dc_field( + jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) - packets_lost_pct: "ActiveCallsLatencyStats | None" = dc_field( + packets_lost_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="packets_lost_pct") ) @@ -26748,33 +30875,33 @@ class SubscriberStatsResponse(DataClassJsonMixin): @dataclass class SubscriberVideoMetrics(DataClassJsonMixin): - fps_30: "ActiveCallsFPSStats | None" = dc_field( + fps_30: "Optional[ActiveCallsFPSStats]" = dc_field( default=None, metadata=dc_config(field_name="fps_30") ) - jitter_ms: "ActiveCallsLatencyStats | None" = dc_field( + jitter_ms: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="jitter_ms") ) - packets_lost_pct: "ActiveCallsLatencyStats | None" = dc_field( + packets_lost_pct: "Optional[ActiveCallsLatencyStats]" = dc_field( default=None, metadata=dc_config(field_name="packets_lost_pct") ) @dataclass class SubscribersMetrics(DataClassJsonMixin): - all: "SubscriberAllMetrics | None" = dc_field( + all: "Optional[SubscriberAllMetrics]" = dc_field( default=None, metadata=dc_config(field_name="all") ) @dataclass class Supporting(DataClassJsonMixin): - delivery_incident_windows: "list[Incident]" = dc_field( + delivery_incident_windows: "List[Incident]" = dc_field( metadata=dc_config(field_name="delivery_incident_windows") ) - edge_outlier_zones: list[str] = dc_field( + edge_outlier_zones: List[str] = dc_field( metadata=dc_config(field_name="edge_outlier_zones") ) - source_drop_windows: "list[TimeWindow]" = dc_field( + source_drop_windows: "List[TimeWindow]" = dc_field( metadata=dc_config(field_name="source_drop_windows") ) @@ -26783,7 +30910,7 @@ class Supporting(DataClassJsonMixin): class TargetResolution(DataClassJsonMixin): height: int = dc_field(metadata=dc_config(field_name="height")) width: int = dc_field(metadata=dc_config(field_name="width")) - bitrate: int | None = dc_field( + bitrate: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="bitrate") ) @@ -26856,59 +30983,59 @@ class TeamUsageStats(DataClassJsonMixin): @dataclass class TextContentParameters(DataClassJsonMixin): - contains_url: bool | None = dc_field( + contains_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="contains_url") ) - label_operator: str | None = dc_field( + label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - text_length: int | None = dc_field( + text_length: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="text_length") ) - text_length_operator: str | None = dc_field( + text_length_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="text_length_operator") ) - blocklist_match: list[str] | None = dc_field( + blocklist_match: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklist_match") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) - llm_harm_labels: "dict[str, str] | None" = dc_field( + 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: bool | None = dc_field( + contains_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="contains_url") ) - semantic_filter_min_threshold: float | None = dc_field( + semantic_filter_min_threshold: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_min_threshold") ) - severity: str | None = dc_field( + severity: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="severity") ) - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - blocklist_match: list[str] | None = dc_field( + blocklist_match: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="blocklist_match") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) - semantic_filter_names: list[str] | None = dc_field( + semantic_filter_names: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="semantic_filter_names") ) - llm_harm_labels: "dict[str, str] | None" = dc_field( + llm_harm_labels: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="llm_harm_labels") ) @@ -26933,8 +31060,8 @@ class ThreadParticipant(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) - last_thread_message_at: datetime | None = dc_field( + 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", @@ -26944,7 +31071,7 @@ class ThreadParticipant(DataClassJsonMixin): ), ) # Left Thread At is the time when the user left the thread - left_thread_at: datetime | None = dc_field( + left_thread_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="left_thread_at", @@ -26954,15 +31081,15 @@ class ThreadParticipant(DataClassJsonMixin): ), ) # Thead ID is unique string identifier of the thread - thread_id: str | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27010,9 +31137,9 @@ class ThreadResponse(DataClassJsonMixin): ) ) # Custom data for this object - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Deleted At - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -27022,7 +31149,7 @@ class ThreadResponse(DataClassJsonMixin): ), ) # Last Message At - last_message_at: datetime | None = dc_field( + last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", @@ -27032,19 +31159,19 @@ class ThreadResponse(DataClassJsonMixin): ), ) # Thread Participants - thread_participants: "list[ThreadParticipant] | None" = dc_field( + thread_participants: "Optional[List[ThreadParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) # Represents any chat message - parent_message: "MessageResponse | None" = dc_field( + parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) @@ -27091,13 +31218,13 @@ class ThreadStateResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - latest_replies: "list[MessageResponse]" = dc_field( + 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")) + custom: Dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) # Deleted At - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -27107,7 +31234,7 @@ class ThreadStateResponse(DataClassJsonMixin): ), ) # Last Message At - last_message_at: datetime | None = dc_field( + last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_message_at", @@ -27116,26 +31243,26 @@ class ThreadStateResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - read: "list[ReadStateResponse] | None" = dc_field( + read: "Optional[List[ReadStateResponse]]" = dc_field( default=None, metadata=dc_config(field_name="read") ) # Thread Participants - thread_participants: "list[ThreadParticipant] | None" = dc_field( + thread_participants: "Optional[List[ThreadParticipant]]" = dc_field( default=None, metadata=dc_config(field_name="thread_participants") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - draft: "DraftResponse | None" = dc_field( + draft: "Optional[DraftResponse]" = dc_field( default=None, metadata=dc_config(field_name="draft") ) # Represents any chat message - parent_message: "MessageResponse | None" = dc_field( + parent_message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="parent_message") ) @@ -27150,18 +31277,18 @@ class ThreadUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_type: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -27170,7 +31297,7 @@ class ThreadUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - thread: "ThreadResponse | None" = dc_field( + thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) @@ -27190,6 +31317,7 @@ class ThreadedCommentResponse(DataClassJsonMixin): ) ) 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")) @@ -27197,7 +31325,7 @@ class ThreadedCommentResponse(DataClassJsonMixin): 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: str = dc_field(metadata=dc_config(field_name="status")) + status: "CommentStatus" = dc_field(metadata=dc_config(field_name="status")) updated_at: datetime = dc_field( metadata=dc_config( field_name="updated_at", @@ -27207,18 +31335,18 @@ class ThreadedCommentResponse(DataClassJsonMixin): ) ) upvote_count: int = dc_field(metadata=dc_config(field_name="upvote_count")) - mentioned_users: "list[UserResponse]" = dc_field( + mentioned_users: "List[UserResponse]" = dc_field( metadata=dc_config(field_name="mentioned_users") ) - own_reactions: "list[FeedsReactionResponse]" = dc_field( + 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: float | None = dc_field( + controversy_score: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="controversy_score") ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -27227,7 +31355,7 @@ class ThreadedCommentResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - edited_at: datetime | None = dc_field( + edited_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="edited_at", @@ -27236,47 +31364,47 @@ class ThreadedCommentResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - parent_id: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - attachments: "list[Attachment] | None" = dc_field( + 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: "list[FeedsReactionResponse] | None" = dc_field( + latest_reactions: "Optional[List[FeedsReactionResponse]]" = dc_field( default=None, metadata=dc_config(field_name="latest_reactions") ) # Slice of nested comments (may be empty). - replies: "list[ThreadedCommentResponse] | None" = dc_field( + replies: "Optional[List[ThreadedCommentResponse]]" = dc_field( default=None, metadata=dc_config(field_name="replies") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - i18n: "dict[str, str] | None" = dc_field( + 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: "RepliesMeta | None" = dc_field( + meta: "Optional[RepliesMeta]" = dc_field( default=None, metadata=dc_config(field_name="meta") ) - moderation: "ModerationV2Response | None" = dc_field( + moderation: "Optional[ModerationV2Response]" = dc_field( default=None, metadata=dc_config(field_name="moderation") ) - reaction_groups: "dict[str, FeedsReactionGroupResponse] | None" = dc_field( + reaction_groups: "Optional[Dict[str, FeedsReactionGroupResponse]]" = dc_field( default=None, metadata=dc_config(field_name="reaction_groups") ) @dataclass class Thresholds(DataClassJsonMixin): - explicit: "LabelThresholds | None" = dc_field( + explicit: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="explicit") ) - spam: "LabelThresholds | None" = dc_field( + spam: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="spam") ) - toxic: "LabelThresholds | None" = dc_field( + toxic: "Optional[LabelThresholds]" = dc_field( default=None, metadata=dc_config(field_name="toxic") ) @@ -27293,7 +31421,7 @@ class ThumbnailsSettings(DataClassJsonMixin): @dataclass class ThumbnailsSettingsRequest(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) @@ -27303,11 +31431,6 @@ class ThumbnailsSettingsResponse(DataClassJsonMixin): enabled: bool = dc_field(metadata=dc_config(field_name="enabled")) -@dataclass -class Time(DataClassJsonMixin): - pass - - @dataclass class TimeWindow(DataClassJsonMixin): _from: str = dc_field(metadata=dc_config(field_name="from")) @@ -27321,7 +31444,7 @@ class TopBroadcast(DataClassJsonMixin): peak_concurrent_viewers: int = dc_field( metadata=dc_config(field_name="peak_concurrent_viewers") ) - poor_pct: float | None = dc_field( + poor_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="poor_pct") ) @@ -27330,10 +31453,24 @@ class TopBroadcast(DataClassJsonMixin): 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). Alphanumeric and underscores only. + # 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: int | None = dc_field(default=None, metadata=dc_config(field_name="delta")) + 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 @@ -27345,20 +31482,22 @@ class TrackActivityMetricsEventResult(DataClassJsonMixin): # The metric name from the request metric: str = dc_field(metadata=dc_config(field_name="metric")) # Error message if processing failed - error: str | None = dc_field(default=None, metadata=dc_config(field_name="error")) + 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( + events: "List[TrackActivityMetricsEvent]" = dc_field( metadata=dc_config(field_name="events") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27367,7 +31506,7 @@ class TrackActivityMetricsRequest(DataClassJsonMixin): 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( + results: "List[TrackActivityMetricsEventResult]" = dc_field( metadata=dc_config(field_name="results") ) @@ -27378,51 +31517,107 @@ class TrackStatsResponse(DataClassJsonMixin): 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: str = dc_field( + 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: str = dc_field(metadata=dc_config(field_name="language")) - mode: str = dc_field(metadata=dc_config(field_name="mode")) - speech_segment_config: "SpeechSegmentConfig | None" = dc_field( + 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: "TranslationSettings | None" = dc_field( + translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @dataclass class TranscriptionSettingsRequest(DataClassJsonMixin): - closed_caption_mode: str | None = dc_field( + # 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: str | None = dc_field( + # Language a call is transcribed or captioned in. + language: "Optional[TranscriptionLanguage]" = dc_field( default=None, metadata=dc_config(field_name="language") ) - mode: str | None = dc_field(default=None, metadata=dc_config(field_name="mode")) - speech_segment_config: "SpeechSegmentConfig | None" = dc_field( + # 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: "TranslationSettings | None" = dc_field( + translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @dataclass class TranscriptionSettingsResponse(DataClassJsonMixin): - closed_caption_mode: str = dc_field( + # 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: str = dc_field(metadata=dc_config(field_name="language")) - mode: str = dc_field(metadata=dc_config(field_name="mode")) - speech_segment_config: "SpeechSegmentConfig | None" = dc_field( + # 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: "TranslationSettings | None" = dc_field( + translation: "Optional[TranslationSettings]" = dc_field( default=None, metadata=dc_config(field_name="translation") ) @@ -27469,10 +31664,10 @@ class TranslateMessageResponse(DataClassJsonMixin): @dataclass class TranslationSettings(DataClassJsonMixin): - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - languages: list[str] | None = dc_field( + languages: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="languages") ) @@ -27482,18 +31677,18 @@ 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")) + actions: List[str] = dc_field(metadata=dc_config(field_name="actions")) # Name of the moderation rule that triggered - rule_name: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + type: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="type")) # Violation count for action sequence rules (1-based) - violation_number: int | None = dc_field( + violation_number: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="violation_number") ) - call_options: "CallActionOptions | None" = dc_field( + call_options: "Optional[CallActionOptions]" = dc_field( default=None, metadata=dc_config(field_name="call_options") ) @@ -27501,15 +31696,15 @@ class TriggeredRuleResponse(DataClassJsonMixin): @dataclass class TruncateChannelRequest(DataClassJsonMixin): # Permanently delete channel data (messages, reactions, etc.) - hard_delete: bool | None = dc_field( + 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: bool | None = dc_field( + 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: datetime | None = dc_field( + truncated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="truncated_at", @@ -27518,19 +31713,19 @@ class TruncateChannelRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: "MessageRequest | None" = dc_field( + message: "Optional[MessageRequest]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27540,11 +31735,11 @@ class TruncateChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @@ -27557,19 +31752,23 @@ class TypingIndicatorsResponse(DataClassJsonMixin): @dataclass class UnbanActionRequestPayload(DataClassJsonMixin): # Channel CID for channel-specific unban - channel_cid: str | None = dc_field( + channel_cid: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_cid") ) # Reason for the appeal decision - decision_reason: str | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + target_user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="target_user_id") ) @@ -27578,11 +31777,12 @@ class UnbanActionRequestPayload(DataClassJsonMixin): class UnbanRequest(DataClassJsonMixin): # ID of the user performing the unban Deprecated: not used by the unban flow # Deprecated - unbanned_by_id: str | None = dc_field( + unbanned_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="unbanned_by_id") ) # User request object - unbanned_by: "UserRequest | None" = dc_field( + # Deprecated + unbanned_by: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="unbanned_by") ) @@ -27595,7 +31795,7 @@ class UnbanResponse(DataClassJsonMixin): @dataclass class UnblockActionRequestPayload(DataClassJsonMixin): # Reason for the appeal decision - decision_reason: str | None = dc_field( + decision_reason: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="decision_reason") ) @@ -27615,11 +31815,11 @@ class UnblockUserResponse(DataClassJsonMixin): @dataclass class UnblockUsersRequest(DataClassJsonMixin): blocked_user_id: str = dc_field(metadata=dc_config(field_name="blocked_user_id")) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27666,13 +31866,17 @@ class UndeleteMessageResponse(DataClassJsonMixin): @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")) + 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: bool | None = dc_field( + 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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) @@ -27681,7 +31885,11 @@ class UnfollowBatchRequest(DataClassJsonMixin): 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")) + 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 @@ -27691,7 +31899,7 @@ class UnfollowPair(DataClassJsonMixin): # 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: bool | None = dc_field( + keep_history: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="keep_history") ) @@ -27705,18 +31913,18 @@ class UnfollowResponse(DataClassJsonMixin): @dataclass class UnmuteChannelRequest(DataClassJsonMixin): # Duration of mute in milliseconds - expiration: int | None = dc_field( + expiration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="expiration") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Channel CIDs to mute (if multiple channels) - channel_cids: list[str] | None = dc_field( + channel_cids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="channel_cids") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27724,12 +31932,12 @@ class UnmuteChannelRequest(DataClassJsonMixin): @dataclass class UnmuteRequest(DataClassJsonMixin): # User IDs to unmute - target_ids: list[str] = dc_field(metadata=dc_config(field_name="target_ids")) - user_id: str | None = dc_field( + 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: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27738,7 +31946,7 @@ class UnmuteRequest(DataClassJsonMixin): 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: list[str] | None = dc_field( + non_existing_users: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="non_existing_users") ) @@ -27769,21 +31977,25 @@ class UnpinResponse(DataClassJsonMixin): @dataclass class UnreadCountsBatchRequest(DataClassJsonMixin): - user_ids: list[str] = dc_field(metadata=dc_config(field_name="user_ids")) + 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, UnreadCountsResponse | None]" = dc_field( + 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", @@ -27792,13 +32004,17 @@ class UnreadCountsChannel(DataClassJsonMixin): 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")) @@ -27810,22 +32026,23 @@ class UnreadCountsResponse(DataClassJsonMixin): total_unread_threads_count: int = dc_field( metadata=dc_config(field_name="total_unread_threads_count") ) - channel_type: "list[UnreadCountsChannelType]" = dc_field( + channel_type: "List[UnreadCountsChannelType]" = dc_field( metadata=dc_config(field_name="channel_type") ) - channels: "list[UnreadCountsChannel]" = dc_field( + channels: "List[UnreadCountsChannel]" = dc_field( metadata=dc_config(field_name="channels") ) - threads: "list[UnreadCountsThread]" = dc_field( + threads: "List[UnreadCountsThread]" = dc_field( metadata=dc_config(field_name="threads") ) - total_unread_count_by_team: "dict[str, int] | None" = dc_field( + 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", @@ -27834,23 +32051,26 @@ class UnreadCountsThread(DataClassJsonMixin): 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( + 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: bool | None = dc_field( + force_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="force_moderation") ) @@ -27859,7 +32079,7 @@ class UpdateActivitiesPartialBatchRequest(DataClassJsonMixin): class UpdateActivitiesPartialBatchResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of successfully updated activities - activities: "list[ActivityResponse]" = dc_field( + activities: "List[ActivityResponse]" = dc_field( metadata=dc_config(field_name="activities") ) @@ -27870,19 +32090,19 @@ class UpdateActivityPartialChangeRequest(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @@ -27891,38 +32111,38 @@ class UpdateActivityPartialChangeRequest(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_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: bool | None = dc_field( + 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: bool | None = dc_field( + run_activity_processors: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="run_activity_processors") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -27937,15 +32157,15 @@ class UpdateActivityPartialResponse(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: datetime | None = dc_field( + expires_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires_at", @@ -27955,79 +32175,79 @@ class UpdateActivityRequest(DataClassJsonMixin): ), ) # 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: bool | None = dc_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: bool | None = dc_field( + handle_mention_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="handle_mention_notifications") ) # Poll ID - poll_id: str | None = dc_field( + 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: str | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # The text content of the activity - text: str | None = dc_field(default=None, metadata=dc_config(field_name="text")) - user_id: str | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field( + visibility_tag: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="visibility_tag") ) # List of attachments for the activity - attachments: "list[Attachment] | None" = dc_field( + attachments: "Optional[List[Attachment]]" = dc_field( default=None, metadata=dc_config(field_name="attachments") ) # Collections that this activity references - collection_refs: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + feeds: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="feeds") ) # Tags used for filtering the activity - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Tags indicating interest categories - interest_tags: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + mentioned_user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="mentioned_user_ids") ) # Custom data for the activity - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) # Additional data for search indexing - search_data: dict[str, object] | None = dc_field( + search_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="search_data") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28040,107 +32260,108 @@ class UpdateActivityResponse(DataClassJsonMixin): @dataclass class UpdateAppRequest(DataClassJsonMixin): - async_url_enrich_enabled: bool | None = dc_field( + async_url_enrich_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="async_url_enrich_enabled") ) - auto_translation_enabled: bool | None = dc_field( + auto_translation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="auto_translation_enabled") ) - before_message_send_hook_attempt_timeout_ms: int | None = dc_field( + 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: str | None = dc_field( + before_message_send_hook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="before_message_send_hook_url") ) - cdn_expiration_seconds: int | None = dc_field( + cdn_expiration_seconds: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cdn_expiration_seconds") ) - channel_hide_members_only: bool | None = dc_field( + channel_hide_members_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="channel_hide_members_only") ) - chat_primary_use_case: str | None = dc_field( + chat_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="chat_primary_use_case") ) - custom_action_handler_url: str | None = dc_field( + custom_action_handler_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="custom_action_handler_url") ) - disable_auth_checks: bool | None = dc_field( + disable_auth_checks: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_auth_checks") ) - disable_permissions_checks: bool | None = dc_field( + disable_permissions_checks: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="disable_permissions_checks") ) - enable_hook_payload_compression: bool | None = dc_field( + enable_hook_payload_compression: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_hook_payload_compression") ) - enforce_unique_usernames: str | None = dc_field( + enforce_unique_usernames: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_usernames") ) - feed_audit_logs_enabled: bool | None = dc_field( + feed_audit_logs_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="feed_audit_logs_enabled") ) - feeds_moderation_enabled: bool | None = dc_field( + feeds_moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="feeds_moderation_enabled") ) - feeds_v2_region: str | None = dc_field( + feeds_v2_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="feeds_v2_region") ) - guest_user_creation_disabled: bool | None = dc_field( + guest_user_creation_disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="guest_user_creation_disabled") ) - image_moderation_enabled: bool | None = dc_field( + image_moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_enabled") ) - max_aggregated_activities_length: int | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + migrate_permissions_to_v2: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="migrate_permissions_to_v2") ) - moderation_analytics_enabled: bool | None = dc_field( + moderation_analytics_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_analytics_enabled") ) - moderation_enabled: bool | None = dc_field( + moderation_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_enabled") ) - moderation_onboarding_complete: bool | None = dc_field( + moderation_onboarding_complete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="moderation_onboarding_complete") ) - moderation_s3_image_access_role_arn: str | None = dc_field( + 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: str | None = dc_field( + moderation_webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="moderation_webhook_url") ) - multi_tenant_enabled: bool | None = dc_field( + multi_tenant_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="multi_tenant_enabled") ) - permission_version: str | None = dc_field( + permission_version: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="permission_version") ) - reminders_interval: int | None = dc_field( + reminders_interval: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_interval") ) - reminders_max_members: int | None = dc_field( + reminders_max_members: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_max_members") ) - reminders_max_per_user: int | None = dc_field( + reminders_max_per_user: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="reminders_max_per_user") ) - revoke_tokens_issued_before: datetime | None = dc_field( + # 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", @@ -28149,116 +32370,119 @@ class UpdateAppRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - sns_key: str | None = dc_field( + sns_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_key") ) - sns_secret: str | None = dc_field( + sns_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_secret") ) - sns_topic_arn: str | None = dc_field( + sns_topic_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sns_topic_arn") ) - sqs_key: str | None = dc_field( + sqs_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_key") ) - sqs_secret: str | None = dc_field( + sqs_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_secret") ) - sqs_url: str | None = dc_field( + sqs_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="sqs_url") ) - user_response_time_enabled: bool | None = dc_field( + 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: str | None = dc_field( + video_primary_use_case: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="video_primary_use_case") ) - webhook_url: str | None = dc_field( + webhook_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="webhook_url") ) - allowed_flag_reasons: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - event_hooks: "list[EventHook] | None" = dc_field( + event_hooks: "Optional[List[EventHook]]" = dc_field( default=None, metadata=dc_config(field_name="event_hooks") ) - image_moderation_block_labels: list[str] | None = dc_field( + image_moderation_block_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_block_labels") ) - image_moderation_labels: list[str] | None = dc_field( + image_moderation_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="image_moderation_labels") ) - user_search_disallowed_roles: list[str] | None = dc_field( + user_search_disallowed_roles: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_search_disallowed_roles") ) - webhook_events: list[str] | None = dc_field( + webhook_events: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="webhook_events") ) - activity_metrics_config: "dict[str, int] | None" = dc_field( + activity_metrics_config: "Optional[Dict[str, int]]" = dc_field( default=None, metadata=dc_config(field_name="activity_metrics_config") ) - apn_config: "APNConfig | None" = dc_field( + apn_config: "Optional[APNConfig]" = dc_field( default=None, metadata=dc_config(field_name="apn_config") ) - async_moderation_config: "AsyncModerationConfiguration | None" = dc_field( + async_moderation_config: "Optional[AsyncModerationConfiguration]" = dc_field( default=None, metadata=dc_config(field_name="async_moderation_config") ) - datadog_info: "DataDogInfo | None" = dc_field( + datadog_info: "Optional[DataDogInfo]" = dc_field( default=None, metadata=dc_config(field_name="datadog_info") ) - file_upload_config: "FileUploadConfig | None" = dc_field( + file_upload_config: "Optional[FileUploadConfig]" = dc_field( default=None, metadata=dc_config(field_name="file_upload_config") ) - firebase_config: "FirebaseConfig | None" = dc_field( + firebase_config: "Optional[FirebaseConfig]" = dc_field( default=None, metadata=dc_config(field_name="firebase_config") ) - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) - huawei_config: "HuaweiConfig | None" = dc_field( + huawei_config: "Optional[HuaweiConfig]" = dc_field( default=None, metadata=dc_config(field_name="huawei_config") ) - image_upload_config: "FileUploadConfig | None" = dc_field( + image_upload_config: "Optional[FileUploadConfig]" = dc_field( default=None, metadata=dc_config(field_name="image_upload_config") ) - moderation_dashboard_preferences: "ModerationDashboardPreferences | None" = ( + moderation_dashboard_preferences: "Optional[ModerationDashboardPreferences]" = ( dc_field( default=None, metadata=dc_config(field_name="moderation_dashboard_preferences"), ) ) - push_config: "PushConfig | None" = dc_field( + push_config: "Optional[PushConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_config") ) - xiaomi_config: "XiaomiConfig | None" = dc_field( + xiaomi_config: "Optional[XiaomiConfig]" = dc_field( default=None, metadata=dc_config(field_name="xiaomi_config") ) @dataclass class UpdateBlockListRequest(DataClassJsonMixin): - is_confusable_folding_enabled: bool | None = dc_field( + is_confusable_folding_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_confusable_folding_enabled") ) - is_leet_check_enabled: bool | None = dc_field( + is_leet_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_leet_check_enabled") ) - is_plural_check_enabled: bool | None = dc_field( + is_plural_check_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_plural_check_enabled") ) - is_substring_matching_enabled: bool | None = dc_field( + is_substring_matching_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_substring_matching_enabled") ) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + words: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="words") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28268,7 +32492,7 @@ 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: "BlockListResponse | None" = dc_field( + blocklist: "Optional[BlockListResponse]" = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) @@ -28276,16 +32500,16 @@ class UpdateBlockListResponse(DataClassJsonMixin): @dataclass class UpdateBookmarkFolderRequest(DataClassJsonMixin): # Name of the folder - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - user_id: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28301,25 +32525,25 @@ class UpdateBookmarkFolderResponse(DataClassJsonMixin): @dataclass class UpdateBookmarkRequest(DataClassJsonMixin): # ID of the folder containing the bookmark - folder_id: str | None = dc_field( + 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: str | None = dc_field( + new_folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_folder_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - new_folder: "AddFolderRequest | None" = dc_field( + new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28333,11 +32557,11 @@ class UpdateBookmarkResponse(DataClassJsonMixin): @dataclass class UpdateCallMembersRequest(DataClassJsonMixin): # List of userID to remove - remove_members: list[str] | None = dc_field( + 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: "list[MemberRequest] | None" = dc_field( + update_members: "Optional[List[MemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="update_members") ) @@ -28346,13 +32570,13 @@ class UpdateCallMembersRequest(DataClassJsonMixin): 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")) + 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: datetime | None = dc_field( + starts_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="starts_at", @@ -28362,10 +32586,10 @@ class UpdateCallRequest(DataClassJsonMixin): ), ) # Custom data for this object - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - settings_override: "CallSettingsRequest | None" = dc_field( + settings_override: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings_override") ) @@ -28373,8 +32597,8 @@ class UpdateCallRequest(DataClassJsonMixin): @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( + 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 @@ -28383,16 +32607,16 @@ class UpdateCallResponse(DataClassJsonMixin): @dataclass class UpdateCallTypeRequest(DataClassJsonMixin): - external_storage: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) - notification_settings: "NotificationSettingsRequest | None" = dc_field( + notification_settings: "Optional[NotificationSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="notification_settings") ) - settings: "CallSettingsRequest | None" = dc_field( + settings: "Optional[CallSettingsRequest]" = dc_field( default=None, metadata=dc_config(field_name="settings") ) @@ -28421,7 +32645,7 @@ class UpdateCallTypeResponse(DataClassJsonMixin): ) ) # the permissions granted to each role - grants: "dict[str, list[str]]" = dc_field(metadata=dc_config(field_name="grants")) + 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") ) @@ -28429,7 +32653,7 @@ class UpdateCallTypeResponse(DataClassJsonMixin): metadata=dc_config(field_name="settings") ) # the external storage for the call type - external_storage: str | None = dc_field( + external_storage: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="external_storage") ) @@ -28440,53 +32664,67 @@ class UpdateCampaignRequest(DataClassJsonMixin): message_template: "CampaignMessageTemplate" = dc_field( metadata=dc_config(field_name="message_template") ) - create_channels: bool | None = dc_field( + create_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="create_channels") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - sender_mode: str | None = dc_field( + 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") ) - sender_visibility: str | None = dc_field( + # How a campaign appears to its sender. + sender_visibility: "Optional[CampaignSenderVisibility]" = dc_field( default=None, metadata=dc_config(field_name="sender_visibility") ) - show_channels: bool | None = dc_field( + show_channels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="show_channels") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - skip_webhook: bool | None = dc_field( + skip_webhook: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_webhook") ) - segment_ids: list[str] | None = dc_field( + segment_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="segment_ids") ) - user_ids: list[str] | None = dc_field( + user_ids: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="user_ids") ) - channel_template: "CampaignChannelTemplate | None" = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - unset: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28496,11 +32734,11 @@ 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( + members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) @@ -28508,19 +32746,19 @@ class UpdateChannelPartialResponse(DataClassJsonMixin): @dataclass class UpdateChannelRequest(DataClassJsonMixin): # Set to `true` to accept the invite - accept_invite: bool | None = dc_field( + 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: int | None = dc_field( + 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: bool | None = dc_field( + 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: datetime | None = dc_field( + hide_history_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="hide_history_before", @@ -28530,57 +32768,57 @@ class UpdateChannelRequest(DataClassJsonMixin): ), ) # Set to `true` to reject the invite - reject_invite: bool | None = dc_field( + 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: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: "list[ChannelMemberRequest] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: "list[ChannelMemberRequest] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: "list[ChannelMemberRequest] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: list[str] | None = dc_field( + remove_members: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="remove_members") ) - data: "ChannelInputRequest | None" = dc_field( + data: "Optional[ChannelInputRequest]" = dc_field( default=None, metadata=dc_config(field_name="data") ) # Message data for creating or updating a message - message: "MessageRequest | None" = dc_field( + message: "Optional[MessageRequest]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28590,130 +32828,146 @@ 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( + members: "List[ChannelMemberResponse]" = dc_field( metadata=dc_config(field_name="members") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) @dataclass class UpdateChannelTypeRequest(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) - max_message_length: int = dc_field( - metadata=dc_config(field_name="max_message_length") + # 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: str | None = dc_field( + blocklist: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="blocklist") ) - blocklist_behavior: str | None = dc_field( + # 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: bool | None = dc_field( + connect_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="connect_events") ) - count_messages: bool | None = dc_field( + count_messages: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="count_messages") ) - custom_events: bool | None = dc_field( + custom_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="custom_events") ) - delivery_events: bool | None = dc_field( + delivery_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="delivery_events") ) - mark_messages_pending: bool | None = dc_field( + mark_messages_pending: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="mark_messages_pending") ) - message_retention: str | None = dc_field( + 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="mutes")) - partition_size: int | None = dc_field( + 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: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - polls: bool | None = dc_field(default=None, metadata=dc_config(field_name="polls")) - push_level: str | None = dc_field( + 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: bool | None = dc_field( + push_notifications: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) - quotes: bool | None = dc_field( + quotes: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="quotes") ) - reactions: bool | None = dc_field( + reactions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reactions") ) - read_events: bool | None = dc_field( + read_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="read_events") ) - reminders: bool | None = dc_field( + reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="reminders") ) - replies: bool | None = dc_field( + replies: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="replies") ) - search: bool | None = dc_field( + search: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="search") ) - shared_locations: bool | None = dc_field( + shared_locations: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shared_locations") ) - skip_last_msg_update_for_system_msgs: bool | None = dc_field( + 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: bool | None = dc_field( + typing_events: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="typing_events") ) - uploads: bool | None = dc_field( + uploads: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="uploads") ) - url_enrichment: bool | None = dc_field( + url_enrichment: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_enrichment") ) - user_message_reminders: bool | None = dc_field( + user_message_reminders: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="user_message_reminders") ) - allowed_flag_reasons: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # List of commands that channel supports - commands: list[str] | None = dc_field( + commands: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="commands") ) - permissions: "list[PolicyRequest] | None" = dc_field( + permissions: "Optional[List[PolicyRequest]]" = dc_field( default=None, metadata=dc_config(field_name="permissions") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @dataclass class UpdateChannelTypeResponse(DataClassJsonMixin): - automod: str = dc_field(metadata=dc_config(field_name="automod")) - automod_behavior: str = dc_field(metadata=dc_config(field_name="automod_behavior")) + # 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( @@ -28726,6 +32980,7 @@ class UpdateChannelTypeResponse(DataClassJsonMixin): ) 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") @@ -28766,37 +33021,39 @@ class UpdateChannelTypeResponse(DataClassJsonMixin): 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( + 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: str | None = dc_field( + 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") ) - blocklist_behavior: str | None = dc_field( + # 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: int | None = dc_field( + partition_size: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="partition_size") ) - partition_ttl: str | None = dc_field( + partition_ttl: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="partition_ttl") ) - push_level: str | None = dc_field( + # 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: list[str] | None = dc_field( + allowed_flag_reasons: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_flag_reasons") ) - blocklists: "list[BlockListOptions] | None" = dc_field( + blocklists: "Optional[List[BlockListOptions]]" = dc_field( default=None, metadata=dc_config(field_name="blocklists") ) # Sets thresholds for AI moderation - automod_thresholds: "Thresholds | None" = dc_field( + automod_thresholds: "Optional[Thresholds]" = dc_field( default=None, metadata=dc_config(field_name="automod_thresholds") ) - chat_preferences: "ChatPreferences | None" = dc_field( + chat_preferences: "Optional[ChatPreferences]" = dc_field( default=None, metadata=dc_config(field_name="chat_preferences") ) @@ -28808,20 +33065,20 @@ class UpdateCollectionRequest(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")) + 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( + collections: "List[UpdateCollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28830,7 +33087,7 @@ class UpdateCollectionsRequest(DataClassJsonMixin): class UpdateCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of updated collections - collections: "list[CollectionResponse]" = dc_field( + collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @@ -28840,16 +33097,16 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="args")) + args: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="args")) # Set name used for grouping commands - set: str | None = dc_field(default=None, metadata=dc_config(field_name="set")) + 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: "Command | None" = dc_field( + command: "Optional[Command]" = dc_field( default=None, metadata=dc_config(field_name="command") ) @@ -28857,25 +33114,25 @@ class UpdateCommandResponse(DataClassJsonMixin): @dataclass class UpdateCommentBookmarkRequest(DataClassJsonMixin): # ID of the folder containing the bookmark - folder_id: str | None = dc_field( + 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: str | None = dc_field( + new_folder_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="new_folder_id") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Custom data for the bookmark - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - new_folder: "AddFolderRequest | None" = dc_field( + new_folder: "Optional[AddFolderRequest]" = dc_field( default=None, metadata=dc_config(field_name="new_folder") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28890,38 +33147,38 @@ class UpdateCommentBookmarkResponse(DataClassJsonMixin): 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: bool | None = dc_field( + 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: bool | None = dc_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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) # Whether to skip push notifications - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + 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: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28935,46 +33192,46 @@ class UpdateCommentPartialResponse(DataClassJsonMixin): @dataclass class UpdateCommentRequest(DataClassJsonMixin): # Updated text content of the comment - comment: str | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_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: bool | None = dc_field( + 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + 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: "list[Attachment] | None" = dc_field( + 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: list[str] | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -28991,17 +33248,17 @@ class UpdateExternalStorageRequest(DataClassJsonMixin): 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: str | None = dc_field( + gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) # The path prefix to use for storing files - path: str | None = dc_field(default=None, metadata=dc_config(field_name="path")) + path: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="path")) # Config for creating Amazon S3 storage. - aws_s3: "S3Request | None" = dc_field( + aws_s3: "Optional[S3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) # Config for creating Azure Blob Storage storage - azure_blob: "AzureRequest | None" = dc_field( + azure_blob: "Optional[AzureRequest]" = dc_field( default=None, metadata=dc_config(field_name="azure_blob") ) @@ -29019,47 +33276,47 @@ class UpdateExternalStorageResponse(DataClassJsonMixin): @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: str | None = dc_field( + 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: str | None = dc_field( + default_visibility: "Optional[FeedVisibility]" = dc_field( default=None, metadata=dc_config(field_name="default_visibility") ) # Configuration for activity processors - activity_processors: "list[ActivityProcessorConfig] | None" = dc_field( + activity_processors: "Optional[List[ActivityProcessorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_processors") ) # Configuration for activity selectors - activity_selectors: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - activity_filter: "ActivityFilterConfig | None" = dc_field( + activity_filter: "Optional[ActivityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_filter") ) - activity_marks: "ActivityMarksConfig | None" = dc_field( + activity_marks: "Optional[ActivityMarksConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_marks") ) - activity_processing: "ActivityProcessingConfig | None" = dc_field( + activity_processing: "Optional[ActivityProcessingConfig]" = dc_field( default=None, metadata=dc_config(field_name="activity_processing") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) # Custom data for the feed group - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - notification: "NotificationConfig | None" = dc_field( + notification: "Optional[NotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="notification") ) - push_notification: "PushNotificationConfig | None" = dc_field( + push_notification: "Optional[PushNotificationConfig]" = dc_field( default=None, metadata=dc_config(field_name="push_notification") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) - stories: "StoriesConfig | None" = dc_field( + stories: "Optional[StoriesConfig]" = dc_field( default=None, metadata=dc_config(field_name="stories") ) @@ -29076,11 +33333,13 @@ class UpdateFeedGroupResponse(DataClassJsonMixin): 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: int | None = dc_field(default=None, metadata=dc_config(field_name="limit")) - next: str | None = dc_field(default=None, metadata=dc_config(field_name="next")) - prev: str | None = dc_field(default=None, metadata=dc_config(field_name="prev")) + 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: "list[FeedMemberRequest] | None" = dc_field( + members: "Optional[List[FeedMemberRequest]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @@ -29089,9 +33348,9 @@ class UpdateFeedMembersRequest(DataClassJsonMixin): 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( + 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") ) @@ -29099,32 +33358,32 @@ class UpdateFeedMembersResponse(DataClassJsonMixin): @dataclass class UpdateFeedRequest(DataClassJsonMixin): # If true, removes the geographic location from the feed - clear_location: bool | None = dc_field( + 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: str | None = dc_field( + created_by_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by_id") ) # Description of the feed - description: str | None = dc_field( + 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: bool | None = dc_field( + enrich_own_fields: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enrich_own_fields") ) # Name of the feed - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Tags used for filtering feeds - filter_tags: list[str] | None = dc_field( + filter_tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="filter_tags") ) # Custom data for the feed - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - location: "Location | None" = dc_field( + location: "Optional[Location]" = dc_field( default=None, metadata=dc_config(field_name="location") ) @@ -29138,13 +33397,13 @@ class UpdateFeedResponse(DataClassJsonMixin): @dataclass class UpdateFeedViewRequest(DataClassJsonMixin): # Updated configuration for selecting activities - activity_selectors: "list[ActivitySelectorConfig] | None" = dc_field( + activity_selectors: "Optional[List[ActivitySelectorConfig]]" = dc_field( default=None, metadata=dc_config(field_name="activity_selectors") ) - aggregation: "AggregationConfig | None" = dc_field( + aggregation: "Optional[AggregationConfig]" = dc_field( default=None, metadata=dc_config(field_name="aggregation") ) - ranking: "RankingConfig | None" = dc_field( + ranking: "Optional[RankingConfig]" = dc_field( default=None, metadata=dc_config(field_name="ranking") ) @@ -29158,7 +33417,7 @@ class UpdateFeedViewResponse(DataClassJsonMixin): @dataclass class UpdateFeedVisibilityRequest(DataClassJsonMixin): # Updated permission grants for each role - grants: "dict[str, list[str]] | None" = dc_field( + grants: "Optional[Dict[str, List[str]]]" = dc_field( default=None, metadata=dc_config(field_name="grants") ) @@ -29178,42 +33437,44 @@ class UpdateFollowRequest(DataClassJsonMixin): # 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: int | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field( + follower_role: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="follower_role") ) # Push preference for the follow relationship - push_preference: str | None = dc_field( + push_preference: "Optional[FollowPushPreference]" = dc_field( default=None, metadata=dc_config(field_name="push_preference") ) # Whether to skip push for this follow - skip_push: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="status")) + status: "Optional[FollowStatus]" = dc_field( + default=None, metadata=dc_config(field_name="status") + ) # Custom data for the follow relationship - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -29229,7 +33490,7 @@ 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: datetime | None = dc_field( + end_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="end_at", @@ -29239,21 +33500,21 @@ class UpdateLiveLocationRequest(DataClassJsonMixin): ), ) # Latitude coordinate - latitude: float | None = dc_field( + latitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="latitude") ) # Longitude coordinate - longitude: float | None = dc_field( + longitude: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="longitude") ) @dataclass class UpdateMemberPartialRequest(DataClassJsonMixin): - unset: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @@ -29262,7 +33523,7 @@ class UpdateMemberPartialRequest(DataClassJsonMixin): class UpdateMemberPartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - channel_member: "ChannelMemberResponse | None" = dc_field( + channel_member: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel_member") ) @@ -29270,21 +33531,21 @@ class UpdateMemberPartialResponse(DataClassJsonMixin): @dataclass class UpdateMembershipLevelRequest(DataClassJsonMixin): # Optional description of the membership level - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Display name for the membership level - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Priority level (higher numbers = higher priority) - priority: int | None = dc_field( + priority: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="priority") ) # Activity tags this membership level gives access to - tags: list[str] | None = dc_field( + tags: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="tags") ) # Custom data for the membership level - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -29300,25 +33561,25 @@ class UpdateMembershipLevelResponse(DataClassJsonMixin): @dataclass class UpdateMessagePartialRequest(DataClassJsonMixin): # Skip enriching the URL in the message - skip_enrich_url: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of field names to unset - unset: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29328,11 +33589,11 @@ class UpdateMessagePartialResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) # Pending message metadata - pending_message_metadata: "dict[str, str] | None" = dc_field( + pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @@ -29342,10 +33603,10 @@ 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: bool | None = dc_field( + skip_enrich_url: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_enrich_url") ) - skip_push: bool | None = dc_field( + skip_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="skip_push") ) @@ -29356,7 +33617,7 @@ class UpdateMessageResponse(DataClassJsonMixin): 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: "dict[str, str] | None" = dc_field( + pending_message_metadata: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="pending_message_metadata") ) @@ -29367,34 +33628,50 @@ class UpdatePollOptionRequest(DataClassJsonMixin): id: str = dc_field(metadata=dc_config(field_name="id")) # Option text text: str = dc_field(metadata=dc_config(field_name="text")) - user_id: str | None = dc_field( + # 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdatePollPartialRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + # 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: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29406,46 +33683,54 @@ class UpdatePollRequest(DataClassJsonMixin): # Poll name name: str = dc_field(metadata=dc_config(field_name="name")) # Allow answers - allow_answers: bool | None = dc_field( + allow_answers: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="allow_answers") ) # Allow user suggested options - allow_user_suggested_options: bool | None = dc_field( + 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: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Enforce unique vote - enforce_unique_vote: bool | None = dc_field( + enforce_unique_vote: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enforce_unique_vote") ) # Is closed - is_closed: bool | None = dc_field( + is_closed: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="is_closed") ) # Max votes allowed - max_votes_allowed: int | None = dc_field( + max_votes_allowed: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="max_votes_allowed") ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Voting visibility - voting_visibility: str | None = dc_field( + voting_visibility: "Optional[VotingVisibility]" = dc_field( default=None, metadata=dc_config(field_name="voting_visibility") ) # Poll options - options: "list[PollOptionRequest] | None" = dc_field( + options: "Optional[List[PollOptionRequest]]" = dc_field( default=None, metadata=dc_config(field_name="options") ) # Custom data for this object - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29455,12 +33740,12 @@ 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")) + filter: Dict[str, object] = dc_field(metadata=dc_config(field_name="filter")) # The description of the predefined filter - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - sort: "list[dict[str, object]] | None" = dc_field( + sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) @@ -29469,35 +33754,44 @@ class UpdatePredefinedFilterRequest(DataClassJsonMixin): class UpdatePredefinedFilterResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - predefined_filter: "PredefinedFilterResponse | None" = dc_field( + predefined_filter: "Optional[PredefinedFilterResponse]" = dc_field( default=None, metadata=dc_config(field_name="predefined_filter") ) @dataclass class UpdateQueueRequest(DataClassJsonMixin): - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - user_id: str | None = dc_field( + 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: "list[dict[str, object]] | None" = dc_field( + sort: "Optional[List[Dict[str, object]]]" = dc_field( default=None, metadata=dc_config(field_name="sort") ) - filters: dict[str, object] | None = dc_field( + filters: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filters") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class UpdateReminderRequest(DataClassJsonMixin): - remind_at: datetime | None = dc_field( + 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", @@ -29506,11 +33800,11 @@ class UpdateReminderRequest(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29529,33 +33823,33 @@ 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")) + 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: list[str] | None = dc_field( + called_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="called_numbers") ) # List of caller numbers (optional) - caller_numbers: list[str] | None = dc_field( + caller_numbers: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="caller_numbers") ) # Configuration for SIP call settings - call_configs: "SIPCallConfigsRequest | None" = dc_field( + call_configs: "Optional[SIPCallConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="call_configs") ) # Configuration for direct routing rule calls - direct_routing_configs: "SIPDirectRoutingRuleCallConfigsRequest | None" = dc_field( - default=None, metadata=dc_config(field_name="direct_routing_configs") + 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: "SIPPinProtectionConfigsRequest | None" = dc_field( + 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: "SIPInboundRoutingRulePinConfigsRequest | None" = dc_field( + pin_routing_configs: "Optional[SIPInboundRoutingRulePinConfigsRequest]" = dc_field( default=None, metadata=dc_config(field_name="pin_routing_configs") ) @@ -29564,7 +33858,7 @@ class UpdateSIPInboundRoutingRuleRequest(DataClassJsonMixin): class UpdateSIPInboundRoutingRuleResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP Inbound Routing Rule response - sip_inbound_routing_rule: "SIPInboundRoutingRuleResponse | None" = dc_field( + sip_inbound_routing_rule: "Optional[SIPInboundRoutingRuleResponse]" = dc_field( default=None, metadata=dc_config(field_name="sip_inbound_routing_rule") ) @@ -29574,13 +33868,13 @@ 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")) + numbers: List[str] = dc_field(metadata=dc_config(field_name="numbers")) # Optional password for SIP trunk authentication - password: str | None = dc_field( + 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: list[str] | None = dc_field( + allowed_ips: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="allowed_ips") ) @@ -29589,21 +33883,49 @@ class UpdateSIPTrunkRequest(DataClassJsonMixin): class UpdateSIPTrunkResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # SIP trunk information - sip_trunk: "SIPTrunkResponse | None" = dc_field( + 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: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The name of the segment (max 128 characters) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Filter to apply to the query - filter: dict[str, object] | None = dc_field( + filter: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="filter") ) @@ -29617,19 +33939,19 @@ class UpdateSegmentResponse(DataClassJsonMixin): @dataclass class UpdateThreadPartialRequest(DataClassJsonMixin): - user_id: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Array of field names to unset - unset: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) # Sets new field values - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29644,12 +33966,12 @@ class UpdateThreadPartialResponse(DataClassJsonMixin): @dataclass class UpdateUserGroupRequest(DataClassJsonMixin): # The new description for the group - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # The new name of the user group - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - team_id: str | None = dc_field( + 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") ) @@ -29657,7 +33979,7 @@ class UpdateUserGroupRequest(DataClassJsonMixin): @dataclass class UpdateUserGroupResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - user_group: "UserGroupResponse | None" = dc_field( + user_group: "Optional[UserGroupResponse]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -29666,10 +33988,10 @@ class UpdateUserGroupResponse(DataClassJsonMixin): class UpdateUserPartialRequest(DataClassJsonMixin): # User ID to update id: str = dc_field(metadata=dc_config(field_name="id")) - unset: list[str] | None = dc_field( + unset: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="unset") ) - set: dict[str, object] | None = dc_field( + set: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="set") ) @@ -29677,10 +33999,10 @@ class UpdateUserPartialRequest(DataClassJsonMixin): @dataclass class UpdateUserPermissionsRequest(DataClassJsonMixin): user_id: str = dc_field(metadata=dc_config(field_name="user_id")) - grant_permissions: list[str] | None = dc_field( + grant_permissions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="grant_permissions") ) - revoke_permissions: list[str] | None = dc_field( + revoke_permissions: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="revoke_permissions") ) @@ -29693,7 +34015,7 @@ class UpdateUserPermissionsResponse(DataClassJsonMixin): @dataclass class UpdateUsersPartialRequest(DataClassJsonMixin): - users: "list[UpdateUserPartialRequest]" = dc_field( + users: "List[UpdateUserPartialRequest]" = dc_field( metadata=dc_config(field_name="users") ) @@ -29701,20 +34023,20 @@ class UpdateUsersPartialRequest(DataClassJsonMixin): @dataclass class UpdateUsersRequest(DataClassJsonMixin): # Object containing users - users: "dict[str, UserRequest]" = dc_field(metadata=dc_config(field_name="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: 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( + users: "Dict[str, FullUserResponse]" = dc_field( metadata=dc_config(field_name="users") ) @@ -29731,7 +34053,7 @@ class UpdatedCallPermissionsEvent(DataClassJsonMixin): ) ) # The capabilities of the current user - own_capabilities: "list[OwnCapability]" = dc_field( + own_capabilities: "List[OwnCapability]" = dc_field( metadata=dc_config(field_name="own_capabilities") ) # User response object @@ -29745,8 +34067,8 @@ class UpdatedCallPermissionsEvent(DataClassJsonMixin): @dataclass class UploadChannelFileRequest(DataClassJsonMixin): # file field - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) - user: "OnlyUserID | None" = dc_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") ) @@ -29756,24 +34078,24 @@ 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: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) - moderation_action: str | None = dc_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: str | None = dc_field( + thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) @dataclass class UploadChannelRequest(DataClassJsonMixin): - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) + file: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="file")) # field with JSON-encoded array of image size configurations - upload_sizes: "list[ImageSize] | None" = dc_field( + upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) - user: "OnlyUserID | None" = dc_field( + user: "Optional[OnlyUserID]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29782,15 +34104,15 @@ class UploadChannelRequest(DataClassJsonMixin): class UploadChannelResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - file: str | None = dc_field(default=None, metadata=dc_config(field_name="file")) - moderation_action: str | None = dc_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") ) - thumb_url: str | None = dc_field( + thumb_url: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="thumb_url") ) # Array of image size configurations - upload_sizes: "list[ImageSize] | None" = dc_field( + upload_sizes: "Optional[List[ImageSize]]" = dc_field( default=None, metadata=dc_config(field_name="upload_sizes") ) @@ -29800,15 +34122,15 @@ 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: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - icon: str | None = dc_field(default=None, metadata=dc_config(field_name="icon")) - id: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) - queue_type: str | None = dc_field( + 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: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -29822,27 +34144,27 @@ class UpsertActionConfigRequest(DataClassJsonMixin): # 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: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Icon identifier for the dashboard button - icon: str | None = dc_field(default=None, metadata=dc_config(field_name="icon")) + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="id")) + 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: str | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Action-specific parameters passed to the action handler - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -29851,7 +34173,7 @@ class UpsertActionConfigRequest(DataClassJsonMixin): class UpsertActionConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # Configuration for a moderation action - action_config: "ModerationActionConfigResponse | None" = dc_field( + action_config: "Optional[ModerationActionConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="action_config") ) @@ -29859,40 +34181,48 @@ class UpsertActionConfigResponse(DataClassJsonMixin): @dataclass class UpsertActivitiesRequest(DataClassJsonMixin): # List of activities to create or update - activities: "list[ActivityRequest]" = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_field( + 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: bool | None = dc_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( + 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: int | None = dc_field( + 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( + collections: "List[CollectionRequest]" = dc_field( metadata=dc_config(field_name="collections") ) @@ -29901,7 +34231,7 @@ class UpsertCollectionsRequest(DataClassJsonMixin): class UpsertCollectionsResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) # List of upserted collections - collections: "list[CollectionResponse]" = dc_field( + collections: "List[CollectionResponse]" = dc_field( metadata=dc_config(field_name="collections") ) @@ -29911,64 +34241,75 @@ 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: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) + _async: Optional[bool] = dc_field( + default=None, metadata=dc_config(field_name="async") + ) # Team associated with the configuration - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - ai_audio_config: "AIAudioConfigRequest | None" = dc_field( + ai_audio_config: "Optional[AIAudioConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="ai_audio_config") ) - ai_image_config: "AIImageConfig | None" = dc_field( + ai_image_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_image_config") ) - ai_text_config: "AITextConfig | None" = dc_field( + ai_text_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="ai_text_config") ) - ai_video_config: "AIVideoConfigRequest | None" = dc_field( + ai_video_config: "Optional[AIVideoConfigRequest]" = dc_field( default=None, metadata=dc_config(field_name="ai_video_config") ) - automod_platform_circumvention_config: "AutomodPlatformCircumventionConfig | None" = dc_field( + automod_platform_circumvention_config: "Optional[AutomodPlatformCircumventionConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_platform_circumvention_config"), ) - automod_semantic_filters_config: "AutomodSemanticFiltersConfig | None" = dc_field( - default=None, metadata=dc_config(field_name="automod_semantic_filters_config") + automod_semantic_filters_config: "Optional[AutomodSemanticFiltersConfig]" = ( + dc_field( + default=None, + metadata=dc_config(field_name="automod_semantic_filters_config"), + ) ) - automod_toxicity_config: "AutomodToxicityConfig | None" = dc_field( + automod_toxicity_config: "Optional[AutomodToxicityConfig]" = dc_field( default=None, metadata=dc_config(field_name="automod_toxicity_config") ) - aws_rekognition_config: "AIImageConfig | None" = dc_field( + aws_rekognition_config: "Optional[AIImageConfig]" = dc_field( default=None, metadata=dc_config(field_name="aws_rekognition_config") ) - block_list_config: "BlockListConfig | None" = dc_field( + block_list_config: "Optional[BlockListConfig]" = dc_field( default=None, metadata=dc_config(field_name="block_list_config") ) - bodyguard_config: "AITextConfig | None" = dc_field( + bodyguard_config: "Optional[AITextConfig]" = dc_field( default=None, metadata=dc_config(field_name="bodyguard_config") ) - flood_config: "FloodConfig | None" = dc_field( + 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: "GoogleVisionConfig | None" = dc_field( + google_vision_config: "Optional[GoogleVisionConfig]" = dc_field( default=None, metadata=dc_config(field_name="google_vision_config") ) - llm_config: "LLMConfig | None" = dc_field( + 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: "RuleBuilderConfig | None" = dc_field( + rule_builder_config: "Optional[RuleBuilderConfig]" = dc_field( default=None, metadata=dc_config(field_name="rule_builder_config") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - velocity_filter_config: "VelocityFilterConfig | None" = dc_field( + velocity_filter_config: "Optional[VelocityFilterConfig]" = dc_field( default=None, metadata=dc_config(field_name="velocity_filter_config") ) - video_call_rule_config: "VideoCallRuleConfig | None" = dc_field( + video_call_rule_config: "Optional[VideoCallRuleConfig]" = dc_field( default=None, metadata=dc_config(field_name="video_call_rule_config") ) @@ -29976,7 +34317,7 @@ class UpsertConfigRequest(DataClassJsonMixin): @dataclass class UpsertConfigResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - config: "ConfigResponse | None" = dc_field( + config: "Optional[ConfigResponse]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @@ -29986,7 +34327,7 @@ 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: str | None = dc_field( + path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @@ -29995,7 +34336,7 @@ class UpsertExternalStorageAWSS3Request(DataClassJsonMixin): 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: str | None = dc_field( + path_prefix: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="path_prefix") ) @@ -30003,10 +34344,10 @@ class UpsertExternalStorageGCSRequest(DataClassJsonMixin): @dataclass class UpsertExternalStorageRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) - aws_s3: "UpsertExternalStorageAWSS3Request | None" = dc_field( + aws_s3: "Optional[UpsertExternalStorageAWSS3Request]" = dc_field( default=None, metadata=dc_config(field_name="aws_s3") ) - gcs: "UpsertExternalStorageGCSRequest | None" = dc_field( + gcs: "Optional[UpsertExternalStorageGCSRequest]" = dc_field( default=None, metadata=dc_config(field_name="gcs") ) @@ -30024,46 +34365,48 @@ class UpsertModerationRuleRequest(DataClassJsonMixin): # 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: str | None = dc_field( + cooldown_period: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cooldown_period") ) # Optional description of the rule - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) # Whether the rule is active - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) # Logical operator between conditions/groups: AND or OR - logic: str | None = dc_field(default=None, metadata=dc_config(field_name="logic")) + logic: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="logic") + ) # Team scope for the rule - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) # Escalation sequences for call rules - action_sequences: "list[CallRuleActionSequence] | None" = dc_field( + action_sequences: "Optional[List[CallRuleActionSequence]]" = dc_field( default=None, metadata=dc_config(field_name="action_sequences") ) # Flat list of conditions (legacy) - conditions: "list[RuleBuilderCondition] | None" = dc_field( + conditions: "Optional[List[RuleBuilderCondition]]" = dc_field( default=None, metadata=dc_config(field_name="conditions") ) # List of config keys this rule applies to - config_keys: list[str] | None = dc_field( + config_keys: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="config_keys") ) # Nested condition groups - groups: "list[RuleBuilderConditionGroup] | None" = dc_field( + groups: "Optional[List[RuleBuilderConditionGroup]]" = dc_field( default=None, metadata=dc_config(field_name="groups") ) - action: "RuleBuilderAction | None" = dc_field( + action: "Optional[RuleBuilderAction]" = dc_field( default=None, metadata=dc_config(field_name="action") ) # User request object - user: "UserRequest | None" = dc_field( + user: "Optional[UserRequest]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -30072,7 +34415,7 @@ class UpsertModerationRuleRequest(DataClassJsonMixin): class UpsertModerationRuleResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - rule: "ModerationRuleV2Response | None" = dc_field( + rule: "Optional[ModerationRuleV2Response]" = dc_field( default=None, metadata=dc_config(field_name="rule") ) @@ -30111,7 +34454,7 @@ class UpsertModerationTemplateResponse(DataClassJsonMixin): ) ) # Configuration for a feeds moderation template - config: "FeedsModerationTemplateConfigPayload | None" = dc_field( + config: "Optional[FeedsModerationTemplateConfigPayload]" = dc_field( default=None, metadata=dc_config(field_name="config") ) @@ -30119,7 +34462,7 @@ class UpsertModerationTemplateResponse(DataClassJsonMixin): @dataclass class UpsertPushPreferencesRequest(DataClassJsonMixin): # A list of push preferences for channels, calls, or the user. - preferences: "list[PushPreferenceInput]" = dc_field( + preferences: "List[PushPreferenceInput]" = dc_field( metadata=dc_config(field_name="preferences") ) @@ -30129,18 +34472,18 @@ 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]]" = ( + 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( + user_preferences: "Dict[str, PushPreferencesResponse]" = dc_field( metadata=dc_config(field_name="user_preferences") ) @dataclass class UpsertPushProviderRequest(DataClassJsonMixin): - push_provider: "PushProviderRequest | None" = dc_field( + push_provider: "Optional[PushProviderRequest]" = dc_field( default=None, metadata=dc_config(field_name="push_provider") ) @@ -30159,19 +34502,19 @@ 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: str = dc_field( + push_provider_type: "PushProviderName" = dc_field( metadata=dc_config(field_name="push_provider_type") ) # Whether to send push notification for this event - enable_push: bool | None = dc_field( + enable_push: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enable_push") ) # Push provider name - push_provider_name: str | None = dc_field( + push_provider_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="push_provider_name") ) # Push template - template: str | None = dc_field( + template: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="template") ) @@ -30180,7 +34523,7 @@ class UpsertPushTemplateRequest(DataClassJsonMixin): class UpsertPushTemplateResponse(DataClassJsonMixin): # Duration of the request in milliseconds duration: str = dc_field(metadata=dc_config(field_name="duration")) - template: "PushTemplateResponse | None" = dc_field( + template: "Optional[PushTemplateResponse]" = dc_field( default=None, metadata=dc_config(field_name="template") ) @@ -30188,11 +34531,11 @@ class UpsertPushTemplateResponse(DataClassJsonMixin): @dataclass class UpsertSetupSessionRequest(DataClassJsonMixin): # The current step of the setup wizard. One of: welcome, input, configure, live - current_step: str = dc_field(metadata=dc_config(field_name="current_step")) + current_step: "SetupStep" = dc_field(metadata=dc_config(field_name="current_step")) # The status of the setup session. One of: in_progress, completed - status: str = dc_field(metadata=dc_config(field_name="status")) + status: "SetupStatus" = dc_field(metadata=dc_config(field_name="status")) # Per-step data keyed by step name (welcome, input, configure, live) - setup_data: dict[str, object] | None = dc_field( + setup_data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="setup_data") ) @@ -30200,15 +34543,32 @@ class UpsertSetupSessionRequest(DataClassJsonMixin): @dataclass class UpsertSetupSessionResponse(DataClassJsonMixin): duration: str = dc_field(metadata=dc_config(field_name="duration")) - setup_session: "SetupSession | None" = dc_field( + 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: dict[str, object] | None = dc_field( + data: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="data") ) @@ -30224,28 +34584,32 @@ class UserBannedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_member_count: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # The expiration date of the ban - expiration: datetime | None = dc_field( + expiration: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expiration", @@ -30255,8 +34619,10 @@ class UserBannedEvent(DataClassJsonMixin): ), ) # The reason for the ban - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - received_at: datetime | None = dc_field( + 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", @@ -30266,29 +34632,81 @@ class UserBannedEvent(DataClassJsonMixin): ), ) # 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: str | None = dc_field( + 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: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - total_bans: int | None = dc_field( + 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: dict[str, object] | None = dc_field( + channel_custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="channel_custom") ) - created_by: "UserResponseCommonFields | None" = dc_field( + 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: str | None = dc_field( + max_age: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="max_age") ) @@ -30296,17 +34714,17 @@ class UserCreatedWithinParameters(DataClassJsonMixin): @dataclass class UserCustomEventRequest(DataClassJsonMixin): type: str = dc_field(metadata=dc_config(field_name="type")) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @dataclass class UserCustomPropertyParameters(DataClassJsonMixin): - operator: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - property_key: str | None = dc_field( + property_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="property_key") ) @@ -30322,13 +34740,13 @@ class UserDeactivatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30337,7 +34755,7 @@ class UserDeactivatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_by: "UserResponseCommonFields | None" = dc_field( + created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @@ -30371,11 +34789,11 @@ class UserDeletedEvent(DataClassJsonMixin): 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30389,14 +34807,14 @@ class UserDeletedEvent(DataClassJsonMixin): @dataclass class UserFeedbackReport(DataClassJsonMixin): unreported_count: int = dc_field(metadata=dc_config(field_name="unreported_count")) - count_by_rating: "dict[str, int]" = dc_field( + 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( + daily: "List[DailyAggregateUserFeedbackReportResponse]" = dc_field( metadata=dc_config(field_name="daily") ) @@ -30413,7 +34831,7 @@ class UserFeedbackResponse(DataClassJsonMixin): platform: "PlatformDataResponse" = dc_field( metadata=dc_config(field_name="platform") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -30436,7 +34854,7 @@ class UserFlaggedEvent(DataClassJsonMixin): 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30446,10 +34864,10 @@ class UserFlaggedEvent(DataClassJsonMixin): ), ) # Custom data - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - target_user: "UserResponseCommonFields | None" = dc_field( + target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @@ -30475,16 +34893,16 @@ class UserGroup(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - created_by: str | None = dc_field( + created_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - team_id: str | None = dc_field( + team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) - members: "list[UserGroupMember] | None" = dc_field( + members: "Optional[List[UserGroupMember]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @@ -30500,12 +34918,12 @@ class UserGroupCreatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30514,10 +34932,10 @@ class UserGroupCreatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - user_group: "UserGroup | None" = dc_field( + user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -30533,12 +34951,12 @@ class UserGroupDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30547,10 +34965,10 @@ class UserGroupDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - user_group: "UserGroup | None" = dc_field( + user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -30583,13 +35001,13 @@ class UserGroupMemberAddedEvent(DataClassJsonMixin): ) ) # 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30598,10 +35016,10 @@ class UserGroupMemberAddedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - user_group: "UserGroup | None" = dc_field( + user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -30618,13 +35036,13 @@ class UserGroupMemberRemovedEvent(DataClassJsonMixin): ) ) # 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30633,10 +35051,10 @@ class UserGroupMemberRemovedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - user_group: "UserGroup | None" = dc_field( + user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @@ -30661,16 +35079,16 @@ class UserGroupResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - created_by: str | None = dc_field( + created_by: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - description: str | None = dc_field( + description: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="description") ) - team_id: str | None = dc_field( + team_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="team_id") ) - members: "list[UserGroupMember] | None" = dc_field( + members: "Optional[List[UserGroupMember]]" = dc_field( default=None, metadata=dc_config(field_name="members") ) @@ -30686,12 +35104,12 @@ class UserGroupUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30700,24 +35118,50 @@ class UserGroupUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - user: "UserResponseCommonFields | None" = dc_field( + user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="user") ) - user_group: "UserGroup | None" = dc_field( + user_group: "Optional[UserGroup]" = dc_field( default=None, metadata=dc_config(field_name="user_group") ) @dataclass class UserIdenticalContentCountParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + 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: str | None = dc_field( + 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 @@ -30729,33 +35173,33 @@ class UserMessagesDeletedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_member_count: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) + cid: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="cid")) # Whether Messages were hard deleted - hard_delete: bool | None = dc_field( + hard_delete: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="hard_delete") ) - received_at: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30765,8 +35209,8 @@ class UserMessagesDeletedEvent(DataClassJsonMixin): ), ) # The team of the channel where the target user's messages were deleted - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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") ) @@ -30789,7 +35233,7 @@ class UserMuteResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - expires: datetime | None = dc_field( + expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="expires", @@ -30799,11 +35243,11 @@ class UserMuteResponse(DataClassJsonMixin): ), ) # User response object - target: "UserResponse | None" = dc_field( + target: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="target") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @@ -30819,11 +35263,11 @@ class UserMutedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30833,10 +35277,10 @@ class UserMutedEvent(DataClassJsonMixin): ), ) # The target users that were muted - target_users: "list[UserResponseCommonFields] | None" = dc_field( + target_users: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="target_users") ) - target_user: "UserResponseCommonFields | None" = dc_field( + target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @@ -30849,10 +35293,13 @@ class UserRatingReportResponse(DataClassJsonMixin): @dataclass class UserReactionCountRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + 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: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) @@ -30868,13 +35315,13 @@ class UserReactivatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -30883,7 +35330,7 @@ class UserReactivatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - created_by: "UserResponseCommonFields | None" = dc_field( + created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @@ -30893,30 +35340,33 @@ class UserRequest(DataClassJsonMixin): # User ID id: str = dc_field(metadata=dc_config(field_name="id")) # User's profile image URL - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - invisible: bool | None = dc_field( + 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: str | None = dc_field( + language: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="language") ) # Optional name of user - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # User's global role - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) + role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) # List of teams the user belongs to - teams: list[str] | None = dc_field( + teams: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="teams") ) # Custom user data - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # 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: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -30954,18 +35404,18 @@ class UserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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")) + 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: int | None = dc_field( + 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: datetime | None = dc_field( + ban_expires: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="ban_expires", @@ -30974,11 +35424,11 @@ class UserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - bypass_moderation: bool | None = dc_field( + bypass_moderation: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="bypass_moderation") ) # Date of deactivation - deactivated_at: datetime | None = dc_field( + deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", @@ -30988,7 +35438,7 @@ class UserResponse(DataClassJsonMixin): ), ) # Date/time of deletion - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -30997,9 +35447,11 @@ class UserResponse(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) + image: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="image") + ) # Date of last activity - last_active: datetime | None = dc_field( + last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", @@ -31009,9 +35461,9 @@ class UserResponse(DataClassJsonMixin): ), ) # Optional name of user - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) + name: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="name")) # Revocation date for tokens - revoke_tokens_issued_before: datetime | None = dc_field( + revoke_tokens_issued_before: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="revoke_tokens_issued_before", @@ -31021,16 +35473,17 @@ class UserResponse(DataClassJsonMixin): ), ) # List of devices user is using - devices: "list[DeviceResponse] | None" = dc_field( + devices: "Optional[List[DeviceResponse]]" = dc_field( default=None, metadata=dc_config(field_name="devices") ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - push_notifications: "PushNotificationSettingsResponse | None" = dc_field( + push_notifications: "Optional[PushNotificationSettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="push_notifications") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -31058,15 +35511,15 @@ class UserResponseCommonFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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: int | None = dc_field( + 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: datetime | None = dc_field( + deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", @@ -31075,7 +35528,7 @@ class UserResponseCommonFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -31084,8 +35537,10 @@ class UserResponseCommonFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - last_active: datetime | None = dc_field( + 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", @@ -31094,8 +35549,8 @@ class UserResponseCommonFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - revoke_tokens_issued_before: datetime | None = dc_field( + 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", @@ -31104,7 +35559,7 @@ class UserResponseCommonFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @@ -31132,15 +35587,15 @@ class UserResponsePrivacyFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - blocked_user_ids: list[str] = dc_field( + 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: int | None = dc_field( + 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: datetime | None = dc_field( + deactivated_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deactivated_at", @@ -31149,7 +35604,7 @@ class UserResponsePrivacyFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - deleted_at: datetime | None = dc_field( + deleted_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="deleted_at", @@ -31158,11 +35613,13 @@ class UserResponsePrivacyFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - image: str | None = dc_field(default=None, metadata=dc_config(field_name="image")) - invisible: bool | None = dc_field( + 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: datetime | None = dc_field( + last_active: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="last_active", @@ -31171,8 +35628,8 @@ class UserResponsePrivacyFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - name: str | None = dc_field(default=None, metadata=dc_config(field_name="name")) - revoke_tokens_issued_before: datetime | None = dc_field( + 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", @@ -31181,25 +35638,26 @@ class UserResponsePrivacyFields(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - privacy_settings: "PrivacySettingsResponse | None" = dc_field( + # The privacy settings of the user. + privacy_settings: "Optional[PrivacySettingsResponse]" = dc_field( default=None, metadata=dc_config(field_name="privacy_settings") ) - teams_role: "dict[str, str] | None" = dc_field( + teams_role: "Optional[Dict[str, str]]" = dc_field( default=None, metadata=dc_config(field_name="teams_role") ) @dataclass class UserRoleParameters(DataClassJsonMixin): - operator: str | None = dc_field( + operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="operator") ) - role: str | None = dc_field(default=None, metadata=dc_config(field_name="role")) + role: Optional[str] = dc_field(default=None, metadata=dc_config(field_name="role")) @dataclass class UserRuleParameters(DataClassJsonMixin): - max_age: str | None = dc_field( + max_age: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="max_age") ) @@ -31215,27 +35673,27 @@ class UserUnbannedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_member_count: int | None = dc_field( + channel_member_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="channel_member_count") ) - channel_message_count: int | None = dc_field( + 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: str | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - received_at: datetime | None = dc_field( + 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", @@ -31245,15 +35703,15 @@ class UserUnbannedEvent(DataClassJsonMixin): ), ) # Whether the target user was shadow unbanned - shadow: bool | None = dc_field( + 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: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - channel_custom: dict[str, object] | None = dc_field( + 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: "UserResponseCommonFields | None" = dc_field( + created_by: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) @@ -31269,11 +35727,11 @@ class UserUnmutedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -31283,10 +35741,10 @@ class UserUnmutedEvent(DataClassJsonMixin): ), ) # The target users that were unmuted - target_users: "list[UserResponseCommonFields] | None" = dc_field( + target_users: "Optional[List[UserResponseCommonFields]]" = dc_field( default=None, metadata=dc_config(field_name="target_users") ) - target_user: "UserResponseCommonFields | None" = dc_field( + target_user: "Optional[UserResponseCommonFields]" = dc_field( default=None, metadata=dc_config(field_name="target_user") ) @@ -31303,16 +35761,16 @@ class UserUnreadReminderEvent(DataClassJsonMixin): ) ) # The channels with unread messages - channels: "dict[str, ChannelMessagesResponse | None]" = dc_field( + 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")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -31334,11 +35792,11 @@ class UserUpdatedEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ) ) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) + 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: datetime | None = dc_field( + received_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="received_at", @@ -31357,23 +35815,25 @@ class ValidateExternalStorageResponse(DataClassJsonMixin): @dataclass class VelocityFilterConfig(DataClassJsonMixin): - _async: bool | None = dc_field(default=None, metadata=dc_config(field_name="async")) - advanced_filters: bool | None = dc_field( + _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: bool | None = dc_field( + cascading_actions: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="cascading_actions") ) - cids_per_user: int | None = dc_field( + cids_per_user: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cids_per_user") ) - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - first_message_only: bool | None = dc_field( + first_message_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="first_message_only") ) - rules: "list[VelocityFilterConfigRule] | None" = dc_field( + rules: "Optional[List[VelocityFilterConfigRule]]" = dc_field( default=None, metadata=dc_config(field_name="rules") ) @@ -31381,83 +35841,81 @@ class VelocityFilterConfig(DataClassJsonMixin): @dataclass class VelocityFilterConfigRule(DataClassJsonMixin): action: str = dc_field(metadata=dc_config(field_name="action")) - ban_duration: int | None = dc_field( + ban_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="ban_duration") ) - cascading_action: str | None = dc_field( + cascading_action: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="cascading_action") ) - cascading_threshold: int | None = dc_field( + cascading_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="cascading_threshold") ) - check_message_context: bool | None = dc_field( + check_message_context: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="check_message_context") ) - fast_spam_threshold: int | None = dc_field( + fast_spam_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fast_spam_threshold") ) - fast_spam_ttl: int | None = dc_field( + fast_spam_ttl: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="fast_spam_ttl") ) - ip_ban: bool | None = dc_field( + ip_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="ip_ban") ) - probation_period: int | None = dc_field( + probation_period: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="probation_period") ) - shadow_ban: bool | None = dc_field( + shadow_ban: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="shadow_ban") ) - slow_spam_ban_duration: int | None = dc_field( + slow_spam_ban_duration: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_ban_duration") ) - slow_spam_threshold: int | None = dc_field( + slow_spam_threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_threshold") ) - slow_spam_ttl: int | None = dc_field( + slow_spam_ttl: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="slow_spam_ttl") ) - url_only: bool | None = dc_field( + url_only: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="url_only") ) @dataclass class VideoCallRuleConfig(DataClassJsonMixin): - flag_all_labels: bool | None = dc_field( + flag_all_labels: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="flag_all_labels") ) - flagged_labels: list[str] | None = dc_field( + flagged_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="flagged_labels") ) - rules: "list[HarmConfig] | None" = dc_field( + 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: str | None = dc_field( + label_operator: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="label_operator") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) -@dataclass -class VideoEndCallRequestPayload(DataClassJsonMixin): - pass - - -@dataclass -class VideoKickUserRequestPayload(DataClassJsonMixin): - pass - - @dataclass class VideoReactionOverTimeResponse(DataClassJsonMixin): - by_minute: "list[CountByMinuteResponse] | None" = dc_field( + by_minute: "Optional[List[CountByMinuteResponse]]" = dc_field( default=None, metadata=dc_config(field_name="by_minute") ) @@ -31467,10 +35925,10 @@ 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: str | None = dc_field( + emoji_code: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="emoji_code") ) - custom: dict[str, object] | None = dc_field( + custom: Optional[Dict[str, object]] = dc_field( default=None, metadata=dc_config(field_name="custom") ) @@ -31478,20 +35936,20 @@ class VideoReactionResponse(DataClassJsonMixin): @dataclass class VideoReactionsResponse(DataClassJsonMixin): reaction: str = dc_field(metadata=dc_config(field_name="reaction")) - count_over_time: "VideoReactionOverTimeResponse | None" = dc_field( + count_over_time: "Optional[VideoReactionOverTimeResponse]" = dc_field( default=None, metadata=dc_config(field_name="count_over_time") ) @dataclass class VideoRuleParameters(DataClassJsonMixin): - threshold: int | None = dc_field( + threshold: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="threshold") ) - time_window: str | None = dc_field( + time_window: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="time_window") ) - harm_labels: list[str] | None = dc_field( + harm_labels: Optional[List[str]] = dc_field( default=None, metadata=dc_config(field_name="harm_labels") ) @@ -31504,7 +35962,10 @@ class VideoSettings(DataClassJsonMixin): camera_default_on: bool = dc_field( metadata=dc_config(field_name="camera_default_on") ) - camera_facing: str = dc_field(metadata=dc_config(field_name="camera_facing")) + # 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") @@ -31513,19 +35974,20 @@ class VideoSettings(DataClassJsonMixin): @dataclass class VideoSettingsRequest(DataClassJsonMixin): - access_request_enabled: bool | None = dc_field( + access_request_enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="access_request_enabled") ) - camera_default_on: bool | None = dc_field( + camera_default_on: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="camera_default_on") ) - camera_facing: str | None = dc_field( + # Which camera a call opens with. + camera_facing: "Optional[CameraFacing]" = dc_field( default=None, metadata=dc_config(field_name="camera_facing") ) - enabled: bool | None = dc_field( + enabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="enabled") ) - target_resolution: "TargetResolution | None" = dc_field( + target_resolution: "Optional[TargetResolution]" = dc_field( default=None, metadata=dc_config(field_name="target_resolution") ) @@ -31538,7 +36000,10 @@ class VideoSettingsResponse(DataClassJsonMixin): camera_default_on: bool = dc_field( metadata=dc_config(field_name="camera_default_on") ) - camera_facing: str = dc_field(metadata=dc_config(field_name="camera_facing")) + # 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") @@ -31558,27 +36023,35 @@ class ViewerBehavior(DataClassJsonMixin): ) 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: float | None = dc_field( + bounce_rate_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="bounce_rate_pct") ) - connections_under_30s_pct: float | None = dc_field( + connections_under_30s_pct: Optional[float] = dc_field( default=None, metadata=dc_config(field_name="connections_under_30s_pct") ) - return_visit_rate_pct: float | None = dc_field( + 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: str | None = dc_field( + answer_text: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="answer_text") ) - option_id: str | None = dc_field( + 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")) @@ -31601,14 +36074,14 @@ class WSEvent(DataClassJsonMixin): ) ) type: str = dc_field(metadata=dc_config(field_name="type")) - custom: dict[str, object] = dc_field(metadata=dc_config(field_name="custom")) - automoderation: bool | None = dc_field( + 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: str | None = dc_field( + channel_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_id") ) - channel_last_message_at: datetime | None = dc_field( + channel_last_message_at: Optional[datetime] = dc_field( default=None, metadata=dc_config( field_name="channel_last_message_at", @@ -31617,140 +36090,153 @@ class WSEvent(DataClassJsonMixin): mm_field=fields.DateTime(format="iso"), ), ) - channel_type: str | None = dc_field( + channel_type: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="channel_type") ) - cid: str | None = dc_field(default=None, metadata=dc_config(field_name="cid")) - connection_id: str | None = dc_field( + 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: str | None = dc_field( + parent_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="parent_id") ) - reason: str | None = dc_field(default=None, metadata=dc_config(field_name="reason")) - team: str | None = dc_field(default=None, metadata=dc_config(field_name="team")) - thread_id: str | None = dc_field( + 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: str | None = dc_field( + user_id: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="user_id") ) - watcher_count: int | None = dc_field( + watcher_count: Optional[int] = dc_field( default=None, metadata=dc_config(field_name="watcher_count") ) - automoderation_scores: "ModerationResponse | None" = dc_field( + # Response from AI moderation + automoderation_scores: "Optional[ModerationResponse]" = dc_field( default=None, metadata=dc_config(field_name="automoderation_scores") ) # Represents channel in chat - channel: "ChannelResponse | None" = dc_field( + channel: "Optional[ChannelResponse]" = dc_field( default=None, metadata=dc_config(field_name="channel") ) # User response object - created_by: "UserResponse | None" = dc_field( + created_by: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="created_by") ) - me: "OwnUserResponse | None" = dc_field( + me: "Optional[OwnUserResponse]" = dc_field( default=None, metadata=dc_config(field_name="me") ) - member: "ChannelMemberResponse | None" = dc_field( + member: "Optional[ChannelMemberResponse]" = dc_field( default=None, metadata=dc_config(field_name="member") ) # Represents any chat message - message: "MessageResponse | None" = dc_field( + message: "Optional[MessageResponse]" = dc_field( default=None, metadata=dc_config(field_name="message") ) - message_update: "MessageUpdate | None" = dc_field( + message_update: "Optional[MessageUpdate]" = dc_field( default=None, metadata=dc_config(field_name="message_update") ) - poll: "PollResponseData | None" = dc_field( + poll: "Optional[PollResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll") ) - poll_vote: "PollVoteResponseData | None" = dc_field( + poll_vote: "Optional[PollVoteResponseData]" = dc_field( default=None, metadata=dc_config(field_name="poll_vote") ) - reaction: "ReactionResponse | None" = dc_field( + reaction: "Optional[ReactionResponse]" = dc_field( default=None, metadata=dc_config(field_name="reaction") ) - thread: "ThreadResponse | None" = dc_field( + thread: "Optional[ThreadResponse]" = dc_field( default=None, metadata=dc_config(field_name="thread") ) # User response object - user: "UserResponse | None" = dc_field( + user: "Optional[UserResponse]" = dc_field( default=None, metadata=dc_config(field_name="user") ) @dataclass class WebhookFailoverConfig(DataClassJsonMixin): - gcs_bucket: str | None = dc_field( + gcs_bucket: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_bucket") ) - gcs_credentials: str | None = dc_field( + gcs_credentials: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_credentials") ) - gcs_path: str | None = dc_field( + gcs_path: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="gcs_path") ) - s3_api_key: str | None = dc_field( + s3_api_key: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_api_key") ) - s3_bucket: str | None = dc_field( + s3_bucket: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_bucket") ) - s3_path: str | None = dc_field( + s3_path: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_path") ) - s3_region: str | None = dc_field( + s3_region: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_region") ) - s3_role_arn: str | None = dc_field( + s3_role_arn: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_role_arn") ) - s3_secret: str | None = dc_field( + s3_secret: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="s3_secret") ) - type: str | None = dc_field(default=None, metadata=dc_config(field_name="type")) + 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") ) - channel_type: "list[UnreadCountsChannelType]" = dc_field( + # The unread information per channel type. + channel_type: "List[UnreadCountsChannelType]" = dc_field( metadata=dc_config(field_name="channel_type") ) - channels: "list[UnreadCountsChannel]" = dc_field( + # The unread information per channel. + channels: "List[UnreadCountsChannel]" = dc_field( metadata=dc_config(field_name="channels") ) - threads: "list[UnreadCountsThread]" = dc_field( + # The unread information per thread. + threads: "List[UnreadCountsThread]" = dc_field( metadata=dc_config(field_name="threads") ) - total_unread_count_by_team: "dict[str, int] | None" = dc_field( + # 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: bool | None = dc_field( + disabled: Optional[bool] = dc_field( default=None, metadata=dc_config(field_name="Disabled") ) - package_name: str | None = dc_field( + package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="package_name") ) - secret: str | None = dc_field(default=None, metadata=dc_config(field_name="secret")) + 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: str | None = dc_field( + package_name: Optional[str] = dc_field( default=None, metadata=dc_config(field_name="package_name") ) - secret: str | None = dc_field(default=None, metadata=dc_config(field_name="secret")) + secret: Optional[str] = dc_field( + default=None, metadata=dc_config(field_name="secret") + ) diff --git a/getstream/moderation/async_rest_client.py b/getstream/moderation/async_rest_client.py index 7284b3b0..18cbd87b 100644 --- a/getstream/moderation/async_rest_client.py +++ b/getstream/moderation/async_rest_client.py @@ -41,11 +41,13 @@ async def get_action_config( user_id: Optional[str] = None, ) -> StreamResponse[GetActionConfigResponse]: query_params = build_query_param( - queue_type=queue_type, - entity_type=entity_type, - exclude_defaults=exclude_defaults, - only_defaults=only_defaults, - user_id=user_id, + **{ + "queue_type": queue_type, + "entity_type": entity_type, + "exclude_defaults": exclude_defaults, + "only_defaults": only_defaults, + "user_id": user_id, + } ) return await self.get( "/api/v2/moderation/action_config", @@ -119,7 +121,7 @@ async def bulk_delete_action_config( async def delete_action_config( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteActionConfigResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -162,10 +164,12 @@ async def analyze( async_response: Optional[bool] = None, config_key: Optional[str] = None, content_published_at: Optional[datetime] = None, + country_code: Optional[str] = None, entity_creator_id: Optional[str] = None, entity_id: Optional[str] = None, entity_type: Optional[str] = None, user_id: Optional[str] = None, + country_codes: Optional[List[str]] = None, content_ids: Optional[Dict[str, str]] = None, custom: Optional[Dict[str, object]] = None, texts: Optional[Dict[str, str]] = None, @@ -175,10 +179,12 @@ async def analyze( async_response=async_response, config_key=config_key, content_published_at=content_published_at, + country_code=country_code, entity_creator_id=entity_creator_id, entity_id=entity_id, entity_type=entity_type, user_id=user_id, + country_codes=country_codes, content_ids=content_ids, custom=custom, texts=texts, @@ -192,6 +198,7 @@ async def appeal( appeal_reason: str, entity_id: str, entity_type: str, + channel_cid: Optional[str] = None, review_queue_item_id: Optional[str] = None, user_id: Optional[str] = None, attachments: Optional[List[str]] = None, @@ -201,6 +208,7 @@ async def appeal( appeal_reason=appeal_reason, entity_id=entity_id, entity_type=entity_type, + channel_cid=channel_cid, review_queue_item_id=review_queue_item_id, user_id=user_id, attachments=attachments, @@ -275,9 +283,11 @@ async def bulk_action_appeals( async def ban( self, target_user_id: str, + ban_from_future_channels: Optional[bool] = None, banned_by_id: Optional[str] = None, channel_cid: Optional[str] = None, - delete_messages: Optional[str] = None, + delete_messages: Optional[DeleteMessages] = None, + delete_reactions: Optional[bool] = None, ip_ban: Optional[bool] = None, reason: Optional[str] = None, shadow: Optional[bool] = None, @@ -286,9 +296,11 @@ async def ban( ) -> StreamResponse[ModerationBanResponse]: json = BanRequest( target_user_id=target_user_id, + ban_from_future_channels=ban_from_future_channels, banned_by_id=banned_by_id, channel_cid=channel_cid, delete_messages=delete_messages, + delete_reactions=delete_reactions, ip_ban=ip_ban, reason=reason, shadow=shadow, @@ -326,8 +338,10 @@ async def check( config_key: Optional[str] = None, config_team: Optional[str] = None, content_published_at: Optional[datetime] = None, + country_code: Optional[str] = None, test_mode: Optional[bool] = None, user_id: Optional[str] = None, + country_codes: Optional[List[str]] = None, config: Optional[ModerationConfig] = None, moderation_payload: Optional[ModerationPayload] = None, options: Optional[Dict[str, object]] = None, @@ -340,8 +354,10 @@ async def check( config_key=config_key, config_team=config_team, content_published_at=content_published_at, + country_code=country_code, test_mode=test_mode, user_id=user_id, + country_codes=country_codes, config=config, moderation_payload=moderation_payload, options=options, @@ -377,8 +393,10 @@ async def upsert_config( aws_rekognition_config: Optional[AIImageConfig] = None, block_list_config: Optional[BlockListConfig] = None, bodyguard_config: Optional[AITextConfig] = None, + engine: Optional[ModerationEngineConfigRequest] = None, flood_config: Optional[FloodConfig] = None, google_vision_config: Optional[GoogleVisionConfig] = None, + intent_config: Optional[IntentConfigRequest] = None, llm_config: Optional[LLMConfig] = None, rule_builder_config: Optional[RuleBuilderConfig] = None, user: Optional[UserRequest] = None, @@ -400,8 +418,10 @@ async def upsert_config( aws_rekognition_config=aws_rekognition_config, block_list_config=block_list_config, bodyguard_config=bodyguard_config, + engine=engine, flood_config=flood_config, google_vision_config=google_vision_config, + intent_config=intent_config, llm_config=llm_config, rule_builder_config=rule_builder_config, user=user, @@ -416,7 +436,7 @@ async def upsert_config( async def delete_config( self, key: str, team: Optional[str] = None, user_id: Optional[str] = None ) -> StreamResponse[DeleteModerationConfigResponse]: - query_params = build_query_param(team=team, user_id=user_id) + query_params = build_query_param(**{"team": team, "user_id": user_id}) path_params = { "key": key, } @@ -431,7 +451,7 @@ async def delete_config( async def get_config( self, key: str, team: Optional[str] = None ) -> StreamResponse[GetConfigResponse]: - query_params = build_query_param(team=team) + query_params = build_query_param(**{"team": team}) path_params = { "key": key, } @@ -490,13 +510,43 @@ async def custom_check( "/api/v2/moderation/custom_check", CustomCheckResponse, json=json ) + @telemetry.operation_name("getstream.api.moderation.query_moderation_feedback") + async def query_moderation_feedback( + self, + item_limit: Optional[int] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryModerationFeedbackResponse]: + json = QueryModerationFeedbackRequest( + item_limit=item_limit, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + sort=sort, + filter=filter, + user=user, + ).to_dict() + return await self.post( + "/api/v2/moderation/feedback_items", + QueryModerationFeedbackResponse, + json=json, + ) + @telemetry.operation_name("getstream.api.moderation.v2_delete_template") async def v2_delete_template( - self, + self, name: Optional[str] = None ) -> StreamResponse[DeleteModerationTemplateResponse]: + query_params = build_query_param(**{"name": name}) return await self.delete( "/api/v2/moderation/feeds_moderation_template", DeleteModerationTemplateResponse, + query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.v2_query_templates") @@ -684,7 +734,7 @@ async def upsert_moderation_rule( async def delete_moderation_rule( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteModerationRuleResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -761,9 +811,14 @@ async def get_policy_test_run( ) @telemetry.operation_name("getstream.api.moderation.list_policy_test_sets") - async def list_policy_test_sets(self) -> StreamResponse[PolicyTestSetListResponse]: + async def list_policy_test_sets( + self, limit: Optional[int] = None, offset: Optional[int] = None + ) -> StreamResponse[PolicyTestSetListResponse]: + query_params = build_query_param(**{"limit": limit, "offset": offset}) return await self.get( - "/api/v2/moderation/policy_tests/sets", PolicyTestSetListResponse + "/api/v2/moderation/policy_tests/sets", + PolicyTestSetListResponse, + query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.create_policy_test_set") @@ -824,7 +879,7 @@ async def start_policy_test_run( async def list_queues( self, user_id: Optional[str] = None ) -> StreamResponse[ListQueuesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return await self.get( "/api/v2/moderation/queues", ListQueuesResponse, query_params=query_params ) @@ -855,7 +910,7 @@ async def create_queue( async def get_queue( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[QueueResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -910,6 +965,18 @@ async def delete_queue( json=json, ) + @telemetry.operation_name("getstream.api.moderation.reveal_media") + async def reveal_media( + self, + item_id: str, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RevealMediaResponse]: + json = RevealMediaRequest(item_id=item_id, user_id=user_id, user=user).to_dict() + return await self.post( + "/api/v2/moderation/reveal_media", RevealMediaResponse, json=json + ) + @telemetry.operation_name("getstream.api.moderation.query_review_queue") async def query_review_queue( self, @@ -964,8 +1031,8 @@ async def get_setup_session(self) -> StreamResponse[GetSetupSessionResponse]: @telemetry.operation_name("getstream.api.moderation.upsert_setup_session") async def upsert_setup_session( self, - current_step: str, - status: str, + current_step: SetupStep, + status: SetupStatus, setup_data: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpsertSetupSessionResponse]: json = UpsertSetupSessionRequest( @@ -989,6 +1056,9 @@ async def submit_action( delete_activity: Optional[DeleteActivityRequestPayload] = None, delete_comment: Optional[DeleteCommentRequestPayload] = None, delete_message: Optional[DeleteMessageRequestPayload] = None, + delete_poll: Optional[DeletePollRequestPayload] = None, + delete_poll_answer: Optional[DeletePollAnswerRequestPayload] = None, + delete_poll_option: Optional[DeletePollOptionRequestPayload] = None, delete_reaction: Optional[DeleteReactionRequestPayload] = None, delete_user: Optional[DeleteUserRequestPayload] = None, delete_user_messages: Optional[DeleteUserMessagesRequestPayload] = None, @@ -1014,6 +1084,9 @@ async def submit_action( delete_activity=delete_activity, delete_comment=delete_comment, delete_message=delete_message, + delete_poll=delete_poll, + delete_poll_answer=delete_poll_answer, + delete_poll_option=delete_poll_option, delete_reaction=delete_reaction, delete_user=delete_user, delete_user_messages=delete_user_messages, @@ -1034,26 +1107,46 @@ async def submit_action( @telemetry.operation_name("getstream.api.moderation.submit_moderation_feedback") async def submit_moderation_feedback( self, - message: str, - published_at: str, - reference: str, channel_id: Optional[str] = None, + confidence: Optional[str] = None, current_recommended_action: Optional[str] = None, description: Optional[str] = None, + entity_creator_id: Optional[str] = None, + entity_id: Optional[str] = None, + entity_type: Optional[str] = None, expected_recommended_action: Optional[str] = None, + false_positive: Optional[bool] = None, + feedback_type: Optional[str] = None, + message: Optional[str] = None, + published_at: Optional[str] = None, + reference: Optional[str] = None, + review_queue_item_id: Optional[str] = None, + user_id: Optional[str] = None, current_labels: Optional[List[str]] = None, expected_labels: Optional[List[str]] = None, + items: Optional[List[SubmitModerationFeedbackItem]] = None, + user: Optional[UserRequest] = None, ) -> StreamResponse[SubmitModerationFeedbackResponse]: json = SubmitModerationFeedbackRequest( - message=message, - published_at=published_at, - reference=reference, channel_id=channel_id, + confidence=confidence, current_recommended_action=current_recommended_action, description=description, + entity_creator_id=entity_creator_id, + entity_id=entity_id, + entity_type=entity_type, expected_recommended_action=expected_recommended_action, + false_positive=false_positive, + feedback_type=feedback_type, + message=message, + published_at=published_at, + reference=reference, + review_queue_item_id=review_queue_item_id, + user_id=user_id, current_labels=current_labels, expected_labels=expected_labels, + items=items, + user=user, ).to_dict() return await self.post( "/api/v2/moderation/submit_moderation_feedback", @@ -1071,9 +1164,11 @@ async def unban( unbanned_by: Optional[UserRequest] = None, ) -> StreamResponse[UnbanResponse]: query_params = build_query_param( - target_user_id=target_user_id, - channel_cid=channel_cid, - created_by=created_by, + **{ + "target_user_id": target_user_id, + "channel_cid": channel_cid, + "created_by": created_by, + } ) json = UnbanRequest( unbanned_by_id=unbanned_by_id, unbanned_by=unbanned_by diff --git a/getstream/moderation/rest_client.py b/getstream/moderation/rest_client.py index 3ee39076..e1430249 100644 --- a/getstream/moderation/rest_client.py +++ b/getstream/moderation/rest_client.py @@ -41,11 +41,13 @@ def get_action_config( user_id: Optional[str] = None, ) -> StreamResponse[GetActionConfigResponse]: query_params = build_query_param( - queue_type=queue_type, - entity_type=entity_type, - exclude_defaults=exclude_defaults, - only_defaults=only_defaults, - user_id=user_id, + **{ + "queue_type": queue_type, + "entity_type": entity_type, + "exclude_defaults": exclude_defaults, + "only_defaults": only_defaults, + "user_id": user_id, + } ) return self.get( "/api/v2/moderation/action_config", @@ -119,7 +121,7 @@ def bulk_delete_action_config( def delete_action_config( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteActionConfigResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -162,10 +164,12 @@ def analyze( async_response: Optional[bool] = None, config_key: Optional[str] = None, content_published_at: Optional[datetime] = None, + country_code: Optional[str] = None, entity_creator_id: Optional[str] = None, entity_id: Optional[str] = None, entity_type: Optional[str] = None, user_id: Optional[str] = None, + country_codes: Optional[List[str]] = None, content_ids: Optional[Dict[str, str]] = None, custom: Optional[Dict[str, object]] = None, texts: Optional[Dict[str, str]] = None, @@ -175,10 +179,12 @@ def analyze( async_response=async_response, config_key=config_key, content_published_at=content_published_at, + country_code=country_code, entity_creator_id=entity_creator_id, entity_id=entity_id, entity_type=entity_type, user_id=user_id, + country_codes=country_codes, content_ids=content_ids, custom=custom, texts=texts, @@ -192,6 +198,7 @@ def appeal( appeal_reason: str, entity_id: str, entity_type: str, + channel_cid: Optional[str] = None, review_queue_item_id: Optional[str] = None, user_id: Optional[str] = None, attachments: Optional[List[str]] = None, @@ -201,6 +208,7 @@ def appeal( appeal_reason=appeal_reason, entity_id=entity_id, entity_type=entity_type, + channel_cid=channel_cid, review_queue_item_id=review_queue_item_id, user_id=user_id, attachments=attachments, @@ -273,9 +281,11 @@ def bulk_action_appeals( def ban( self, target_user_id: str, + ban_from_future_channels: Optional[bool] = None, banned_by_id: Optional[str] = None, channel_cid: Optional[str] = None, - delete_messages: Optional[str] = None, + delete_messages: Optional[DeleteMessages] = None, + delete_reactions: Optional[bool] = None, ip_ban: Optional[bool] = None, reason: Optional[str] = None, shadow: Optional[bool] = None, @@ -284,9 +294,11 @@ def ban( ) -> StreamResponse[ModerationBanResponse]: json = BanRequest( target_user_id=target_user_id, + ban_from_future_channels=ban_from_future_channels, banned_by_id=banned_by_id, channel_cid=channel_cid, delete_messages=delete_messages, + delete_reactions=delete_reactions, ip_ban=ip_ban, reason=reason, shadow=shadow, @@ -322,8 +334,10 @@ def check( config_key: Optional[str] = None, config_team: Optional[str] = None, content_published_at: Optional[datetime] = None, + country_code: Optional[str] = None, test_mode: Optional[bool] = None, user_id: Optional[str] = None, + country_codes: Optional[List[str]] = None, config: Optional[ModerationConfig] = None, moderation_payload: Optional[ModerationPayload] = None, options: Optional[Dict[str, object]] = None, @@ -336,8 +350,10 @@ def check( config_key=config_key, config_team=config_team, content_published_at=content_published_at, + country_code=country_code, test_mode=test_mode, user_id=user_id, + country_codes=country_codes, config=config, moderation_payload=moderation_payload, options=options, @@ -373,8 +389,10 @@ def upsert_config( aws_rekognition_config: Optional[AIImageConfig] = None, block_list_config: Optional[BlockListConfig] = None, bodyguard_config: Optional[AITextConfig] = None, + engine: Optional[ModerationEngineConfigRequest] = None, flood_config: Optional[FloodConfig] = None, google_vision_config: Optional[GoogleVisionConfig] = None, + intent_config: Optional[IntentConfigRequest] = None, llm_config: Optional[LLMConfig] = None, rule_builder_config: Optional[RuleBuilderConfig] = None, user: Optional[UserRequest] = None, @@ -396,8 +414,10 @@ def upsert_config( aws_rekognition_config=aws_rekognition_config, block_list_config=block_list_config, bodyguard_config=bodyguard_config, + engine=engine, flood_config=flood_config, google_vision_config=google_vision_config, + intent_config=intent_config, llm_config=llm_config, rule_builder_config=rule_builder_config, user=user, @@ -410,7 +430,7 @@ def upsert_config( def delete_config( self, key: str, team: Optional[str] = None, user_id: Optional[str] = None ) -> StreamResponse[DeleteModerationConfigResponse]: - query_params = build_query_param(team=team, user_id=user_id) + query_params = build_query_param(**{"team": team, "user_id": user_id}) path_params = { "key": key, } @@ -425,7 +445,7 @@ def delete_config( def get_config( self, key: str, team: Optional[str] = None ) -> StreamResponse[GetConfigResponse]: - query_params = build_query_param(team=team) + query_params = build_query_param(**{"team": team}) path_params = { "key": key, } @@ -484,11 +504,43 @@ def custom_check( "/api/v2/moderation/custom_check", CustomCheckResponse, json=json ) + @telemetry.operation_name("getstream.api.moderation.query_moderation_feedback") + def query_moderation_feedback( + self, + item_limit: Optional[int] = None, + limit: Optional[int] = None, + next: Optional[str] = None, + prev: Optional[str] = None, + user_id: Optional[str] = None, + sort: Optional[List[SortParamRequest]] = None, + filter: Optional[Dict[str, object]] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[QueryModerationFeedbackResponse]: + json = QueryModerationFeedbackRequest( + item_limit=item_limit, + limit=limit, + next=next, + prev=prev, + user_id=user_id, + sort=sort, + filter=filter, + user=user, + ).to_dict() + return self.post( + "/api/v2/moderation/feedback_items", + QueryModerationFeedbackResponse, + json=json, + ) + @telemetry.operation_name("getstream.api.moderation.v2_delete_template") - def v2_delete_template(self) -> StreamResponse[DeleteModerationTemplateResponse]: + def v2_delete_template( + self, name: Optional[str] = None + ) -> StreamResponse[DeleteModerationTemplateResponse]: + query_params = build_query_param(**{"name": name}) return self.delete( "/api/v2/moderation/feeds_moderation_template", DeleteModerationTemplateResponse, + query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.v2_query_templates") @@ -676,7 +728,7 @@ def upsert_moderation_rule( def delete_moderation_rule( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[DeleteModerationRuleResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -749,9 +801,14 @@ def get_policy_test_run(self, id: str) -> StreamResponse[PolicyTestRunResponse]: ) @telemetry.operation_name("getstream.api.moderation.list_policy_test_sets") - def list_policy_test_sets(self) -> StreamResponse[PolicyTestSetListResponse]: + def list_policy_test_sets( + self, limit: Optional[int] = None, offset: Optional[int] = None + ) -> StreamResponse[PolicyTestSetListResponse]: + query_params = build_query_param(**{"limit": limit, "offset": offset}) return self.get( - "/api/v2/moderation/policy_tests/sets", PolicyTestSetListResponse + "/api/v2/moderation/policy_tests/sets", + PolicyTestSetListResponse, + query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.create_policy_test_set") @@ -808,7 +865,7 @@ def start_policy_test_run(self, id: str) -> StreamResponse[PolicyTestRunResponse def list_queues( self, user_id: Optional[str] = None ) -> StreamResponse[ListQueuesResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) return self.get( "/api/v2/moderation/queues", ListQueuesResponse, query_params=query_params ) @@ -839,7 +896,7 @@ def create_queue( def get_queue( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[QueueResponse]: - query_params = build_query_param(user_id=user_id) + query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } @@ -894,6 +951,18 @@ def delete_queue( json=json, ) + @telemetry.operation_name("getstream.api.moderation.reveal_media") + def reveal_media( + self, + item_id: str, + user_id: Optional[str] = None, + user: Optional[UserRequest] = None, + ) -> StreamResponse[RevealMediaResponse]: + json = RevealMediaRequest(item_id=item_id, user_id=user_id, user=user).to_dict() + return self.post( + "/api/v2/moderation/reveal_media", RevealMediaResponse, json=json + ) + @telemetry.operation_name("getstream.api.moderation.query_review_queue") def query_review_queue( self, @@ -948,8 +1017,8 @@ def get_setup_session(self) -> StreamResponse[GetSetupSessionResponse]: @telemetry.operation_name("getstream.api.moderation.upsert_setup_session") def upsert_setup_session( self, - current_step: str, - status: str, + current_step: SetupStep, + status: SetupStatus, setup_data: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpsertSetupSessionResponse]: json = UpsertSetupSessionRequest( @@ -973,6 +1042,9 @@ def submit_action( delete_activity: Optional[DeleteActivityRequestPayload] = None, delete_comment: Optional[DeleteCommentRequestPayload] = None, delete_message: Optional[DeleteMessageRequestPayload] = None, + delete_poll: Optional[DeletePollRequestPayload] = None, + delete_poll_answer: Optional[DeletePollAnswerRequestPayload] = None, + delete_poll_option: Optional[DeletePollOptionRequestPayload] = None, delete_reaction: Optional[DeleteReactionRequestPayload] = None, delete_user: Optional[DeleteUserRequestPayload] = None, delete_user_messages: Optional[DeleteUserMessagesRequestPayload] = None, @@ -998,6 +1070,9 @@ def submit_action( delete_activity=delete_activity, delete_comment=delete_comment, delete_message=delete_message, + delete_poll=delete_poll, + delete_poll_answer=delete_poll_answer, + delete_poll_option=delete_poll_option, delete_reaction=delete_reaction, delete_user=delete_user, delete_user_messages=delete_user_messages, @@ -1018,26 +1093,46 @@ def submit_action( @telemetry.operation_name("getstream.api.moderation.submit_moderation_feedback") def submit_moderation_feedback( self, - message: str, - published_at: str, - reference: str, channel_id: Optional[str] = None, + confidence: Optional[str] = None, current_recommended_action: Optional[str] = None, description: Optional[str] = None, + entity_creator_id: Optional[str] = None, + entity_id: Optional[str] = None, + entity_type: Optional[str] = None, expected_recommended_action: Optional[str] = None, + false_positive: Optional[bool] = None, + feedback_type: Optional[str] = None, + message: Optional[str] = None, + published_at: Optional[str] = None, + reference: Optional[str] = None, + review_queue_item_id: Optional[str] = None, + user_id: Optional[str] = None, current_labels: Optional[List[str]] = None, expected_labels: Optional[List[str]] = None, + items: Optional[List[SubmitModerationFeedbackItem]] = None, + user: Optional[UserRequest] = None, ) -> StreamResponse[SubmitModerationFeedbackResponse]: json = SubmitModerationFeedbackRequest( - message=message, - published_at=published_at, - reference=reference, channel_id=channel_id, + confidence=confidence, current_recommended_action=current_recommended_action, description=description, + entity_creator_id=entity_creator_id, + entity_id=entity_id, + entity_type=entity_type, expected_recommended_action=expected_recommended_action, + false_positive=false_positive, + feedback_type=feedback_type, + message=message, + published_at=published_at, + reference=reference, + review_queue_item_id=review_queue_item_id, + user_id=user_id, current_labels=current_labels, expected_labels=expected_labels, + items=items, + user=user, ).to_dict() return self.post( "/api/v2/moderation/submit_moderation_feedback", @@ -1055,9 +1150,11 @@ def unban( unbanned_by: Optional[UserRequest] = None, ) -> StreamResponse[UnbanResponse]: query_params = build_query_param( - target_user_id=target_user_id, - channel_cid=channel_cid, - created_by=created_by, + **{ + "target_user_id": target_user_id, + "channel_cid": channel_cid, + "created_by": created_by, + } ) json = UnbanRequest( unbanned_by_id=unbanned_by_id, unbanned_by=unbanned_by diff --git a/getstream/tests/test_webhook.py b/getstream/tests/test_webhook.py index 1f5c9f03..a464b3bc 100644 --- a/getstream/tests/test_webhook.py +++ b/getstream/tests/test_webhook.py @@ -1,23 +1,25 @@ # Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT. -import hashlib import hmac +import hashlib + import warnings + from pathlib import Path import pytest from getstream.webhook import ( - InvalidWebhookError, - UnknownEvent, get_event_type, - parse_event, - parse_sns, - parse_sqs, parse_webhook_event, - verify_and_parse_webhook, - verify_signature, verify_webhook_signature, + verify_signature, + parse_event, + verify_and_parse_webhook, + parse_sqs, + parse_sns, + UnknownEvent, + InvalidWebhookError, ) @@ -324,6 +326,12 @@ def test_parse_call_ring(self): event = parse_webhook_event({"type": "call.ring"}) assert type(event).__name__ == "CallRingEvent" + def test_parse_call_ring_settled(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "call.ring_settled"}) + assert type(event).__name__ == "CallRingSettledEvent" + def test_parse_call_rtmp_broadcast_failed(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -452,6 +460,12 @@ def test_parse_channel_deleted(self): event = parse_webhook_event({"type": "channel.deleted"}) assert type(event).__name__ == "ChannelDeletedEvent" + def test_parse_channel_forked(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "channel.forked"}) + assert type(event).__name__ == "ChannelForkedEvent" + def test_parse_channel_frozen(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -476,6 +490,12 @@ def test_parse_channel_muted(self): event = parse_webhook_event({"type": "channel.muted"}) assert type(event).__name__ == "ChannelMutedEvent" + def test_parse_channel_rewound(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "channel.rewound"}) + assert type(event).__name__ == "ChannelRewoundEvent" + def test_parse_channel_truncated(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -550,6 +570,18 @@ def test_parse_export_channels_success(self): event = parse_webhook_event({"type": "export.channels.success"}) assert type(event).__name__ == "AsyncExportChannelsEvent" + def test_parse_export_label_results_error(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "export.label_results.error"}) + assert type(event).__name__ == "AsyncExportErrorEvent" + + def test_parse_export_label_results_success(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "export.label_results.success"}) + assert type(event).__name__ == "AsyncExportLabelResultsEvent" + def test_parse_export_moderation_logs_error(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -700,6 +732,12 @@ def test_parse_feeds_comment_deleted(self): event = parse_webhook_event({"type": "feeds.comment.deleted"}) assert type(event).__name__ == "CommentDeletedEvent" + def test_parse_feeds_comment_feedback(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "feeds.comment.feedback"}) + assert type(event).__name__ == "CommentFeedbackEvent" + def test_parse_feeds_comment_reaction_added(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -730,6 +768,18 @@ def test_parse_feeds_comment_updated(self): event = parse_webhook_event({"type": "feeds.comment.updated"}) assert type(event).__name__ == "CommentUpdatedEvent" + def test_parse_feeds_export_error(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "feeds.export.error"}) + assert type(event).__name__ == "AsyncExportErrorEvent" + + def test_parse_feeds_export_success(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "feeds.export.success"}) + assert type(event).__name__ == "AsyncExportFeedsSuccessEvent" + def test_parse_feeds_feed_created(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -820,6 +870,18 @@ def test_parse_flag_updated(self): event = parse_webhook_event({"type": "flag.updated"}) assert type(event).__name__ == "FlagUpdatedEvent" + def test_parse_import_error(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "import.error"}) + assert type(event).__name__ == "AsyncImportErrorEvent" + + def test_parse_import_success(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "import.success"}) + assert type(event).__name__ == "AsyncImportSuccessEvent" + def test_parse_ingress_error(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -970,6 +1032,42 @@ def test_parse_notification_thread_message_new(self): event = parse_webhook_event({"type": "notification.thread_message_new"}) assert type(event).__name__ == "NotificationThreadMessageNewEvent" + def test_parse_poll_closed(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.closed"}) + assert type(event).__name__ == "PollClosedEvent" + + def test_parse_poll_deleted(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.deleted"}) + assert type(event).__name__ == "PollDeletedEvent" + + def test_parse_poll_updated(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.updated"}) + assert type(event).__name__ == "PollUpdatedEvent" + + def test_parse_poll_vote_casted(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.vote_casted"}) + assert type(event).__name__ == "PollVoteCastedEvent" + + def test_parse_poll_vote_changed(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.vote_changed"}) + assert type(event).__name__ == "PollVoteChangedEvent" + + def test_parse_poll_vote_removed(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "poll.vote_removed"}) + assert type(event).__name__ == "PollVoteRemovedEvent" + def test_parse_reaction_deleted(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -1018,6 +1116,18 @@ def test_parse_review_queue_item_updated(self): event = parse_webhook_event({"type": "review_queue_item.updated"}) assert type(event).__name__ == "ReviewQueueItemUpdatedEvent" + def test_parse_scheduled_message_failed(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "scheduled_message.failed"}) + assert type(event).__name__ == "ScheduledMessageFailedEvent" + + def test_parse_scheduled_message_sent(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "scheduled_message.sent"}) + assert type(event).__name__ == "ScheduledMessageSentEvent" + def test_parse_thread_updated(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -1030,6 +1140,12 @@ def test_parse_user_banned(self): event = parse_webhook_event({"type": "user.banned"}) assert type(event).__name__ == "UserBannedEvent" + def test_parse_user_claimed(self): + with warnings.catch_warnings(): + warnings.simplefilter("ignore", RuntimeWarning) + event = parse_webhook_event({"type": "user.claimed"}) + assert type(event).__name__ == "UserClaimedEvent" + def test_parse_user_deactivated(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", RuntimeWarning) @@ -1135,7 +1251,7 @@ def test_invalid_json(self): # --------------------------------------------------------------------------- # Conformance fixture suite (CHA-2961). The fixture set is generated by -# chat/'s `chat-manager openapi generate-webhook-fixtures` subcommand; the +# chat/'s `build/openapi generate-webhook-fixtures` subcommand; the # repo's generate.sh copies it into tests/assets/webhooks/ at codegen time # (per stream-py AGENTS.md §8: test file assets live under tests/assets/). # --------------------------------------------------------------------------- diff --git a/getstream/video/async_call.py b/getstream/video/async_call.py index ec7fd972..4473e324 100644 --- a/getstream/video/async_call.py +++ b/getstream/video/async_call.py @@ -275,7 +275,9 @@ async def list_recordings(self) -> StreamResponse[ListRecordingsResponse]: @attach_call_cid_async async def start_recording( - self, recording_type: str, recording_external_storage: Optional[str] = None + self, + recording_type: RecordingType, + recording_external_storage: Optional[str] = None, ) -> StreamResponse[StartRecordingResponse]: response = await self.client.start_recording( type=self.call_type, @@ -289,7 +291,7 @@ async def start_recording( @attach_call_cid_async async def stop_recording( self, - recording_type: str, + recording_type: RecordingType, ) -> StreamResponse[StopRecordingResponse]: response = await self.client.stop_recording( type=self.call_type, @@ -311,10 +313,17 @@ async def get_call_report( @attach_call_cid_async async def ring( - self, video: Optional[bool] = None, members_ids: Optional[List[str]] = None + self, + video: Optional[bool] = None, + members_ids: Optional[List[str]] = None, + custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[RingCallResponse]: response = await self.client.ring_call( - type=self.call_type, id=self.id, video=video, members_ids=members_ids + type=self.call_type, + id=self.id, + video=video, + members_ids=members_ids, + custom=custom, ) self._sync_from_response(response.data) return response @@ -409,7 +418,7 @@ async def start_closed_captions( self, enable_transcription: Optional[bool] = None, external_storage: Optional[str] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, speech_segment_config: Optional[SpeechSegmentConfig] = None, ) -> StreamResponse[StartClosedCaptionsResponse]: response = await self.client.start_closed_captions( @@ -439,7 +448,7 @@ async def start_frame_recording( async def start_transcription( self, enable_closed_captions: Optional[bool] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, transcription_external_storage: Optional[str] = None, ) -> StreamResponse[StartTranscriptionResponse]: response = await self.client.start_transcription( diff --git a/getstream/video/async_rest_client.py b/getstream/video/async_rest_client.py index 993e7317..c8d1a510 100644 --- a/getstream/video/async_rest_client.py +++ b/getstream/video/async_rest_client.py @@ -49,7 +49,7 @@ async def query_user_feedback( sort: Optional[List[SortParamRequest]] = None, filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryUserFeedbackResponse]: - query_params = build_query_param(full=full) + query_params = build_query_param(**{"full": full}) json = QueryUserFeedbackRequest( limit=limit, next=next, @@ -88,6 +88,17 @@ async def query_call_members( "/api/v2/video/call/members", QueryCallMembersResponse, json=json ) + @telemetry.operation_name("getstream.api.video.query_call_ring_attempts") + async def query_call_ring_attempts( + self, id: str, type: str, call_session_id: Optional[str] = None + ) -> StreamResponse[QueryCallRingAttemptsResponse]: + json = QueryCallRingAttemptsRequest( + id=id, type=type, call_session_id=call_session_id + ).to_dict() + return await self.post( + "/api/v2/video/call/ring_attempts", QueryCallRingAttemptsResponse, json=json + ) + @telemetry.operation_name("getstream.api.video.query_call_stats") async def query_call_stats( self, @@ -119,7 +130,12 @@ async def get_call( video: Optional[bool] = None, ) -> StreamResponse[GetCallResponse]: query_params = build_query_param( - members_limit=members_limit, ring=ring, notify=notify, video=video + **{ + "members_limit": members_limit, + "ring": ring, + "notify": notify, + "video": video, + } ) path_params = { "type": type, @@ -443,7 +459,7 @@ async def query_call_participants( limit: Optional[int] = None, filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallParticipantsResponse]: - query_params = build_query_param(limit=limit) + query_params = build_query_param(**{"limit": limit}) path_params = { "id": id, "type": type, @@ -494,7 +510,7 @@ async def start_recording( self, type: str, id: str, - recording_type: str, + recording_type: RecordingType, recording_external_storage: Optional[str] = None, ) -> StreamResponse[StartRecordingResponse]: path_params = { @@ -517,7 +533,7 @@ async def stop_recording( self, type: str, id: str, - recording_type: str, + recording_type: RecordingType, ) -> StreamResponse[StopRecordingResponse]: path_params = { "type": type, @@ -536,7 +552,7 @@ async def stop_recording( async def get_call_report( self, type: str, id: str, session_id: Optional[str] = None ) -> StreamResponse[GetCallReportResponse]: - query_params = build_query_param(session_id=session_id) + query_params = build_query_param(**{"session_id": session_id}) path_params = { "type": type, "id": id, @@ -555,12 +571,15 @@ async def ring_call( id: str, video: Optional[bool] = None, members_ids: Optional[List[str]] = None, + custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[RingCallResponse]: path_params = { "type": type, "id": id, } - json = RingCallRequest(video=video, members_ids=members_ids).to_dict() + json = RingCallRequest( + video=video, members_ids=members_ids, custom=custom + ).to_dict() return await self.post( "/api/v2/video/call/{type}/{id}/ring", RingCallResponse, @@ -631,7 +650,7 @@ async def get_call_participant_session_metrics( since: Optional[datetime] = None, until: Optional[datetime] = None, ) -> StreamResponse[GetCallParticipantSessionMetricsResponse]: - query_params = build_query_param(since=since, until=until) + query_params = build_query_param(**{"since": since, "until": until}) path_params = { "type": type, "id": id, @@ -658,7 +677,12 @@ async def query_call_participant_sessions( filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallParticipantSessionsResponse]: query_params = build_query_param( - limit=limit, prev=prev, next=next, filter_conditions=filter_conditions + **{ + "limit": limit, + "prev": prev, + "next": next, + "filter_conditions": filter_conditions, + } ) path_params = { "type": type, @@ -693,7 +717,7 @@ async def start_closed_captions( id: str, enable_transcription: Optional[bool] = None, external_storage: Optional[str] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, speech_segment_config: Optional[SpeechSegmentConfig] = None, ) -> StreamResponse[StartClosedCaptionsResponse]: path_params = { @@ -737,7 +761,7 @@ async def start_transcription( type: str, id: str, enable_closed_captions: Optional[bool] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, transcription_external_storage: Optional[str] = None, ) -> StreamResponse[StartTranscriptionResponse]: path_params = { @@ -1000,11 +1024,13 @@ async def get_call_stats_map( exclude_sfus: Optional[bool] = None, ) -> StreamResponse[QueryCallStatsMapResponse]: query_params = build_query_param( - start_time=start_time, - end_time=end_time, - exclude_publishers=exclude_publishers, - exclude_subscribers=exclude_subscribers, - exclude_sfus=exclude_sfus, + **{ + "start_time": start_time, + "end_time": end_time, + "exclude_publishers": exclude_publishers, + "exclude_subscribers": exclude_subscribers, + "exclude_sfus": exclude_sfus, + } ) path_params = { "call_type": call_type, @@ -1033,7 +1059,7 @@ async def get_call_session_participant_stats_details( max_points: Optional[int] = None, ) -> StreamResponse[GetCallSessionParticipantStatsDetailsResponse]: query_params = build_query_param( - since=since, until=until, max_points=max_points + **{"since": since, "until": until, "max_points": max_points} ) path_params = { "call_type": call_type, @@ -1064,11 +1090,13 @@ async def query_call_session_participant_stats( filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallSessionParticipantStatsResponse]: query_params = build_query_param( - limit=limit, - prev=prev, - next=next, - sort=sort, - filter_conditions=filter_conditions, + **{ + "limit": limit, + "prev": prev, + "next": next, + "sort": sort, + "filter_conditions": filter_conditions, + } ) path_params = { "call_type": call_type, @@ -1097,7 +1125,7 @@ async def get_call_session_participant_stats_timeline( severity: Optional[List[str]] = None, ) -> StreamResponse[QueryCallSessionParticipantStatsTimelineResponse]: query_params = build_query_param( - start_time=start_time, end_time=end_time, severity=severity + **{"start_time": start_time, "end_time": end_time, "severity": severity} ) path_params = { "call_type": call_type, @@ -1400,7 +1428,9 @@ async def query_aggregate_call_stats( async def get_daily_digest( self, date: Optional[str] = None, target_app_id: Optional[str] = None ) -> StreamResponse[GetDailyDigestResponse]: - query_params = build_query_param(date=date, target_app_id=target_app_id) + query_params = build_query_param( + **{"date": date, "target_app_id": target_app_id} + ) return await self.get( "/api/v2/video/stats/daily_digest", GetDailyDigestResponse, diff --git a/getstream/video/call.py b/getstream/video/call.py index 197f5d0e..2bca92df 100644 --- a/getstream/video/call.py +++ b/getstream/video/call.py @@ -269,7 +269,9 @@ def list_recordings(self) -> StreamResponse[ListRecordingsResponse]: @attach_call_cid def start_recording( - self, recording_type: str, recording_external_storage: Optional[str] = None + self, + recording_type: RecordingType, + recording_external_storage: Optional[str] = None, ) -> StreamResponse[StartRecordingResponse]: response = self.client.start_recording( type=self.call_type, @@ -283,7 +285,7 @@ def start_recording( @attach_call_cid def stop_recording( self, - recording_type: str, + recording_type: RecordingType, ) -> StreamResponse[StopRecordingResponse]: response = self.client.stop_recording( type=self.call_type, @@ -305,10 +307,17 @@ def get_call_report( @attach_call_cid def ring( - self, video: Optional[bool] = None, members_ids: Optional[List[str]] = None + self, + video: Optional[bool] = None, + members_ids: Optional[List[str]] = None, + custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[RingCallResponse]: response = self.client.ring_call( - type=self.call_type, id=self.id, video=video, members_ids=members_ids + type=self.call_type, + id=self.id, + video=video, + members_ids=members_ids, + custom=custom, ) self._sync_from_response(response.data) return response @@ -395,7 +404,7 @@ def start_closed_captions( self, enable_transcription: Optional[bool] = None, external_storage: Optional[str] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, speech_segment_config: Optional[SpeechSegmentConfig] = None, ) -> StreamResponse[StartClosedCaptionsResponse]: response = self.client.start_closed_captions( @@ -425,7 +434,7 @@ def start_frame_recording( def start_transcription( self, enable_closed_captions: Optional[bool] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, transcription_external_storage: Optional[str] = None, ) -> StreamResponse[StartTranscriptionResponse]: response = self.client.start_transcription( diff --git a/getstream/video/rest_client.py b/getstream/video/rest_client.py index 7d634b52..af70faee 100644 --- a/getstream/video/rest_client.py +++ b/getstream/video/rest_client.py @@ -47,7 +47,7 @@ def query_user_feedback( sort: Optional[List[SortParamRequest]] = None, filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryUserFeedbackResponse]: - query_params = build_query_param(full=full) + query_params = build_query_param(**{"full": full}) json = QueryUserFeedbackRequest( limit=limit, next=next, @@ -86,6 +86,17 @@ def query_call_members( "/api/v2/video/call/members", QueryCallMembersResponse, json=json ) + @telemetry.operation_name("getstream.api.video.query_call_ring_attempts") + def query_call_ring_attempts( + self, id: str, type: str, call_session_id: Optional[str] = None + ) -> StreamResponse[QueryCallRingAttemptsResponse]: + json = QueryCallRingAttemptsRequest( + id=id, type=type, call_session_id=call_session_id + ).to_dict() + return self.post( + "/api/v2/video/call/ring_attempts", QueryCallRingAttemptsResponse, json=json + ) + @telemetry.operation_name("getstream.api.video.query_call_stats") def query_call_stats( self, @@ -115,7 +126,12 @@ def get_call( video: Optional[bool] = None, ) -> StreamResponse[GetCallResponse]: query_params = build_query_param( - members_limit=members_limit, ring=ring, notify=notify, video=video + **{ + "members_limit": members_limit, + "ring": ring, + "notify": notify, + "video": video, + } ) path_params = { "type": type, @@ -439,7 +455,7 @@ def query_call_participants( limit: Optional[int] = None, filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallParticipantsResponse]: - query_params = build_query_param(limit=limit) + query_params = build_query_param(**{"limit": limit}) path_params = { "id": id, "type": type, @@ -490,7 +506,7 @@ def start_recording( self, type: str, id: str, - recording_type: str, + recording_type: RecordingType, recording_external_storage: Optional[str] = None, ) -> StreamResponse[StartRecordingResponse]: path_params = { @@ -513,7 +529,7 @@ def stop_recording( self, type: str, id: str, - recording_type: str, + recording_type: RecordingType, ) -> StreamResponse[StopRecordingResponse]: path_params = { "type": type, @@ -532,7 +548,7 @@ def stop_recording( def get_call_report( self, type: str, id: str, session_id: Optional[str] = None ) -> StreamResponse[GetCallReportResponse]: - query_params = build_query_param(session_id=session_id) + query_params = build_query_param(**{"session_id": session_id}) path_params = { "type": type, "id": id, @@ -551,12 +567,15 @@ def ring_call( id: str, video: Optional[bool] = None, members_ids: Optional[List[str]] = None, + custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[RingCallResponse]: path_params = { "type": type, "id": id, } - json = RingCallRequest(video=video, members_ids=members_ids).to_dict() + json = RingCallRequest( + video=video, members_ids=members_ids, custom=custom + ).to_dict() return self.post( "/api/v2/video/call/{type}/{id}/ring", RingCallResponse, @@ -627,7 +646,7 @@ def get_call_participant_session_metrics( since: Optional[datetime] = None, until: Optional[datetime] = None, ) -> StreamResponse[GetCallParticipantSessionMetricsResponse]: - query_params = build_query_param(since=since, until=until) + query_params = build_query_param(**{"since": since, "until": until}) path_params = { "type": type, "id": id, @@ -654,7 +673,12 @@ def query_call_participant_sessions( filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallParticipantSessionsResponse]: query_params = build_query_param( - limit=limit, prev=prev, next=next, filter_conditions=filter_conditions + **{ + "limit": limit, + "prev": prev, + "next": next, + "filter_conditions": filter_conditions, + } ) path_params = { "type": type, @@ -689,7 +713,7 @@ def start_closed_captions( id: str, enable_transcription: Optional[bool] = None, external_storage: Optional[str] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, speech_segment_config: Optional[SpeechSegmentConfig] = None, ) -> StreamResponse[StartClosedCaptionsResponse]: path_params = { @@ -733,7 +757,7 @@ def start_transcription( type: str, id: str, enable_closed_captions: Optional[bool] = None, - language: Optional[str] = None, + language: Optional[TranscriptionLanguage] = None, transcription_external_storage: Optional[str] = None, ) -> StreamResponse[StartTranscriptionResponse]: path_params = { @@ -996,11 +1020,13 @@ def get_call_stats_map( exclude_sfus: Optional[bool] = None, ) -> StreamResponse[QueryCallStatsMapResponse]: query_params = build_query_param( - start_time=start_time, - end_time=end_time, - exclude_publishers=exclude_publishers, - exclude_subscribers=exclude_subscribers, - exclude_sfus=exclude_sfus, + **{ + "start_time": start_time, + "end_time": end_time, + "exclude_publishers": exclude_publishers, + "exclude_subscribers": exclude_subscribers, + "exclude_sfus": exclude_sfus, + } ) path_params = { "call_type": call_type, @@ -1029,7 +1055,7 @@ def get_call_session_participant_stats_details( max_points: Optional[int] = None, ) -> StreamResponse[GetCallSessionParticipantStatsDetailsResponse]: query_params = build_query_param( - since=since, until=until, max_points=max_points + **{"since": since, "until": until, "max_points": max_points} ) path_params = { "call_type": call_type, @@ -1060,11 +1086,13 @@ def query_call_session_participant_stats( filter_conditions: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryCallSessionParticipantStatsResponse]: query_params = build_query_param( - limit=limit, - prev=prev, - next=next, - sort=sort, - filter_conditions=filter_conditions, + **{ + "limit": limit, + "prev": prev, + "next": next, + "sort": sort, + "filter_conditions": filter_conditions, + } ) path_params = { "call_type": call_type, @@ -1093,7 +1121,7 @@ def get_call_session_participant_stats_timeline( severity: Optional[List[str]] = None, ) -> StreamResponse[QueryCallSessionParticipantStatsTimelineResponse]: query_params = build_query_param( - start_time=start_time, end_time=end_time, severity=severity + **{"start_time": start_time, "end_time": end_time, "severity": severity} ) path_params = { "call_type": call_type, @@ -1392,7 +1420,9 @@ def query_aggregate_call_stats( def get_daily_digest( self, date: Optional[str] = None, target_app_id: Optional[str] = None ) -> StreamResponse[GetDailyDigestResponse]: - query_params = build_query_param(date=date, target_app_id=target_app_id) + query_params = build_query_param( + **{"date": date, "target_app_id": target_app_id} + ) return self.get( "/api/v2/video/stats/daily_digest", GetDailyDigestResponse, diff --git a/getstream/webhook.py b/getstream/webhook.py index b8c39083..afc6a8aa 100644 --- a/getstream/webhook.py +++ b/getstream/webhook.py @@ -2,43 +2,21 @@ import base64 import gzip -import hashlib import hmac +import hashlib import json import zlib from dataclasses import dataclass, field from datetime import datetime -from typing import Any - +from typing import Any, Dict, Optional, Union from .models import ( - ActivityAddedEvent, - ActivityDeletedEvent, - ActivityFeedbackEvent, - ActivityMarkEvent, - ActivityPinnedEvent, - ActivityReactionAddedEvent, - ActivityReactionDeletedEvent, - ActivityReactionUpdatedEvent, - ActivityRemovedFromFeedEvent, - ActivityRestoredEvent, - ActivityUnpinnedEvent, - ActivityUpdatedEvent, + CustomEvent, AppealAcceptedEvent, AppealCreatedEvent, AppealRejectedEvent, - AsyncBulkImageModerationEvent, - AsyncExportChannelsEvent, - AsyncExportErrorEvent, - AsyncExportModerationLogsEvent, - AsyncExportReviewQueueEvent, - AsyncExportUsersEvent, - BlockedUserEvent, - BookmarkAddedEvent, - BookmarkDeletedEvent, - BookmarkFolderDeletedEvent, - BookmarkFolderUpdatedEvent, - BookmarkUpdatedEvent, CallAcceptedEvent, + BlockedUserEvent, + ClosedCaptionEvent, CallClosedCaptionsFailedEvent, CallClosedCaptionsStartedEvent, CallClosedCaptionsStoppedEvent, @@ -53,6 +31,7 @@ CallHLSBroadcastingFailedEvent, CallHLSBroadcastingStartedEvent, CallHLSBroadcastingStoppedEvent, + KickedUserEvent, CallLiveStartedEvent, CallMemberAddedEvent, CallMemberRemovedEvent, @@ -62,6 +41,8 @@ CallModerationBlurEvent, CallModerationWarningEvent, CallNotificationEvent, + PermissionRequestEvent, + UpdatedCallPermissionsEvent, CallReactionEvent, CallRecordingFailedEvent, CallRecordingReadyEvent, @@ -69,6 +50,7 @@ CallRecordingStoppedEvent, CallRejectedEvent, CallRingEvent, + CallRingSettledEvent, CallRtmpBroadcastFailedEvent, CallRtmpBroadcastStartedEvent, CallRtmpBroadcastStoppedEvent, @@ -82,96 +64,125 @@ CallTranscriptionReadyEvent, CallTranscriptionStartedEvent, CallTranscriptionStoppedEvent, + UnblockedUserEvent, CallUpdatedEvent, CallUserFeedbackSubmittedEvent, CallUserMutedEvent, CampaignCompletedEvent, CampaignStartedEvent, - ChannelBatchCompletedEvent, - ChannelBatchStartedEvent, ChannelCreatedEvent, ChannelDeletedEvent, + ChannelForkedEvent, ChannelFrozenEvent, ChannelHiddenEvent, + MaxStreakChangedEvent, ChannelMutedEvent, + ChannelRewoundEvent, ChannelTruncatedEvent, ChannelUnFrozenEvent, ChannelUnmutedEvent, ChannelUpdatedEvent, ChannelVisibleEvent, - ClosedCaptionEvent, + ChannelBatchCompletedEvent, + ChannelBatchStartedEvent, + CustomVideoEvent, + AsyncBulkImageModerationEvent, + AsyncExportChannelsEvent, + AsyncExportLabelResultsEvent, + AsyncExportModerationLogsEvent, + AsyncExportReviewQueueEvent, + AsyncExportUsersEvent, + ActivityAddedEvent, + ActivityDeletedEvent, + ActivityFeedbackEvent, + ActivityMarkEvent, + ActivityPinnedEvent, + ActivityReactionAddedEvent, + ActivityReactionDeletedEvent, + ActivityReactionUpdatedEvent, + ActivityRemovedFromFeedEvent, + ActivityRestoredEvent, + ActivityUnpinnedEvent, + ActivityUpdatedEvent, + BookmarkAddedEvent, + BookmarkDeletedEvent, + BookmarkUpdatedEvent, + BookmarkFolderDeletedEvent, + BookmarkFolderUpdatedEvent, CommentAddedEvent, CommentDeletedEvent, + CommentFeedbackEvent, CommentReactionAddedEvent, CommentReactionDeletedEvent, CommentReactionUpdatedEvent, CommentRestoredEvent, CommentUpdatedEvent, - CustomEvent, - CustomVideoEvent, + AsyncExportErrorEvent, + AsyncExportFeedsSuccessEvent, FeedCreatedEvent, FeedDeletedEvent, + FeedUpdatedEvent, FeedGroupChangedEvent, FeedGroupDeletedEvent, FeedGroupRestoredEvent, FeedMemberAddedEvent, FeedMemberRemovedEvent, FeedMemberUpdatedEvent, - FeedUpdatedEvent, - FlagUpdatedEvent, FollowCreatedEvent, FollowDeletedEvent, FollowUpdatedEvent, + NotificationFeedUpdatedEvent, + StoriesFeedUpdatedEvent, + FlagUpdatedEvent, + AsyncImportErrorEvent, + AsyncImportSuccessEvent, IngressErrorEvent, IngressStartedEvent, IngressStoppedEvent, - KickedUserEvent, - MaxStreakChangedEvent, MemberAddedEvent, MemberRemovedEvent, MemberUpdatedEvent, MessageDeletedEvent, MessageFlaggedEvent, MessageNewEvent, + PendingMessageEvent, MessageReadEvent, MessageUnblockedEvent, MessageUndeletedEvent, MessageUpdatedEvent, ModerationAnalysisFailedEvent, - ModerationCheckCompletedEvent, ModerationCustomActionEvent, ModerationFlaggedEvent, ModerationImageAnalysisCompleteEvent, ModerationMarkReviewedEvent, - ModerationRulesTriggeredEvent, ModerationTextAnalysisCompleteEvent, - NotificationFeedUpdatedEvent, + ModerationCheckCompletedEvent, + ModerationRulesTriggeredEvent, NotificationMarkUnreadEvent, + ReminderNotificationEvent, NotificationThreadMessageNewEvent, - PendingMessageEvent, - PermissionRequestEvent, + PollClosedEvent, + PollDeletedEvent, + PollUpdatedEvent, + PollVoteCastedEvent, + PollVoteChangedEvent, + PollVoteRemovedEvent, ReactionDeletedEvent, ReactionNewEvent, ReactionUpdatedEvent, ReminderCreatedEvent, ReminderDeletedEvent, - ReminderNotificationEvent, ReminderUpdatedEvent, ReviewQueueItemNewEvent, ReviewQueueItemUpdatedEvent, - StoriesFeedUpdatedEvent, + ScheduledMessageFailedEvent, + ScheduledMessageSentEvent, ThreadUpdatedEvent, - UnblockedUserEvent, - UpdatedCallPermissionsEvent, UserBannedEvent, + UserClaimedEvent, UserDeactivatedEvent, UserDeletedEvent, UserFlaggedEvent, - UserGroupCreatedEvent, - UserGroupDeletedEvent, - UserGroupMemberAddedEvent, - UserGroupMemberRemovedEvent, - UserGroupUpdatedEvent, UserMessagesDeletedEvent, UserMutedEvent, UserReactivatedEvent, @@ -179,8 +190,14 @@ UserUnmutedEvent, UserUnreadReminderEvent, UserUpdatedEvent, + UserGroupCreatedEvent, + UserGroupDeletedEvent, + UserGroupMemberAddedEvent, + UserGroupMemberRemovedEvent, + UserGroupUpdatedEvent, ) + # Webhook event type constants EVENT_TYPE_WILDCARD = "*" EVENT_TYPE_APPEAL_ACCEPTED = "appeal.accepted" @@ -222,6 +239,7 @@ EVENT_TYPE_CALL_RECORDING_STOPPED = "call.recording_stopped" EVENT_TYPE_CALL_REJECTED = "call.rejected" EVENT_TYPE_CALL_RING = "call.ring" +EVENT_TYPE_CALL_RING_SETTLED = "call.ring_settled" EVENT_TYPE_CALL_RTMP_BROADCAST_FAILED = "call.rtmp_broadcast_failed" EVENT_TYPE_CALL_RTMP_BROADCAST_STARTED = "call.rtmp_broadcast_started" EVENT_TYPE_CALL_RTMP_BROADCAST_STOPPED = "call.rtmp_broadcast_stopped" @@ -245,10 +263,12 @@ EVENT_TYPE_CAMPAIGN_STARTED = "campaign.started" EVENT_TYPE_CHANNEL_CREATED = "channel.created" EVENT_TYPE_CHANNEL_DELETED = "channel.deleted" +EVENT_TYPE_CHANNEL_FORKED = "channel.forked" EVENT_TYPE_CHANNEL_FROZEN = "channel.frozen" EVENT_TYPE_CHANNEL_HIDDEN = "channel.hidden" EVENT_TYPE_CHANNEL_MAX_STREAK_CHANGED = "channel.max_streak_changed" EVENT_TYPE_CHANNEL_MUTED = "channel.muted" +EVENT_TYPE_CHANNEL_REWOUND = "channel.rewound" EVENT_TYPE_CHANNEL_TRUNCATED = "channel.truncated" EVENT_TYPE_CHANNEL_UNFROZEN = "channel.unfrozen" EVENT_TYPE_CHANNEL_UNMUTED = "channel.unmuted" @@ -261,6 +281,8 @@ EVENT_TYPE_EXPORT_BULK_IMAGE_MODERATION_SUCCESS = "export.bulk_image_moderation.success" EVENT_TYPE_EXPORT_CHANNELS_ERROR = "export.channels.error" EVENT_TYPE_EXPORT_CHANNELS_SUCCESS = "export.channels.success" +EVENT_TYPE_EXPORT_LABEL_RESULTS_ERROR = "export.label_results.error" +EVENT_TYPE_EXPORT_LABEL_RESULTS_SUCCESS = "export.label_results.success" EVENT_TYPE_EXPORT_MODERATION_LOGS_ERROR = "export.moderation_logs.error" EVENT_TYPE_EXPORT_MODERATION_LOGS_SUCCESS = "export.moderation_logs.success" EVENT_TYPE_EXPORT_REVIEW_QUEUE_ERROR = "export.review_queue.error" @@ -286,11 +308,14 @@ EVENT_TYPE_FEEDS_BOOKMARK_FOLDER_UPDATED = "feeds.bookmark_folder.updated" EVENT_TYPE_FEEDS_COMMENT_ADDED = "feeds.comment.added" EVENT_TYPE_FEEDS_COMMENT_DELETED = "feeds.comment.deleted" +EVENT_TYPE_FEEDS_COMMENT_FEEDBACK = "feeds.comment.feedback" EVENT_TYPE_FEEDS_COMMENT_REACTION_ADDED = "feeds.comment.reaction.added" EVENT_TYPE_FEEDS_COMMENT_REACTION_DELETED = "feeds.comment.reaction.deleted" EVENT_TYPE_FEEDS_COMMENT_REACTION_UPDATED = "feeds.comment.reaction.updated" EVENT_TYPE_FEEDS_COMMENT_RESTORED = "feeds.comment.restored" EVENT_TYPE_FEEDS_COMMENT_UPDATED = "feeds.comment.updated" +EVENT_TYPE_FEEDS_EXPORT_ERROR = "feeds.export.error" +EVENT_TYPE_FEEDS_EXPORT_SUCCESS = "feeds.export.success" EVENT_TYPE_FEEDS_FEED_CREATED = "feeds.feed.created" EVENT_TYPE_FEEDS_FEED_DELETED = "feeds.feed.deleted" EVENT_TYPE_FEEDS_FEED_UPDATED = "feeds.feed.updated" @@ -306,6 +331,8 @@ EVENT_TYPE_FEEDS_NOTIFICATION_FEED_UPDATED = "feeds.notification_feed.updated" EVENT_TYPE_FEEDS_STORIES_FEED_UPDATED = "feeds.stories_feed.updated" EVENT_TYPE_FLAG_UPDATED = "flag.updated" +EVENT_TYPE_IMPORT_ERROR = "import.error" +EVENT_TYPE_IMPORT_SUCCESS = "import.success" EVENT_TYPE_INGRESS_ERROR = "ingress.error" EVENT_TYPE_INGRESS_STARTED = "ingress.started" EVENT_TYPE_INGRESS_STOPPED = "ingress.stopped" @@ -331,6 +358,12 @@ EVENT_TYPE_NOTIFICATION_MARK_UNREAD = "notification.mark_unread" EVENT_TYPE_NOTIFICATION_REMINDER_DUE = "notification.reminder_due" EVENT_TYPE_NOTIFICATION_THREAD_MESSAGE_NEW = "notification.thread_message_new" +EVENT_TYPE_POLL_CLOSED = "poll.closed" +EVENT_TYPE_POLL_DELETED = "poll.deleted" +EVENT_TYPE_POLL_UPDATED = "poll.updated" +EVENT_TYPE_POLL_VOTE_CASTED = "poll.vote_casted" +EVENT_TYPE_POLL_VOTE_CHANGED = "poll.vote_changed" +EVENT_TYPE_POLL_VOTE_REMOVED = "poll.vote_removed" EVENT_TYPE_REACTION_DELETED = "reaction.deleted" EVENT_TYPE_REACTION_NEW = "reaction.new" EVENT_TYPE_REACTION_UPDATED = "reaction.updated" @@ -339,8 +372,11 @@ EVENT_TYPE_REMINDER_UPDATED = "reminder.updated" EVENT_TYPE_REVIEW_QUEUE_ITEM_NEW = "review_queue_item.new" EVENT_TYPE_REVIEW_QUEUE_ITEM_UPDATED = "review_queue_item.updated" +EVENT_TYPE_SCHEDULED_MESSAGE_FAILED = "scheduled_message.failed" +EVENT_TYPE_SCHEDULED_MESSAGE_SENT = "scheduled_message.sent" EVENT_TYPE_THREAD_UPDATED = "thread.updated" EVENT_TYPE_USER_BANNED = "user.banned" +EVENT_TYPE_USER_CLAIMED = "user.claimed" EVENT_TYPE_USER_DEACTIVATED = "user.deactivated" EVENT_TYPE_USER_DELETED = "user.deleted" EVENT_TYPE_USER_FLAGGED = "user.flagged" @@ -386,11 +422,11 @@ class UnknownEvent: """ type: str - created_at: datetime | None = None - raw: dict[str, Any] = field(default_factory=dict) + created_at: Optional[datetime] = None + raw: Dict[str, Any] = field(default_factory=dict) -def get_event_type(raw_event: bytes | str | dict[str, Any]) -> str: +def get_event_type(raw_event: Union[bytes, str, Dict[str, Any]]) -> str: """ Extract the event type from a raw webhook payload. @@ -412,7 +448,7 @@ def get_event_type(raw_event: bytes | str | dict[str, Any]) -> str: return "" -def parse_webhook_event(raw_event: bytes | str | dict[str, Any]) -> Any: +def parse_webhook_event(raw_event: Union[bytes, str, Dict[str, Any]]) -> Any: """ Deserialize a raw webhook payload into a typed event object. @@ -492,6 +528,7 @@ def _get_event_class(event_type: str): "call.recording_stopped": CallRecordingStoppedEvent, "call.rejected": CallRejectedEvent, "call.ring": CallRingEvent, + "call.ring_settled": CallRingSettledEvent, "call.rtmp_broadcast_failed": CallRtmpBroadcastFailedEvent, "call.rtmp_broadcast_started": CallRtmpBroadcastStartedEvent, "call.rtmp_broadcast_stopped": CallRtmpBroadcastStoppedEvent, @@ -513,10 +550,12 @@ def _get_event_class(event_type: str): "campaign.started": CampaignStartedEvent, "channel.created": ChannelCreatedEvent, "channel.deleted": ChannelDeletedEvent, + "channel.forked": ChannelForkedEvent, "channel.frozen": ChannelFrozenEvent, "channel.hidden": ChannelHiddenEvent, "channel.max_streak_changed": MaxStreakChangedEvent, "channel.muted": ChannelMutedEvent, + "channel.rewound": ChannelRewoundEvent, "channel.truncated": ChannelTruncatedEvent, "channel.unfrozen": ChannelUnFrozenEvent, "channel.unmuted": ChannelUnmutedEvent, @@ -529,6 +568,8 @@ def _get_event_class(event_type: str): "export.bulk_image_moderation.success": AsyncBulkImageModerationEvent, "export.channels.error": AsyncExportErrorEvent, "export.channels.success": AsyncExportChannelsEvent, + "export.label_results.error": AsyncExportErrorEvent, + "export.label_results.success": AsyncExportLabelResultsEvent, "export.moderation_logs.error": AsyncExportErrorEvent, "export.moderation_logs.success": AsyncExportModerationLogsEvent, "export.review_queue.error": AsyncExportErrorEvent, @@ -554,11 +595,14 @@ def _get_event_class(event_type: str): "feeds.bookmark_folder.updated": BookmarkFolderUpdatedEvent, "feeds.comment.added": CommentAddedEvent, "feeds.comment.deleted": CommentDeletedEvent, + "feeds.comment.feedback": CommentFeedbackEvent, "feeds.comment.reaction.added": CommentReactionAddedEvent, "feeds.comment.reaction.deleted": CommentReactionDeletedEvent, "feeds.comment.reaction.updated": CommentReactionUpdatedEvent, "feeds.comment.restored": CommentRestoredEvent, "feeds.comment.updated": CommentUpdatedEvent, + "feeds.export.error": AsyncExportErrorEvent, + "feeds.export.success": AsyncExportFeedsSuccessEvent, "feeds.feed.created": FeedCreatedEvent, "feeds.feed.deleted": FeedDeletedEvent, "feeds.feed.updated": FeedUpdatedEvent, @@ -574,6 +618,8 @@ def _get_event_class(event_type: str): "feeds.notification_feed.updated": NotificationFeedUpdatedEvent, "feeds.stories_feed.updated": StoriesFeedUpdatedEvent, "flag.updated": FlagUpdatedEvent, + "import.error": AsyncImportErrorEvent, + "import.success": AsyncImportSuccessEvent, "ingress.error": IngressErrorEvent, "ingress.started": IngressStartedEvent, "ingress.stopped": IngressStoppedEvent, @@ -599,6 +645,12 @@ def _get_event_class(event_type: str): "notification.mark_unread": NotificationMarkUnreadEvent, "notification.reminder_due": ReminderNotificationEvent, "notification.thread_message_new": NotificationThreadMessageNewEvent, + "poll.closed": PollClosedEvent, + "poll.deleted": PollDeletedEvent, + "poll.updated": PollUpdatedEvent, + "poll.vote_casted": PollVoteCastedEvent, + "poll.vote_changed": PollVoteChangedEvent, + "poll.vote_removed": PollVoteRemovedEvent, "reaction.deleted": ReactionDeletedEvent, "reaction.new": ReactionNewEvent, "reaction.updated": ReactionUpdatedEvent, @@ -607,8 +659,11 @@ def _get_event_class(event_type: str): "reminder.updated": ReminderUpdatedEvent, "review_queue_item.new": ReviewQueueItemNewEvent, "review_queue_item.updated": ReviewQueueItemUpdatedEvent, + "scheduled_message.failed": ScheduledMessageFailedEvent, + "scheduled_message.sent": ScheduledMessageSentEvent, "thread.updated": ThreadUpdatedEvent, "user.banned": UserBannedEvent, + "user.claimed": UserClaimedEvent, "user.deactivated": UserDeactivatedEvent, "user.deleted": UserDeletedEvent, "user.flagged": UserFlaggedEvent, @@ -628,7 +683,9 @@ def _get_event_class(event_type: str): return event_map.get(event_type) -def verify_webhook_signature(body: bytes | str, signature: str, secret: str) -> bool: +def verify_webhook_signature( + body: Union[bytes, str], signature: str, secret: str +) -> bool: """ Verify the HMAC-SHA256 signature of a webhook payload. @@ -793,9 +850,9 @@ def parse_event(payload: bytes) -> Any: ) from e -def _build_unknown_event(event_type: str, data: dict[str, Any]) -> UnknownEvent: +def _build_unknown_event(event_type: str, data: Dict[str, Any]) -> UnknownEvent: created_raw = data.get("created_at") - created: datetime | None = None + created: Optional[datetime] = None if isinstance(created_raw, str): try: # Accept "2026-05-08T00:00:00Z" and full ISO-8601 with offset. diff --git a/tests/assets/webhooks/_invalid/bad_base64/body.gz b/tests/assets/webhooks/_invalid/bad_base64/body.gz index 0cf7fcd587a08644490889f75ecc9a8c146ad300..4a7b657d04a0bd7abcc74c4aa13f2572408d2f82 100644 GIT binary patch literal 80 zcmb2|=3oGW{|x2~C;nF}l~fj_Dp@JzrWO|`rl;!VrIst{C?yxACYGe8#3z<0Ss9v} WTNqkem>3{HEi*%k#ZOIhpg{ns+YPpC WF)(y!h;jhx`u{)0;-{uLkOcrg%@?r% diff --git a/tests/assets/webhooks/_invalid/bad_sns_envelope/body.gz b/tests/assets/webhooks/_invalid/bad_sns_envelope/body.gz index 0cf7fcd587a08644490889f75ecc9a8c146ad300..4a7b657d04a0bd7abcc74c4aa13f2572408d2f82 100644 GIT binary patch literal 80 zcmb2|=3oGW{|x2~C;nF}l~fj_Dp@JzrWO|`rl;!VrIst{C?yxACYGe8#3z<0Ss9v} WTNqkem>3{HEi*%k#ZOIhpg{ns+YPpC WF)(y!h;jhx`u{)0;-{uLkOcrg%@?r% diff --git a/tests/assets/webhooks/_invalid/bad_sns_envelope/sqs_body.txt b/tests/assets/webhooks/_invalid/bad_sns_envelope/sqs_body.txt index a68b111d..2ee293d0 100644 --- a/tests/assets/webhooks/_invalid/bad_sns_envelope/sqs_body.txt +++ b/tests/assets/webhooks/_invalid/bad_sns_envelope/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/Vy0stV9JRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP//ZDj5KTcAAAA= \ No newline at end of file +H4sIAAAAAAAA/wA3AMj/eyJ0eXBlIjoibWVzc2FnZS5uZXciLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMAZDj5KTcAAAA= \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/empty_body/body.gz b/tests/assets/webhooks/_invalid/empty_body/body.gz index 1f0aab1d2342c4a03cc29a0a4632534dd8c2f1ee..0239669d57f6148035ad2dc4a6d54ae7db678e85 100644 GIT binary patch literal 20 Scmb2|=3oGW|I82?NCE&DbOE&h literal 23 Wcmb2|=3oGW|BMU_|NleS3=9A;W&^PR diff --git a/tests/assets/webhooks/_invalid/empty_body/sns_notification.txt b/tests/assets/webhooks/_invalid/empty_body/sns_notification.txt index 39da5fd2..7e51f3c1 100644 --- a/tests/assets/webhooks/_invalid/empty_body/sns_notification.txt +++ b/tests/assets/webhooks/_invalid/empty_body/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/wEAAP//AAAAAAAAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wMAAAAAAAAAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/empty_body/sqs_body.txt b/tests/assets/webhooks/_invalid/empty_body/sqs_body.txt index cc33db95..d0fc00c5 100644 --- a/tests/assets/webhooks/_invalid/empty_body/sqs_body.txt +++ b/tests/assets/webhooks/_invalid/empty_body/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/wEAAP//AAAAAAAAAAA= \ No newline at end of file +H4sIAAAAAAAA/wMAAAAAAAAAAAA= \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/malformed_json/body.gz b/tests/assets/webhooks/_invalid/malformed_json/body.gz index a2798f7b0e3229b983840bfd4e418134b0f9b0cc..d13ae0f0c376b5ed2cc15b84fb7930a5af99676b 100644 GIT binary patch literal 40 rcmb2|=3oGW{|x*LAO2V8<(DXwCFW$NC}b7q=P@%JxV`2hKTrVx?aU0& literal 39 rcmb2|=3oGW|EtcO)(_P1K6BD1@PyX6^UN#^4FCThxV`2hKTsY34-O9X diff --git a/tests/assets/webhooks/_invalid/malformed_json/sns_notification.txt b/tests/assets/webhooks/_invalid/malformed_json/sns_notification.txt index 72cee88e..52a1fe6c 100644 --- a/tests/assets/webhooks/_invalid/malformed_json/sns_notification.txt +++ b/tests/assets/webhooks/_invalid/malformed_json/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6rOyy9RKEvMyUxRyCrOzwMEAAD//8DbrPEPAAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wAPAPD/e25vdCB2YWxpZCBqc29uAwDA26zxDwAAAA==","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/malformed_json/sqs_body.txt b/tests/assets/webhooks/_invalid/malformed_json/sqs_body.txt index 99bad103..745eb0fd 100644 --- a/tests/assets/webhooks/_invalid/malformed_json/sqs_body.txt +++ b/tests/assets/webhooks/_invalid/malformed_json/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6rOyy9RKEvMyUxRyCrOzwMEAAD//8DbrPEPAAAA \ No newline at end of file +H4sIAAAAAAAA/wAPAPD/e25vdCB2YWxpZCBqc29uAwDA26zxDwAAAA== \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/missing_type/body.gz b/tests/assets/webhooks/_invalid/missing_type/body.gz index 1064bb8aa72d74d9903a2555698f526d5d8be8d3..9af86559bd2421aa14a463f11578fc6cd65cbac1 100644 GIT binary patch literal 59 zcmb2|=3oGW{|rhDcmG!_B^RY8mZYY{CzdE#8Je407+PAG7$86`GsB&#-P@IbdH~w% B58MC% literal 50 zcmb2|=3oGW|Et2h^t^m^JbgR;bpkgTnV4@k*s{gI(4is90jS{r|2tK?w<`fz0B3{{j#5ctZb52MYKoFoNl|HPEi=QSnMY>20}TcMRT&(b literal 87 zcmb2|=3oGW|Et2ZR_b_!ZVEc(tE=bd+YPpC oF)(yskX<_I$epGui>`>MuAa2$(v>I&peg_VFPeE|raO=Y07IxDnE(I) diff --git a/tests/assets/webhooks/_invalid/tampered_body/sns_notification.txt b/tests/assets/webhooks/_invalid/tampered_body/sns_notification.txt index 944ed940..6cb77a32 100644 --- a/tests/assets/webhooks/_invalid/tampered_body/sns_notification.txt +++ b/tests/assets/webhooks/_invalid/tampered_body/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/Vy0stV9JRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQAAdpZLE3ILUotQUJauSotLUWkAAAAD//6KZxJlHAAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wBHALj/eyJ0eXBlIjoibWVzc2FnZS5uZXciLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwLCJ0YW1wZXJlZCI6dHJ1ZX0DAKKZxJlHAAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/tampered_body/sqs_body.txt b/tests/assets/webhooks/_invalid/tampered_body/sqs_body.txt index 20783371..d337fbc0 100644 --- a/tests/assets/webhooks/_invalid/tampered_body/sqs_body.txt +++ b/tests/assets/webhooks/_invalid/tampered_body/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/Vy0stV9JRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQAAdpZLE3ILUotQUJauSotLUWkAAAAD//6KZxJlHAAAA \ No newline at end of file +H4sIAAAAAAAA/wBHALj/eyJ0eXBlIjoibWVzc2FnZS5uZXciLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwLCJ0YW1wZXJlZCI6dHJ1ZX0DAKKZxJlHAAAA \ No newline at end of file diff --git a/tests/assets/webhooks/_invalid/unknown_type/body.gz b/tests/assets/webhooks/_invalid/unknown_type/body.gz index bfb8d0b2d7d0088902f8e563c3a62a14bfec02c3..7ab2bc712ac0f3cb316e04121f84bf1f9a6af37a 100644 GIT binary patch literal 84 zcmb2|=3oGW{|wd)NB&nUl~fj_Dp@I&3{HEi;3pXHKa#&@ccRw-*5b literal 75 zcmb2|=3oGW|Et2ZR_b_!ZVJ*msqcB_7E3iQ(R^40P5?ey0P++<{8 azTIHU76U_vhA0Q1&j0@sOI7@hzC literal 78 zcmb2|=3oGW|Et2ZR_b_!ZVK}9J9F})wx6!vxijax{m*)P`UYMK^wRV4)$#Q0^w$a8 dWMpE#-C)ZW14D;~CmWs8BKLqn7UQ2YP?o4##s1hD{Jf*iL1 diff --git a/tests/assets/webhooks/call.session_started/sns_notification.txt b/tests/assets/webhooks/call.session_started/sns_notification.txt index a7304d59..c337b32a 100644 --- a/tests/assets/webhooks/call.session_started/sns_notification.txt +++ b/tests/assets/webhooks/call.session_started/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUkpOzMnRK04tLs7Mz4svLkksKklNUdJRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP//svazgUAAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wBAAL//eyJ0eXBlIjoiY2FsbC5zZXNzaW9uX3N0YXJ0ZWQiLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMAsvazgUAAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/call.session_started/sqs_body.txt b/tests/assets/webhooks/call.session_started/sqs_body.txt index d9b772b6..37e2a4a7 100644 --- a/tests/assets/webhooks/call.session_started/sqs_body.txt +++ b/tests/assets/webhooks/call.session_started/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUkpOzMnRK04tLs7Mz4svLkksKklNUdJRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP//svazgUAAAAA= \ No newline at end of file +H4sIAAAAAAAA/wBAAL//eyJ0eXBlIjoiY2FsbC5zZXNzaW9uX3N0YXJ0ZWQiLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMAsvazgUAAAAA= \ No newline at end of file diff --git a/tests/assets/webhooks/channel.created/body.gz b/tests/assets/webhooks/channel.created/body.gz index b1e49f36a4015b6b2837f7147efbfcd359b401d5..5f89f3900b80b71a201863685ad81e735a3e424e 100644 GIT binary patch literal 84 zcmb2|=3oGW{|wd)NB&nUl~fj_Dp@HdXC&t3rRL}*7o{eaq^2n8C_!2Ai6u%_hUVrL VhL#p41_)5g%%FBxa*H+4FaR8M7mNS^ literal 69 zcmb2|=3oGW|Et2ZR_b_!ZVK``=W*t=_t}fydS1Rdp1y&X0-H8H684_5hUe^AT^?Os WA0B}PVgd{d|NpDqmE2+t)C~Y!T^O7I diff --git a/tests/assets/webhooks/channel.created/sns_notification.txt b/tests/assets/webhooks/channel.created/sns_notification.txt index 24722a76..f2e3f073 100644 --- a/tests/assets/webhooks/channel.created/sns_notification.txt +++ b/tests/assets/webhooks/channel.created/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUkrOSMzLS83RSy5KTSxJTVHSUYKy4hNLlKwMzc0tDC0tTAwQoBYQAAD//ybdGbQ7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoiY2hhbm5lbC5jcmVhdGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DACbdGbQ7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/channel.created/sqs_body.txt b/tests/assets/webhooks/channel.created/sqs_body.txt index 277f057c..9153cb04 100644 --- a/tests/assets/webhooks/channel.created/sqs_body.txt +++ b/tests/assets/webhooks/channel.created/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUkrOSMzLS83RSy5KTSxJTVHSUYKy4hNLlKwMzc0tDC0tTAwQoBYQAAD//ybdGbQ7AAAA \ No newline at end of file +H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoiY2hhbm5lbC5jcmVhdGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DACbdGbQ7AAAA \ No newline at end of file diff --git a/tests/assets/webhooks/channel.deleted/body.gz b/tests/assets/webhooks/channel.deleted/body.gz index d820a7721949abd977a77b6604996bc92b97de59..c4024ec2b8129cb8f39191ff9f4c22a05363ba61 100644 GIT binary patch literal 84 zcmb2|=3oGW{|wd)NB&nUl~fj_Dp@HdXC&t3rRM0Rq~@fSq^2n8C?yxACIVUUi6u%_ ZhUVrLhL#p41_)5g%y53I;XiAjVE`g!7;XRn literal 75 zcmb2|=3oGW|Et2ZR_b_!ZVK``=W*t=_t}fyo@YIEJ$(Z&1$yau`RaK3cKYiCZZa}4 a-)^vFi-Dm-LzDwh=l}obw;KMl2C@M4HyeHc diff --git a/tests/assets/webhooks/channel.deleted/sns_notification.txt b/tests/assets/webhooks/channel.deleted/sns_notification.txt index 33f7e0a3..6bae70e8 100644 --- a/tests/assets/webhooks/channel.deleted/sns_notification.txt +++ b/tests/assets/webhooks/channel.deleted/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUkrOSMzLS83RS0nNSS1JTVHSUUouSk0sSU2JTyxRsjI0N7cwtLQwMUCAWkAAAAD//8+1Mf47AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoiY2hhbm5lbC5kZWxldGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAM+1Mf47AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/channel.deleted/sqs_body.txt b/tests/assets/webhooks/channel.deleted/sqs_body.txt index 951a19b9..1fd85e3f 100644 --- a/tests/assets/webhooks/channel.deleted/sqs_body.txt +++ b/tests/assets/webhooks/channel.deleted/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUkrOSMzLS83RS0nNSS1JTVHSUUouSk0sSU2JTyxRsjI0N7cwtLQwMUCAWkAAAAD//8+1Mf47AAAA \ No newline at end of file +H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoiY2hhbm5lbC5kZWxldGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAM+1Mf47AAAA \ No newline at end of file diff --git a/tests/assets/webhooks/channel.updated/body.gz b/tests/assets/webhooks/channel.updated/body.gz index d1f2f0ecd8bd1817e3594fbc3c4c793e15f08425..6f57f28308fe1a2d8e2ed046e9fe8542b5a8a097 100644 GIT binary patch literal 84 zcmb2|=3oGW{|wd)NB&nUl~fj_Dp@HdXC&t3rRM0B7NjJWq^2n8C?yxAf>`m1B}!I? Y=H?cLmKG)k2vEz+@JigN*cxaU03YiYfdBvi literal 72 zcmb2|=3oGW|Et2ZR_b_!ZVK``=W*t=_t}fux*nc7p1y&X0=@LSST{Zr_MWna=j>Ts Z9$j4@9)Sg70t^iQ|GyGm??aWR_)?RO%(Bq@<=O=_n-^r6!i7 gro< a+YPpCF)(y!h;jhx{Qo~{7w=7LAPWGP`56@e diff --git a/tests/assets/webhooks/message.deleted/sns_notification.txt b/tests/assets/webhooks/message.deleted/sns_notification.txt index bf62441f..83650e52 100644 --- a/tests/assets/webhooks/message.deleted/sns_notification.txt +++ b/tests/assets/webhooks/message.deleted/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/VS0nNSS1JTVHSUUouSk0sSU2JTyxRsjI0N7cwtLQwMUCAWkAAAAD//1q6Ddk7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoibWVzc2FnZS5kZWxldGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAFq6Ddk7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/message.deleted/sqs_body.txt b/tests/assets/webhooks/message.deleted/sqs_body.txt index 3696545c..c4db7eaf 100644 --- a/tests/assets/webhooks/message.deleted/sqs_body.txt +++ b/tests/assets/webhooks/message.deleted/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/VS0nNSS1JTVHSUUouSk0sSU2JTyxRsjI0N7cwtLQwMUCAWkAAAAD//1q6Ddk7AAAA \ No newline at end of file +H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoibWVzc2FnZS5kZWxldGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAFq6Ddk7AAAA \ No newline at end of file diff --git a/tests/assets/webhooks/message.new/body.gz b/tests/assets/webhooks/message.new/body.gz index 0cf7fcd587a08644490889f75ecc9a8c146ad300..4a7b657d04a0bd7abcc74c4aa13f2572408d2f82 100644 GIT binary patch literal 80 zcmb2|=3oGW{|x2~C;nF}l~fj_Dp@JzrWO|`rl;!VrIst{C?yxACYGe8#3z<0Ss9v} WTNqkem>3{HEi*%k#ZOIhpg{ns+YPpC WF)(y!h;jhx`u{)0;-{uLkOcrg%@?r% diff --git a/tests/assets/webhooks/message.new/sns_notification.txt b/tests/assets/webhooks/message.new/sns_notification.txt index f2a45a7c..72260439 100644 --- a/tests/assets/webhooks/message.new/sns_notification.txt +++ b/tests/assets/webhooks/message.new/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/Vy0stV9JRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP//ZDj5KTcAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA3AMj/eyJ0eXBlIjoibWVzc2FnZS5uZXciLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMAZDj5KTcAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/message.new/sqs_body.txt b/tests/assets/webhooks/message.new/sqs_body.txt index a68b111d..2ee293d0 100644 --- a/tests/assets/webhooks/message.new/sqs_body.txt +++ b/tests/assets/webhooks/message.new/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/Vy0stV9JRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP//ZDj5KTcAAAA= \ No newline at end of file +H4sIAAAAAAAA/wA3AMj/eyJ0eXBlIjoibWVzc2FnZS5uZXciLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMAZDj5KTcAAAA= \ No newline at end of file diff --git a/tests/assets/webhooks/message.updated/body.gz b/tests/assets/webhooks/message.updated/body.gz index 820f7deff271f3064d9a08a1bec01d76b766cdaf..6766f26263afa354ec485329d1d62bcec3318119 100644 GIT binary patch literal 84 zcmb2|=3oGW{|wd)NB&nUl~fj_Dp@JzrWO|`rl;za7NjJWq^2n8C?yxAf>`m1B}!I? Y=H?cLmKG)k2vEz+P%lvzVhuD503cfzKmY&$ literal 72 zcmb2|=3oGW|Et2ZR_b_!ZVEc(tE=bd<9}6K*TYlC(>L%^pqHK(>&8dI-c#1_oIR_{ YqpRz~Bd|bBfPvxv|9XkK5Nn_T05i)Lq5uE@ diff --git a/tests/assets/webhooks/message.updated/sns_notification.txt b/tests/assets/webhooks/message.updated/sns_notification.txt index 64d65174..410c0582 100644 --- a/tests/assets/webhooks/message.updated/sns_notification.txt +++ b/tests/assets/webhooks/message.updated/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/VKy1ISSxJTVHSUUouSgWx4hNLlKwMzc0tDC0tTAwQoBYQAAD//38YflQ7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoibWVzc2FnZS51cGRhdGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAH8YflQ7AAAA","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/message.updated/sqs_body.txt b/tests/assets/webhooks/message.updated/sqs_body.txt index 57c141de..5ea1218c 100644 --- a/tests/assets/webhooks/message.updated/sqs_body.txt +++ b/tests/assets/webhooks/message.updated/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUspNLS5OTE/VKy1ISSxJTVHSUUouSgWx4hNLlKwMzc0tDC0tTAwQoBYQAAD//38YflQ7AAAA \ No newline at end of file +H4sIAAAAAAAA/wA7AMT/eyJ0eXBlIjoibWVzc2FnZS51cGRhdGVkIiwiY3JlYXRlZF9hdCI6MTc3ODE5ODQwMDAwMDAwMDAwMH0DAH8YflQ7AAAA \ No newline at end of file diff --git a/tests/assets/webhooks/moderation.flagged/body.gz b/tests/assets/webhooks/moderation.flagged/body.gz index a57e8b30483dc04571dec3d74bf3cbfe7aaa316b..3fb8c314ee9cfbdf98e2f1503bd0a8e22133f396 100644 GIT binary patch literal 87 zcmb2|=3oGW{|t5v2medFK4()84w_mjb=?ynJ;$eLMYi0yi0%m~S`O Xvc3{HEi=RaWB-iJfd&Bpu{swd literal 71 zcmb2|=3oGW|Et2ZR_b_!ZVJ-U_0zrN?RDm~w{PI3KrcNnUmZ{1PJf-iO-3f>+YPpC WF)(y!h;jhx`v3p`v46(qKo$T(m>Adq diff --git a/tests/assets/webhooks/user.banned/sns_notification.txt b/tests/assets/webhooks/user.banned/sns_notification.txt index cdf09206..e8910365 100644 --- a/tests/assets/webhooks/user.banned/sns_notification.txt +++ b/tests/assets/webhooks/user.banned/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUiotTi3SS0rMy0tNUdJRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP///8b+MzcAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA3AMj/eyJ0eXBlIjoidXNlci5iYW5uZWQiLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMA/8b+MzcAAAA=","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/user.banned/sqs_body.txt b/tests/assets/webhooks/user.banned/sqs_body.txt index ba5f831c..25ac8bfd 100644 --- a/tests/assets/webhooks/user.banned/sqs_body.txt +++ b/tests/assets/webhooks/user.banned/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUiotTi3SS0rMy0tNUdJRSi5KTSxJTYlPLFGyMjQ3tzC0tDAxQIBaQAAAAP///8b+MzcAAAA= \ No newline at end of file +H4sIAAAAAAAA/wA3AMj/eyJ0eXBlIjoidXNlci5iYW5uZWQiLCJjcmVhdGVkX2F0IjoxNzc4MTk4NDAwMDAwMDAwMDAwfQMA/8b+MzcAAAA= \ No newline at end of file diff --git a/tests/assets/webhooks/user.unbanned/body.gz b/tests/assets/webhooks/user.unbanned/body.gz index 7231e9a87514117ed8cc1531dc5bffeb1976b045..bb9e2b43a605f77f0fae45375497a7c3ce12c3ba 100644 GIT binary patch literal 82 zcmb2|=3oGW{|uH4$NpCn Znwwh~T3VPGAV4iM!{m?KzgYr}0s!#67(@U7 literal 73 zcmb2|=3oGW|Et2ZR_b_!ZVJ-U_0zqieb(FS%xQ1mz)OK%dS1Rdp1z&_I)R&vOw6|% YY}sO9=+F@50Mz&Y|KyL`zgYrV0DmbO4FCWD diff --git a/tests/assets/webhooks/user.unbanned/sns_notification.txt b/tests/assets/webhooks/user.unbanned/sns_notification.txt index e2833d49..cfcd86f9 100644 --- a/tests/assets/webhooks/user.unbanned/sns_notification.txt +++ b/tests/assets/webhooks/user.unbanned/sns_notification.txt @@ -1 +1 @@ -{"Message":"H4sIAAAAAAAA/6pWKqksSFWyUiotTi3SK81LSszLS01R0lFKLkpNLElNiU8sUbIyNDe3MLS0MDFAgFpAAAAA//+T8bf2OQAAAA==","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file +{"Message":"H4sIAAAAAAAA/wA5AMb/eyJ0eXBlIjoidXNlci51bmJhbm5lZCIsImNyZWF0ZWRfYXQiOjE3NzgxOTg0MDAwMDAwMDAwMDB9AwCT8bf2OQAAAA==","MessageId":"00000000-0000-0000-0000-000000000000","Timestamp":"2026-05-08T00:00:00.000Z","TopicArn":"arn:aws:sns:us-east-1:000000000000:fixture-topic","Type":"Notification"} \ No newline at end of file diff --git a/tests/assets/webhooks/user.unbanned/sqs_body.txt b/tests/assets/webhooks/user.unbanned/sqs_body.txt index 1ca1f362..2b228e0d 100644 --- a/tests/assets/webhooks/user.unbanned/sqs_body.txt +++ b/tests/assets/webhooks/user.unbanned/sqs_body.txt @@ -1 +1 @@ -H4sIAAAAAAAA/6pWKqksSFWyUiotTi3SK81LSszLS01R0lFKLkpNLElNiU8sUbIyNDe3MLS0MDFAgFpAAAAA//+T8bf2OQAAAA== \ No newline at end of file +H4sIAAAAAAAA/wA5AMb/eyJ0eXBlIjoidXNlci51bmJhbm5lZCIsImNyZWF0ZWRfYXQiOjE3NzgxOTg0MDAwMDAwMDAwMDB9AwCT8bf2OQAAAA== \ No newline at end of file