moderation_api 1.0.0__py3-none-any.whl

moderation_api/resources/wordlist/words.py

@@ -0,0 +1,274 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ..._types import Body, Query, Headers, NotGiven, SequenceNotStr, not_given
+from ..._utils import maybe_transform, async_maybe_transform
+from ..._compat import cached_property
+from ..._resource import SyncAPIResource, AsyncAPIResource
+from ..._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from ..._base_client import make_request_options
+from ...types.wordlist import word_add_params, word_remove_params
+from ...types.wordlist.word_add_response import WordAddResponse
+from ...types.wordlist.word_remove_response import WordRemoveResponse
+
+__all__ = ["WordsResource", "AsyncWordsResource"]
+
+
+class WordsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> WordsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/moderation-api/sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return WordsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> WordsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/moderation-api/sdk-python#with_streaming_response
+        """
+        return WordsResourceWithStreamingResponse(self)
+
+    def add(
+        self,
+        id: str,
+        *,
+        words: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WordAddResponse:
+        """
+        Add words to an existing wordlist
+
+        Args:
+          id: ID of the wordlist to add words to
+
+          words: Array of words to add to the wordlist. Duplicate words will be ignored.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._post(
+            f"/wordlist/{id}/words",
+            body=maybe_transform({"words": words}, word_add_params.WordAddParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WordAddResponse,
+        )
+
+    def remove(
+        self,
+        id: str,
+        *,
+        words: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WordRemoveResponse:
+        """
+        Remove words from an existing wordlist
+
+        Args:
+          id: ID of the wordlist to remove words from
+
+          words: Array of words to remove from the wordlist
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._delete(
+            f"/wordlist/{id}/words",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=maybe_transform({"words": words}, word_remove_params.WordRemoveParams),
+            ),
+            cast_to=WordRemoveResponse,
+        )
+
+
+class AsyncWordsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncWordsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/moderation-api/sdk-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncWordsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncWordsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/moderation-api/sdk-python#with_streaming_response
+        """
+        return AsyncWordsResourceWithStreamingResponse(self)
+
+    async def add(
+        self,
+        id: str,
+        *,
+        words: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WordAddResponse:
+        """
+        Add words to an existing wordlist
+
+        Args:
+          id: ID of the wordlist to add words to
+
+          words: Array of words to add to the wordlist. Duplicate words will be ignored.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._post(
+            f"/wordlist/{id}/words",
+            body=await async_maybe_transform({"words": words}, word_add_params.WordAddParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=WordAddResponse,
+        )
+
+    async def remove(
+        self,
+        id: str,
+        *,
+        words: SequenceNotStr[str],
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> WordRemoveResponse:
+        """
+        Remove words from an existing wordlist
+
+        Args:
+          id: ID of the wordlist to remove words from
+
+          words: Array of words to remove from the wordlist
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._delete(
+            f"/wordlist/{id}/words",
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                query=await async_maybe_transform({"words": words}, word_remove_params.WordRemoveParams),
+            ),
+            cast_to=WordRemoveResponse,
+        )
+
+
+class WordsResourceWithRawResponse:
+    def __init__(self, words: WordsResource) -> None:
+        self._words = words
+
+        self.add = to_raw_response_wrapper(
+            words.add,
+        )
+        self.remove = to_raw_response_wrapper(
+            words.remove,
+        )
+
+
+class AsyncWordsResourceWithRawResponse:
+    def __init__(self, words: AsyncWordsResource) -> None:
+        self._words = words
+
+        self.add = async_to_raw_response_wrapper(
+            words.add,
+        )
+        self.remove = async_to_raw_response_wrapper(
+            words.remove,
+        )
+
+
+class WordsResourceWithStreamingResponse:
+    def __init__(self, words: WordsResource) -> None:
+        self._words = words
+
+        self.add = to_streamed_response_wrapper(
+            words.add,
+        )
+        self.remove = to_streamed_response_wrapper(
+            words.remove,
+        )
+
+
+class AsyncWordsResourceWithStreamingResponse:
+    def __init__(self, words: AsyncWordsResource) -> None:
+        self._words = words
+
+        self.add = async_to_streamed_response_wrapper(
+            words.add,
+        )
+        self.remove = async_to_streamed_response_wrapper(
+            words.remove,
+        )

moderation_api/types/__init__.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .action_list_params import ActionListParams as ActionListParams
+from .author_list_params import AuthorListParams as AuthorListParams
+from .action_create_params import ActionCreateParams as ActionCreateParams
+from .action_list_response import ActionListResponse as ActionListResponse
+from .action_update_params import ActionUpdateParams as ActionUpdateParams
+from .auth_create_response import AuthCreateResponse as AuthCreateResponse
+from .author_create_params import AuthorCreateParams as AuthorCreateParams
+from .author_list_response import AuthorListResponse as AuthorListResponse
+from .author_update_params import AuthorUpdateParams as AuthorUpdateParams
+from .account_list_response import AccountListResponse as AccountListResponse
+from .content_submit_params import ContentSubmitParams as ContentSubmitParams
+from .action_create_response import ActionCreateResponse as ActionCreateResponse
+from .action_delete_response import ActionDeleteResponse as ActionDeleteResponse
+from .action_update_response import ActionUpdateResponse as ActionUpdateResponse
+from .auth_retrieve_response import AuthRetrieveResponse as AuthRetrieveResponse
+from .author_create_response import AuthorCreateResponse as AuthorCreateResponse
+from .author_delete_response import AuthorDeleteResponse as AuthorDeleteResponse
+from .author_update_response import AuthorUpdateResponse as AuthorUpdateResponse
+from .queue_get_stats_params import QueueGetStatsParams as QueueGetStatsParams
+from .wordlist_list_response import WordlistListResponse as WordlistListResponse
+from .wordlist_update_params import WordlistUpdateParams as WordlistUpdateParams
+from .content_submit_response import ContentSubmitResponse as ContentSubmitResponse
+from .queue_retrieve_response import QueueRetrieveResponse as QueueRetrieveResponse
+from .action_retrieve_response import ActionRetrieveResponse as ActionRetrieveResponse
+from .author_retrieve_response import AuthorRetrieveResponse as AuthorRetrieveResponse
+from .queue_get_stats_response import QueueGetStatsResponse as QueueGetStatsResponse
+from .wordlist_update_response import WordlistUpdateResponse as WordlistUpdateResponse
+from .wordlist_retrieve_response import WordlistRetrieveResponse as WordlistRetrieveResponse
+from .wordlist_get_embedding_status_response import (
+    WordlistGetEmbeddingStatusResponse as WordlistGetEmbeddingStatusResponse,
+)

moderation_api/types/account_list_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["AccountListResponse", "CurrentProject"]
+
+
+class CurrentProject(BaseModel):
+    id: str
+    """ID of the current project"""
+
+    name: str
+    """Name of the current project"""
+
+
+class AccountListResponse(BaseModel):
+    id: str
+    """ID of the account"""
+
+    paid_plan_name: str
+    """Name of the paid plan"""
+
+    remaining_quota: float
+    """Remaining quota"""
+
+    text_api_quota: float
+    """Text API quota"""
+
+    current_project: Optional[CurrentProject] = None

moderation_api/types/action_create_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__ = ["ActionCreateParams", "PossibleValue", "Webhook"]
+
+
+class ActionCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """The name of the action."""
+
+    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."""
+
+    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_create_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__ = ["ActionCreateResponse", "PossibleValue"]
+
+
+class PossibleValue(BaseModel):
+    value: str
+    """The value of the action."""
+
+
+class ActionCreateResponse(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/action_delete_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .._models import BaseModel
+
+__all__ = ["ActionDeleteResponse"]
+
+
+class ActionDeleteResponse(BaseModel):
+    id: str
+    """The ID of the action."""
+
+    deleted: bool
+    """Whether the action was deleted."""

moderation_api/types/action_list_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["ActionListParams"]
+
+
+class ActionListParams(TypedDict, total=False):
+    queue_id: Annotated[str, PropertyInfo(alias="queueId")]

moderation_api/types/action_list_response.py

@@ -0,0 +1,113 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "ActionListResponse",
+    "ActionListResponseItem",
+    "ActionListResponseItemPossibleValue",
+    "ActionListResponseItemWebhook",
+]
+
+
+class ActionListResponseItemPossibleValue(BaseModel):
+    value: str
+    """The value of the action."""
+
+
+class ActionListResponseItemWebhook(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 ActionListResponseItem(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[ActionListResponseItemPossibleValue] = 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[ActionListResponseItemWebhook]
+    """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."""
+
+
+ActionListResponse: TypeAlias = List[ActionListResponseItem]