moderation_api 1.0.0__py3-none-any.whl

moderation_api/types/action_retrieve_response.py

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ActionRetrieveResponse", "PossibleValue", "Webhook"]
+
+
+class PossibleValue(BaseModel):
+    value: str
+    """The value of the action."""
+
+
+class Webhook(BaseModel):
+    id: str
+    """The ID of the webhook."""
+
+    name: str
+    """The webhook's name, used to identify it in the dashboard"""
+
+    url: str
+    """The webhook's URL. We'll call this URL when the event occurs."""
+
+    description: Optional[str] = None
+    """The webhook's description"""
+
+    moderation_action_id: Optional[str] = FieldInfo(alias="moderationActionId", default=None)
+    """The ID of the moderation action to trigger the webhook on.
+
+    Only used for moderation action webhooks.
+    """
+
+
+class ActionRetrieveResponse(BaseModel):
+    id: str
+    """The ID of the action."""
+
+    built_in: Optional[bool] = FieldInfo(alias="builtIn", default=None)
+    """Whether the action is a built-in action or a custom one."""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """The date the action was created."""
+
+    filter_in_queue_ids: List[str] = FieldInfo(alias="filterInQueueIds")
+    """The IDs of the queues the action is available in."""
+
+    free_text: bool = FieldInfo(alias="freeText")
+    """
+    Whether the action allows any text to be entered as a value or if it must be one
+    of the possible values.
+    """
+
+    name: str
+    """The name of the action."""
+
+    position: Literal["ALL_QUEUES", "SOME_QUEUES", "HIDDEN"]
+    """
+    Show the action in all queues, selected queues or no queues (to use via API
+    only).
+    """
+
+    possible_values: List[PossibleValue] = FieldInfo(alias="possibleValues")
+    """The possible values of the action.
+
+    The user will be prompted to select one of these values when executing the
+    action.
+    """
+
+    queue_behaviour: Literal["REMOVE", "ADD", "NO_CHANGE"] = FieldInfo(alias="queueBehaviour")
+    """
+    Whether the action resolves and removes the item, unresolves and re-add it to
+    the queue, or does not change the resolve status.
+    """
+
+    value_required: bool = FieldInfo(alias="valueRequired")
+    """Whether the action requires a value to be executed."""
+
+    webhooks: List[Webhook]
+    """The action's webhooks."""
+
+    description: Optional[str] = None
+    """The description of the action."""
+
+    key: Optional[str] = None
+    """User defined key of the action."""
+
+    type: Optional[
+        Literal[
+            "AUTHOR_BLOCK",
+            "AUTHOR_BLOCK_TEMP",
+            "AUTHOR_UNBLOCK",
+            "AUTHOR_DELETE",
+            "AUTHOR_REPORT",
+            "AUTHOR_WARN",
+            "AUTHOR_CUSTOM",
+            "ITEM_REJECT",
+            "ITEM_ALLOW",
+            "ITEM_CUSTOM",
+        ]
+    ] = None
+    """The type of the action."""

