# Code generated by GetStream internal OpenAPI code generator. DO NOT EDIT. from getstream.base import BaseClient from getstream.common import telemetry from getstream.models import * from getstream.stream_response import StreamResponse from getstream.utils import build_query_param class ModerationRestClient(BaseClient): def __init__( self, api_key: str, base_url: str, timeout: float, token: str, user_agent: str = None, ): """ Initializes ModerationClient with BaseClient instance :param api_key: A string representing the client's API key :param base_url: A string representing the base uniform resource locator :param timeout: A number representing the time limit for a request :param token: A string instance representing the client's token :param user_agent: Optional custom user agent string """ super().__init__( api_key=api_key, base_url=base_url, timeout=timeout, token=token, user_agent=user_agent, ) @telemetry.operation_name("getstream.api.moderation.get_action_config") def get_action_config( self, queue_type: Optional[str] = None, entity_type: Optional[str] = None, exclude_defaults: Optional[bool] = None, only_defaults: Optional[bool] = None, 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, } ) return self.get( "/api/v2/moderation/action_config", GetActionConfigResponse, query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.upsert_action_config") def upsert_action_config( self, action: str, entity_type: str, order: int, description: Optional[str] = None, icon: Optional[str] = None, id: Optional[str] = None, queue_type: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[UpsertActionConfigResponse]: json = UpsertActionConfigRequest( action=action, entity_type=entity_type, order=order, description=description, icon=icon, id=id, queue_type=queue_type, user_id=user_id, custom=custom, user=user, ).to_dict() return self.post( "/api/v2/moderation/action_config", UpsertActionConfigResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.bulk_upsert_action_config") def bulk_upsert_action_config( self, action_configs: List[UpsertActionConfigItem], user_id: Optional[str] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[BulkUpsertActionConfigResponse]: json = BulkUpsertActionConfigRequest( action_configs=action_configs, user_id=user_id, user=user ).to_dict() return self.post( "/api/v2/moderation/action_config/bulk", BulkUpsertActionConfigResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.bulk_delete_action_config") def bulk_delete_action_config( self, ids: List[str], user_id: Optional[str] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[BulkDeleteActionConfigResponse]: json = BulkDeleteActionConfigRequest( ids=ids, user_id=user_id, user=user ).to_dict() return self.post( "/api/v2/moderation/action_config/bulk_delete", BulkDeleteActionConfigResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.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}) path_params = { "id": id, } return self.delete( "/api/v2/moderation/action_config/{id}", DeleteActionConfigResponse, query_params=query_params, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.insert_action_log") def insert_action_log( self, action_type: str, entity_creator_id: str, entity_id: str, entity_type: str, reason: Optional[str] = None, reporter_type: Optional[str] = None, reporter_user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, ) -> StreamResponse[InsertActionLogResponse]: json = InsertActionLogRequest( action_type=action_type, entity_creator_id=entity_creator_id, entity_id=entity_id, entity_type=entity_type, reason=reason, reporter_type=reporter_type, reporter_user_id=reporter_user_id, custom=custom, ).to_dict() return self.post( "/api/v2/moderation/action_logs", InsertActionLogResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.analyze") def analyze( self, 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, user: Optional[UserRequest] = None, ) -> StreamResponse[AnalyzeResponse]: json = AnalyzeRequest( 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, user=user, ).to_dict() return self.post("/api/v2/moderation/analyze", AnalyzeResponse, json=json) @telemetry.operation_name("getstream.api.moderation.appeal") def appeal( self, 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, user: Optional[UserRequest] = None, ) -> StreamResponse[AppealResponse]: json = AppealRequest( 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, user=user, ).to_dict() return self.post("/api/v2/moderation/appeal", AppealResponse, json=json) @telemetry.operation_name("getstream.api.moderation.get_appeal") def get_appeal(self, id: str) -> StreamResponse[GetAppealResponse]: path_params = { "id": id, } return self.get( "/api/v2/moderation/appeal/{id}", GetAppealResponse, path_params=path_params ) @telemetry.operation_name("getstream.api.moderation.query_appeals") def query_appeals( self, 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[QueryAppealsResponse]: json = QueryAppealsRequest( limit=limit, next=next, prev=prev, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post("/api/v2/moderation/appeals", QueryAppealsResponse, json=json) @telemetry.operation_name("getstream.api.moderation.bulk_action_appeals") def bulk_action_appeals( self, action_type: str, appeal_ids: List[str], user_id: Optional[str] = None, mark_reviewed: Optional[MarkReviewedRequestPayload] = None, reject_appeal: Optional[RejectAppealRequestPayload] = None, restore: Optional[RestoreActionRequestPayload] = None, unban: Optional[UnbanActionRequestPayload] = None, unblock: Optional[UnblockActionRequestPayload] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[BulkActionAppealsResponse]: json = BulkActionAppealsRequest( action_type=action_type, appeal_ids=appeal_ids, user_id=user_id, mark_reviewed=mark_reviewed, reject_appeal=reject_appeal, restore=restore, unban=unban, unblock=unblock, user=user, ).to_dict() return self.post( "/api/v2/moderation/appeals/bulk_action", BulkActionAppealsResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.ban") 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[DeleteMessages] = None, delete_reactions: Optional[bool] = None, ip_ban: Optional[bool] = None, reason: Optional[str] = None, shadow: Optional[bool] = None, timeout: Optional[int] = None, banned_by: Optional[UserRequest] = None, ) -> 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, timeout=timeout, banned_by=banned_by, ).to_dict() return self.post("/api/v2/moderation/ban", ModerationBanResponse, json=json) @telemetry.operation_name("getstream.api.moderation.bulk_image_moderation") def bulk_image_moderation( self, csv_file: str ) -> StreamResponse[BulkImageModerationResponse]: json = BulkImageModerationRequest(csv_file=csv_file).to_dict() return self.post( "/api/v2/moderation/bulk_image_moderation", BulkImageModerationResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.bypass") def bypass( self, enabled: bool, target_user_id: str ) -> StreamResponse[BypassResponse]: json = BypassRequest(enabled=enabled, target_user_id=target_user_id).to_dict() return self.post("/api/v2/moderation/bypass", BypassResponse, json=json) @telemetry.operation_name("getstream.api.moderation.check") def check( self, entity_creator_id: str, entity_id: str, entity_type: str, 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, user: Optional[UserRequest] = None, ) -> StreamResponse[CheckResponse]: json = CheckRequest( entity_creator_id=entity_creator_id, entity_id=entity_id, entity_type=entity_type, 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, user=user, ).to_dict() return self.post("/api/v2/moderation/check", CheckResponse, json=json) @telemetry.operation_name("getstream.api.moderation.check_s3_access") def check_s3_access( self, s3_url: Optional[str] = None ) -> StreamResponse[CheckS3AccessResponse]: json = CheckS3AccessRequest(s3_url=s3_url).to_dict() return self.post( "/api/v2/moderation/check_s3_access", CheckS3AccessResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.upsert_config") def upsert_config( self, key: str, _async: Optional[bool] = None, team: Optional[str] = None, user_id: Optional[str] = None, ai_audio_config: Optional[AIAudioConfigRequest] = None, ai_image_config: Optional[AIImageConfig] = None, ai_text_config: Optional[AITextConfig] = None, ai_video_config: Optional[AIVideoConfigRequest] = None, automod_platform_circumvention_config: Optional[ AutomodPlatformCircumventionConfig ] = None, automod_semantic_filters_config: Optional[AutomodSemanticFiltersConfig] = None, automod_toxicity_config: Optional[AutomodToxicityConfig] = None, 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, velocity_filter_config: Optional[VelocityFilterConfig] = None, video_call_rule_config: Optional[VideoCallRuleConfig] = None, ) -> StreamResponse[UpsertConfigResponse]: json = UpsertConfigRequest( key=key, _async=_async, team=team, user_id=user_id, ai_audio_config=ai_audio_config, ai_image_config=ai_image_config, ai_text_config=ai_text_config, ai_video_config=ai_video_config, automod_platform_circumvention_config=automod_platform_circumvention_config, automod_semantic_filters_config=automod_semantic_filters_config, automod_toxicity_config=automod_toxicity_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, velocity_filter_config=velocity_filter_config, video_call_rule_config=video_call_rule_config, ).to_dict() return self.post("/api/v2/moderation/config", UpsertConfigResponse, json=json) @telemetry.operation_name("getstream.api.moderation.delete_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}) path_params = { "key": key, } return self.delete( "/api/v2/moderation/config/{key}", DeleteModerationConfigResponse, query_params=query_params, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.get_config") def get_config( self, key: str, team: Optional[str] = None ) -> StreamResponse[GetConfigResponse]: query_params = build_query_param(**{"team": team}) path_params = { "key": key, } return self.get( "/api/v2/moderation/config/{key}", GetConfigResponse, query_params=query_params, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.query_moderation_configs") def query_moderation_configs( self, 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[QueryModerationConfigsResponse]: json = QueryModerationConfigsRequest( limit=limit, next=next, prev=prev, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post( "/api/v2/moderation/configs", QueryModerationConfigsResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.custom_check") def custom_check( self, entity_id: str, entity_type: str, flags: List[CustomCheckFlag], entity_creator_id: Optional[str] = None, user_id: Optional[str] = None, moderation_payload: Optional[ModerationPayloadRequest] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[CustomCheckResponse]: json = CustomCheckRequest( entity_id=entity_id, entity_type=entity_type, flags=flags, entity_creator_id=entity_creator_id, user_id=user_id, moderation_payload=moderation_payload, user=user, ).to_dict() return self.post( "/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, 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") def v2_query_templates( self, ) -> StreamResponse[QueryFeedModerationTemplatesResponse]: return self.get( "/api/v2/moderation/feeds_moderation_template", QueryFeedModerationTemplatesResponse, ) @telemetry.operation_name("getstream.api.moderation.v2_upsert_template") def v2_upsert_template( self, name: str, config: FeedsModerationTemplateConfigPayload ) -> StreamResponse[UpsertModerationTemplateResponse]: json = UpsertModerationTemplateRequest(name=name, config=config).to_dict() return self.post( "/api/v2/moderation/feeds_moderation_template", UpsertModerationTemplateResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.flag") def flag( self, entity_id: str, entity_type: str, entity_creator_id: Optional[str] = None, reason: Optional[str] = None, user_id: Optional[str] = None, custom: Optional[Dict[str, object]] = None, moderation_payload: Optional[ModerationPayload] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[FlagItemResponse]: json = FlagRequest( entity_id=entity_id, entity_type=entity_type, entity_creator_id=entity_creator_id, reason=reason, user_id=user_id, custom=custom, moderation_payload=moderation_payload, user=user, ).to_dict() return self.post("/api/v2/moderation/flag", FlagItemResponse, json=json) @telemetry.operation_name("getstream.api.moderation.get_flag_count") def get_flag_count( self, entity_creator_id: str, entity_type: Optional[str] = None ) -> StreamResponse[GetFlagCountResponse]: json = GetFlagCountRequest( entity_creator_id=entity_creator_id, entity_type=entity_type ).to_dict() return self.post( "/api/v2/moderation/flag_count", GetFlagCountResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.query_moderation_flags") def query_moderation_flags( self, limit: Optional[int] = None, next: Optional[str] = None, prev: Optional[str] = None, sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, ) -> StreamResponse[QueryModerationFlagsResponse]: json = QueryModerationFlagsRequest( limit=limit, next=next, prev=prev, sort=sort, filter=filter ).to_dict() return self.post( "/api/v2/moderation/flags", QueryModerationFlagsResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.labels") def labels( self, content: str, category: Optional[str] = None, content_id: Optional[str] = None, content_type: Optional[str] = None, dry_run: Optional[bool] = None, policy: Optional[str] = None, user_id: Optional[str] = None, ) -> StreamResponse[LabelsResponse]: json = LabelsRequest( content=content, category=category, content_id=content_id, content_type=content_type, dry_run=dry_run, policy=policy, user_id=user_id, ).to_dict() return self.post("/api/v2/moderation/labels", LabelsResponse, json=json) @telemetry.operation_name("getstream.api.moderation.query_label_results") def query_label_results( self, 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[QueryLabelResultsResponse]: json = QueryLabelResultsRequest( limit=limit, next=next, prev=prev, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post( "/api/v2/moderation/labels/results", QueryLabelResultsResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.query_moderation_logs") def query_moderation_logs( self, 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[QueryModerationLogsResponse]: json = QueryModerationLogsRequest( limit=limit, next=next, prev=prev, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post( "/api/v2/moderation/logs", QueryModerationLogsResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.upsert_moderation_rule") def upsert_moderation_rule( self, name: str, rule_type: str, cooldown_period: Optional[str] = None, description: Optional[str] = None, enabled: Optional[bool] = None, logic: Optional[str] = None, team: Optional[str] = None, user_id: Optional[str] = None, action_sequences: Optional[List[CallRuleActionSequence]] = None, conditions: Optional[List[RuleBuilderCondition]] = None, config_keys: Optional[List[str]] = None, groups: Optional[List[RuleBuilderConditionGroup]] = None, action: Optional[RuleBuilderAction] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[UpsertModerationRuleResponse]: json = UpsertModerationRuleRequest( name=name, rule_type=rule_type, cooldown_period=cooldown_period, description=description, enabled=enabled, logic=logic, team=team, user_id=user_id, action_sequences=action_sequences, conditions=conditions, config_keys=config_keys, groups=groups, action=action, user=user, ).to_dict() return self.post( "/api/v2/moderation/moderation_rule", UpsertModerationRuleResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.delete_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}) path_params = { "id": id, } return self.delete( "/api/v2/moderation/moderation_rule/{id}", DeleteModerationRuleResponse, query_params=query_params, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.get_moderation_rule") def get_moderation_rule(self, id: str) -> StreamResponse[GetModerationRuleResponse]: path_params = { "id": id, } return self.get( "/api/v2/moderation/moderation_rule/{id}", GetModerationRuleResponse, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.query_moderation_rules") def query_moderation_rules( self, 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[QueryModerationRulesResponse]: json = QueryModerationRulesRequest( limit=limit, next=next, prev=prev, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post( "/api/v2/moderation/moderation_rules", QueryModerationRulesResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.mute") def mute( self, target_ids: List[str], timeout: Optional[int] = None, user_id: Optional[str] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[MuteResponse]: json = MuteRequest( target_ids=target_ids, timeout=timeout, user_id=user_id, user=user ).to_dict() return self.post("/api/v2/moderation/mute", MuteResponse, json=json) @telemetry.operation_name("getstream.api.moderation.get_policy_test_run") def get_policy_test_run(self, id: str) -> StreamResponse[PolicyTestRunResponse]: path_params = { "id": id, } return self.get( "/api/v2/moderation/policy_tests/runs/{id}", PolicyTestRunResponse, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.list_policy_test_sets") 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, query_params=query_params, ) @telemetry.operation_name("getstream.api.moderation.create_policy_test_set") def create_policy_test_set( self, name: str, config_key: Optional[str] = None, mode: Optional[str] = None, team: Optional[str] = None, rows: Optional[List[PolicyTestRow]] = None, seed: Optional[PolicyTestSeedSpec] = None, ) -> StreamResponse[PolicyTestSetResponse]: json = CreatePolicyTestSetRequest( name=name, config_key=config_key, mode=mode, team=team, rows=rows, seed=seed ).to_dict() return self.post( "/api/v2/moderation/policy_tests/sets", PolicyTestSetResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.delete_policy_test_set") def delete_policy_test_set(self, id: str) -> StreamResponse[Response]: path_params = { "id": id, } return self.delete( "/api/v2/moderation/policy_tests/sets/{id}", Response, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.get_policy_test_set") def get_policy_test_set(self, id: str) -> StreamResponse[PolicyTestSetResponse]: path_params = { "id": id, } return self.get( "/api/v2/moderation/policy_tests/sets/{id}", PolicyTestSetResponse, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.start_policy_test_run") def start_policy_test_run(self, id: str) -> StreamResponse[PolicyTestRunResponse]: path_params = { "id": id, } return self.post( "/api/v2/moderation/policy_tests/sets/{id}/runs", PolicyTestRunResponse, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.list_queues") def list_queues( self, user_id: Optional[str] = None ) -> StreamResponse[ListQueuesResponse]: query_params = build_query_param(**{"user_id": user_id}) return self.get( "/api/v2/moderation/queues", ListQueuesResponse, query_params=query_params ) @telemetry.operation_name("getstream.api.moderation.create_queue") def create_queue( self, name: str, type: str, description: Optional[str] = None, user_id: Optional[str] = None, sort: Optional[List[Dict[str, object]]] = None, filters: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[QueueResponse]: json = CreateQueueRequest( name=name, type=type, description=description, user_id=user_id, sort=sort, filters=filters, user=user, ).to_dict() return self.post("/api/v2/moderation/queues", QueueResponse, json=json) @telemetry.operation_name("getstream.api.moderation.get_queue") def get_queue( self, id: str, user_id: Optional[str] = None ) -> StreamResponse[QueueResponse]: query_params = build_query_param(**{"user_id": user_id}) path_params = { "id": id, } return self.get( "/api/v2/moderation/queues/{id}", QueueResponse, query_params=query_params, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.update_queue") def update_queue( self, id: str, description: Optional[str] = None, name: Optional[str] = None, user_id: Optional[str] = None, sort: Optional[List[Dict[str, object]]] = None, filters: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[QueueResponse]: path_params = { "id": id, } json = UpdateQueueRequest( description=description, name=name, user_id=user_id, sort=sort, filters=filters, user=user, ).to_dict() return self.patch( "/api/v2/moderation/queues/{id}", QueueResponse, path_params=path_params, json=json, ) @telemetry.operation_name("getstream.api.moderation.delete_queue") def delete_queue( self, id: str, user_id: Optional[str] = None, user: Optional[UserRequest] = None ) -> StreamResponse[QueueResponse]: path_params = { "id": id, } json = DeleteQueueRequest(user_id=user_id, user=user).to_dict() return self.post( "/api/v2/moderation/queues/{id}/delete", QueueResponse, path_params=path_params, 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, exclude_default_action_config: Optional[bool] = None, limit: Optional[int] = None, lock_count: Optional[int] = None, lock_duration: Optional[int] = None, lock_items: Optional[bool] = None, next: Optional[str] = None, prev: Optional[str] = None, stats_only: Optional[bool] = None, user_id: Optional[str] = None, sort: Optional[List[SortParamRequest]] = None, filter: Optional[Dict[str, object]] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[QueryReviewQueueResponse]: json = QueryReviewQueueRequest( exclude_default_action_config=exclude_default_action_config, limit=limit, lock_count=lock_count, lock_duration=lock_duration, lock_items=lock_items, next=next, prev=prev, stats_only=stats_only, user_id=user_id, sort=sort, filter=filter, user=user, ).to_dict() return self.post( "/api/v2/moderation/review_queue", QueryReviewQueueResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.get_review_queue_item") def get_review_queue_item( self, id: str ) -> StreamResponse[GetReviewQueueItemResponse]: path_params = { "id": id, } return self.get( "/api/v2/moderation/review_queue/{id}", GetReviewQueueItemResponse, path_params=path_params, ) @telemetry.operation_name("getstream.api.moderation.get_setup_session") def get_setup_session(self) -> StreamResponse[GetSetupSessionResponse]: return self.get("/api/v2/moderation/setup", GetSetupSessionResponse) @telemetry.operation_name("getstream.api.moderation.upsert_setup_session") def upsert_setup_session( self, current_step: SetupStep, status: SetupStatus, setup_data: Optional[Dict[str, object]] = None, ) -> StreamResponse[UpsertSetupSessionResponse]: json = UpsertSetupSessionRequest( current_step=current_step, status=status, setup_data=setup_data ).to_dict() return self.post( "/api/v2/moderation/setup", UpsertSetupSessionResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.submit_action") def submit_action( self, action_type: str, appeal_id: Optional[str] = None, item_id: Optional[str] = None, user_id: Optional[str] = None, ban: Optional[BanActionRequestPayload] = None, block: Optional[BlockActionRequestPayload] = None, bypass: Optional[BypassActionRequest] = None, custom: Optional[CustomActionRequestPayload] = None, 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, escalate: Optional[EscalatePayload] = None, flag: Optional[FlagRequest] = None, mark_reviewed: Optional[MarkReviewedRequestPayload] = None, reject_appeal: Optional[RejectAppealRequestPayload] = None, restore: Optional[RestoreActionRequestPayload] = None, shadow_block: Optional[ShadowBlockActionRequestPayload] = None, unban: Optional[UnbanActionRequestPayload] = None, unblock: Optional[UnblockActionRequestPayload] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[SubmitActionResponse]: json = SubmitActionRequest( action_type=action_type, appeal_id=appeal_id, item_id=item_id, user_id=user_id, ban=ban, block=block, bypass=bypass, custom=custom, 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, escalate=escalate, flag=flag, mark_reviewed=mark_reviewed, reject_appeal=reject_appeal, restore=restore, shadow_block=shadow_block, unban=unban, unblock=unblock, user=user, ).to_dict() return self.post( "/api/v2/moderation/submit_action", SubmitActionResponse, json=json ) @telemetry.operation_name("getstream.api.moderation.submit_moderation_feedback") def submit_moderation_feedback( self, 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( 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", SubmitModerationFeedbackResponse, json=json, ) @telemetry.operation_name("getstream.api.moderation.unban") def unban( self, target_user_id: str, channel_cid: Optional[str] = None, created_by: Optional[str] = None, unbanned_by_id: Optional[str] = None, 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, } ) json = UnbanRequest( unbanned_by_id=unbanned_by_id, unbanned_by=unbanned_by ).to_dict() return self.post( "/api/v2/moderation/unban", UnbanResponse, query_params=query_params, json=json, ) @telemetry.operation_name("getstream.api.moderation.unmute") def unmute( self, target_ids: List[str], user_id: Optional[str] = None, user: Optional[UserRequest] = None, ) -> StreamResponse[UnmuteResponse]: json = UnmuteRequest( target_ids=target_ids, user_id=user_id, user=user ).to_dict() return self.post("/api/v2/moderation/unmute", UnmuteResponse, json=json)