moderation_api/types/action_update_params.py

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+
+__all__ = ["ActionUpdateParams", "PossibleValue", "Webhook"]
+
+
+class ActionUpdateParams(TypedDict, total=False):
+    built_in: Annotated[Optional[bool], PropertyInfo(alias="builtIn")]
+    """Whether the action is a built-in action or a custom one."""
+
+    description: Optional[str]
+    """The description of the action."""
+
+    filter_in_queue_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="filterInQueueIds")]
+    """The IDs of the queues the action is available in."""
+
+    free_text: Annotated[bool, PropertyInfo(alias="freeText")]
+    """
+    Whether the action allows any text to be entered as a value or if it must be one
+    of the possible values.
+    """
+
+    key: Optional[str]
+    """User defined key of the action."""
+
+    name: str
+    """The name of the action."""
+
+    position: Literal["ALL_QUEUES", "SOME_QUEUES", "HIDDEN"]
+    """
+    Show the action in all queues, selected queues or no queues (to use via API
+    only).
+    """
+
+    possible_values: Annotated[Iterable[PossibleValue], PropertyInfo(alias="possibleValues")]
+    """The possible values of the action.
+
+    The user will be prompted to select one of these values when executing the
+    action.
+    """
+
+    queue_behaviour: Annotated[Literal["REMOVE", "ADD", "NO_CHANGE"], PropertyInfo(alias="queueBehaviour")]
+    """
+    Whether the action resolves and removes the item, unresolves and re-add it to
+    the queue, or does not change the resolve status.
+    """
+
+    type: Optional[
+        Literal[
+            "AUTHOR_BLOCK",
+            "AUTHOR_BLOCK_TEMP",
+            "AUTHOR_UNBLOCK",
+            "AUTHOR_DELETE",
+            "AUTHOR_REPORT",
+            "AUTHOR_WARN",
+            "AUTHOR_CUSTOM",
+            "ITEM_REJECT",
+            "ITEM_ALLOW",
+            "ITEM_CUSTOM",
+        ]
+    ]
+    """The type of the action."""
+
+    value_required: Annotated[bool, PropertyInfo(alias="valueRequired")]
+    """Whether the action requires a value to be executed."""
+
+    webhooks: Iterable[Webhook]
+    """The action's webhooks."""
+
+
+class PossibleValue(TypedDict, total=False):
+    value: Required[str]
+    """The value of the action."""
+
+
+class Webhook(TypedDict, total=False):
+    name: Required[str]
+    """The webhook's name, used to identify it in the dashboard"""
+
+    url: Required[str]
+    """The webhook's URL. We'll call this URL when the event occurs."""
+
+    id: str
+    """ID of an existing webhook or undefined if this is a new webhook."""
+
+    description: Optional[str]
+    """The webhook's description"""

moderation_api/types/action_update_response.py

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["ActionUpdateResponse", "PossibleValue"]
+
+
+class PossibleValue(BaseModel):
+    value: str
+    """The value of the action."""
+
+
+class ActionUpdateResponse(BaseModel):
+    id: str
+    """The ID of the action."""
+
+    built_in: Optional[bool] = FieldInfo(alias="builtIn", default=None)
+    """Whether the action is a built-in action or a custom one."""
+
+    created_at: str = FieldInfo(alias="createdAt")
+    """The date the action was created."""
+
+    filter_in_queue_ids: List[str] = FieldInfo(alias="filterInQueueIds")
+    """The IDs of the queues the action is available in."""
+
+    free_text: bool = FieldInfo(alias="freeText")
+    """
+    Whether the action allows any text to be entered as a value or if it must be one
+    of the possible values.
+    """
+
+    name: str
+    """The name of the action."""
+
+    position: Literal["ALL_QUEUES", "SOME_QUEUES", "HIDDEN"]
+    """
+    Show the action in all queues, selected queues or no queues (to use via API
+    only).
+    """
+
+    possible_values: List[PossibleValue] = FieldInfo(alias="possibleValues")
+    """The possible values of the action.
+
+    The user will be prompted to select one of these values when executing the
+    action.
+    """
+
+    queue_behaviour: Literal["REMOVE", "ADD", "NO_CHANGE"] = FieldInfo(alias="queueBehaviour")
+    """
+    Whether the action resolves and removes the item, unresolves and re-add it to
+    the queue, or does not change the resolve status.
+    """
+
+    value_required: bool = FieldInfo(alias="valueRequired")
+    """Whether the action requires a value to be executed."""
+
+    description: Optional[str] = None
+    """The description of the action."""
+
+    key: Optional[str] = None
+    """User defined key of the action."""
+
+    type: Optional[
+        Literal[
+            "AUTHOR_BLOCK",
+            "AUTHOR_BLOCK_TEMP",
+            "AUTHOR_UNBLOCK",
+            "AUTHOR_DELETE",
+            "AUTHOR_REPORT",
+            "AUTHOR_WARN",
+            "AUTHOR_CUSTOM",
+            "ITEM_REJECT",
+            "ITEM_ALLOW",
+            "ITEM_CUSTOM",
+        ]
+    ] = None
+    """The type of the action."""

moderation_api/types/actions/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .execute_execute_params import ExecuteExecuteParams as ExecuteExecuteParams
+from .execute_execute_response import ExecuteExecuteResponse as ExecuteExecuteResponse
+from .execute_execute_by_id_params import ExecuteExecuteByIDParams as ExecuteExecuteByIDParams
+from .execute_execute_by_id_response import ExecuteExecuteByIDResponse as ExecuteExecuteByIDResponse

moderation_api/types/actions/execute_execute_by_id_params.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["ExecuteExecuteByIDParams"]
+
+
+class ExecuteExecuteByIDParams(TypedDict, total=False):
+    author_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="authorIds")]
+    """IDs of the authors to apply the action to"""
+
+    content_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="contentIds")]
+    """The IDs of the content items to perform the action on."""
+
+    queue_id: Annotated[str, PropertyInfo(alias="queueId")]
+    """The ID of the queue the action was performed from if any."""
+
+    value: str
+    """The value of the action. Useful to set a reason for the action etc."""

moderation_api/types/actions/execute_execute_by_id_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ExecuteExecuteByIDResponse"]
+
+
+class ExecuteExecuteByIDResponse(BaseModel):
+    action_id: str = FieldInfo(alias="actionId")
+    """The ID of the action."""
+
+    ids: List[str]
+    """The IDs of the content items."""
+
+    success: bool
+    """Action executed successfully."""

moderation_api/types/actions/execute_execute_params.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["ExecuteExecuteParams"]
+
+
+class ExecuteExecuteParams(TypedDict, total=False):
+    action_key: Required[Annotated[str, PropertyInfo(alias="actionKey")]]
+    """ID or key of the action to execute"""
+
+    author_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="authorIds")]
+    """IDs of the authors to apply the action to. Provide this or contentIds."""
+
+    content_ids: Annotated[SequenceNotStr[str], PropertyInfo(alias="contentIds")]
+    """IDs of the content items to apply the action to. Provide this or authorIds."""
+
+    duration: float
+    """Optional duration in milliseconds for actions with timeouts"""
+
+    queue_id: Annotated[str, PropertyInfo(alias="queueId")]
+    """Optional queue ID if the action is queue-specific"""
+
+    value: str
+    """Optional value to provide with the action"""

moderation_api/types/actions/execute_execute_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["ExecuteExecuteResponse"]
+
+
+class ExecuteExecuteResponse(BaseModel):
+    success: bool
+    """Whether the action was executed successfully"""

moderation_api/types/auth_create_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["AuthCreateResponse"]
+
+
+class AuthCreateResponse(BaseModel):
+    message: str
+    """Message of the authentication"""
+
+    project: str
+    """Name of the authenticated project"""
+
+    status: str
+    """Status of the authentication"""

moderation_api/types/auth_retrieve_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["AuthRetrieveResponse"]
+
+
+class AuthRetrieveResponse(BaseModel):
+    message: str
+    """Message of the authentication"""
+
+    status: str
+    """Status of the authentication"""

moderation_api/types/author_create_params.py

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Optional
+from typing_extensions import Required, TypeAlias, TypedDict
+
+__all__ = ["AuthorCreateParams", "Metadata"]
+
+
+class AuthorCreateParams(TypedDict, total=False):
+    external_id: Required[str]
+    """External ID of the user, typically the ID of the author in your database."""
+
+    email: Optional[str]
+    """Author email address"""
+
+    external_link: Optional[str]
+    """URL of the author's external profile"""
+
+    first_seen: float
+    """Timestamp when author first appeared"""
+
+    last_seen: float
+    """Timestamp of last activity"""
+
+    manual_trust_level: Optional[float]
+
+    metadata: Metadata
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the
+    moderation process.
+    """
+
+    name: Optional[str]
+    """Author name or identifier"""
+
+    profile_picture: Optional[str]
+    """URL of the author's profile picture"""
+
+
+class MetadataTyped(TypedDict, total=False):
+    email_verified: Optional[bool]
+    """Whether the author's email is verified"""
+
+    identity_verified: Optional[bool]
+    """Whether the author's identity is verified"""
+
+    is_paying_customer: Optional[bool]
+    """Whether the author is a paying customer"""
+
+    phone_verified: Optional[bool]
+    """Whether the author's phone number is verified"""
+
+
+Metadata: TypeAlias = Union[MetadataTyped, Dict[str, object]]

moderation_api/types/author_create_response.py

@@ -0,0 +1,120 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import TYPE_CHECKING, Dict, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["AuthorCreateResponse", "Block", "Metadata", "Metrics", "RiskEvaluation", "TrustLevel"]
+
+
+class Block(BaseModel):
+    reason: Optional[str] = None
+    """The moderators reason why the author was blocked or suspended."""
+
+    until: Optional[float] = None
+    """The timestamp until which they are blocked if the author is suspended."""
+
+
+class Metadata(BaseModel):
+    email_verified: Optional[bool] = None
+    """Whether the author's email is verified"""
+
+    identity_verified: Optional[bool] = None
+    """Whether the author's identity is verified"""
+
+    is_paying_customer: Optional[bool] = None
+    """Whether the author is a paying customer"""
+
+    phone_verified: Optional[bool] = None
+    """Whether the author's phone number is verified"""
+
+    if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]
+
+
+class Metrics(BaseModel):
+    flagged_content: float
+    """Number of flagged content pieces"""
+
+    total_content: float
+    """Total pieces of content"""
+
+    average_sentiment: Optional[float] = None
+    """Average sentiment score of content (-1 to 1).
+
+    Requires a sentiment model in your project.
+    """
+
+
+class RiskEvaluation(BaseModel):
+    risk_level: Optional[float] = None
+    """Calculated risk level based on more than 10 behavioral signals."""
+
+
+class TrustLevel(BaseModel):
+    level: float
+    """Author trust level (-1, 0, 1, 2, 3, or 4)"""
+
+    manual: bool
+    """True if the trust level was set manually by a moderator"""
+
+
+class AuthorCreateResponse(BaseModel):
+    id: str
+    """Author ID in Moderation API"""
+
+    block: Optional[Block] = None
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
+    first_seen: float
+    """Timestamp when author first appeared"""
+
+    last_seen: float
+    """Timestamp of last activity"""
+
+    metadata: Metadata
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the
+    moderation process.
+    """
+
+    metrics: Metrics
+
+    risk_evaluation: Optional[RiskEvaluation] = None
+    """Risk assessment details, if available."""
+
+    status: Literal["enabled", "suspended", "blocked"]
+    """Current author status"""
+
+    trust_level: TrustLevel
+
+    email: Optional[str] = None
+    """Author email address"""
+
+    external_id: Optional[str] = None
+    """The author's ID from your system"""
+
+    external_link: Optional[str] = None
+    """URL of the author's external profile"""
+
+    last_incident: Optional[float] = None
+    """Timestamp of last incident"""
+
+    name: Optional[str] = None
+    """Author name or identifier"""
+
+    profile_picture: Optional[str] = None
+    """URL of the author's profile picture"""

moderation_api/types/author_delete_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["AuthorDeleteResponse"]
+
+
+class AuthorDeleteResponse(BaseModel):
+    success: bool

moderation_api/types/author_list_params.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["AuthorListParams"]
+
+
+class AuthorListParams(TypedDict, total=False):
+    content_types: Annotated[str, PropertyInfo(alias="contentTypes")]
+
+    last_active_date: Annotated[str, PropertyInfo(alias="lastActiveDate")]
+
+    member_since_date: Annotated[str, PropertyInfo(alias="memberSinceDate")]
+
+    page_number: Annotated[float, PropertyInfo(alias="pageNumber")]
+    """Page number to fetch"""
+
+    page_size: Annotated[float, PropertyInfo(alias="pageSize")]
+    """Number of authors per page"""
+
+    sort_by: Annotated[
+        Literal[
+            "trustLevel",
+            "violationCount",
+            "reportCount",
+            "memberSince",
+            "lastActive",
+            "contentCount",
+            "flaggedContentRatio",
+            "averageSentiment",
+        ],
+        PropertyInfo(alias="sortBy"),
+    ]
+
+    sort_direction: Annotated[Literal["asc", "desc"], PropertyInfo(alias="sortDirection")]
+    """Sort direction"""