moderation_api 1.0.0__tar.gz → 1.0.2__tar.gz

moderation_api-1.0.2/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.0.2"
+}

{moderation_api-1.0.0 → moderation_api-1.0.2}/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 1.0.2 (2025-12-09)
+
+Full Changelog: [v1.0.1...v1.0.2](https://github.com/moderation-api/sdk-python/compare/v1.0.1...v1.0.2)
+
+### Chores
+
+* add missing docstrings ([02bdf8f](https://github.com/moderation-api/sdk-python/commit/02bdf8ffdef877fdb38df5c8215f241c0af2936e))
+
+## 1.0.1 (2025-12-09)
+
+Full Changelog: [v1.0.0...v1.0.1](https://github.com/moderation-api/sdk-python/compare/v1.0.0...v1.0.1)
+
+### Bug Fixes
+
+* **types:** allow pyright to infer TypedDict types within SequenceNotStr ([36ea40a](https://github.com/moderation-api/sdk-python/commit/36ea40ac2b242cd53c8cd915befe809b65a13215))
+
+
+### Chores
+
+* update SDK settings ([1876999](https://github.com/moderation-api/sdk-python/commit/18769999773649b22146674569e8ba3ddf88f876))
+
 ## 1.0.0 (2025-12-06)
 
 Full Changelog: [v0.0.1...v1.0.0](https://github.com/moderation-api/sdk-python/compare/v0.0.1...v1.0.0)

{moderation_api-1.0.0 → moderation_api-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: moderation_api
-Version: 1.0.0
+Version: 1.0.2
 Summary: The official Python library for the moderation-api API
 Project-URL: Homepage, https://github.com/moderation-api/sdk-python
 Project-URL: Repository, https://github.com/moderation-api/sdk-python
@@ -51,13 +51,10 @@ The REST API documentation can be found on [docs.moderationapi.com](https://docs
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://git@github.com/moderation-api/sdk-python.git
+# install from PyPI
+pip install moderation_api
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install moderation_api`
-
 ## Usage
 
 The full API of this library can be found in [api.md](https://github.com/moderation-api/sdk-python/tree/main/api.md).
@@ -120,8 +117,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'moderation_api[aiohttp] @ git+ssh://git@github.com/moderation-api/sdk-python.git'
+# install from PyPI
+pip install moderation_api[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:

{moderation_api-1.0.0 → moderation_api-1.0.2}/README.md

@@ -16,13 +16,10 @@ The REST API documentation can be found on [docs.moderationapi.com](https://docs
 ## Installation
 
 ```sh
-# install from the production repo
-pip install git+ssh://git@github.com/moderation-api/sdk-python.git
+# install from PyPI
+pip install moderation_api
 ```
 
-> [!NOTE]
-> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install moderation_api`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -85,8 +82,8 @@ By default, the async client uses `httpx` for HTTP requests. However, for improv
 You can enable this by installing `aiohttp`:
 
 ```sh
-# install from the production repo
-pip install 'moderation_api[aiohttp] @ git+ssh://git@github.com/moderation-api/sdk-python.git'
+# install from PyPI
+pip install moderation_api[aiohttp]
 ```
 
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:

{moderation_api-1.0.0 → moderation_api-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "moderation_api"
-version = "1.0.0"
+version = "1.0.2"
 description = "The official Python library for the moderation-api API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/_types.py

@@ -243,6 +243,9 @@ _T_co = TypeVar("_T_co", covariant=True)
 if TYPE_CHECKING:
     # This works because str.__contains__ does not accept object (either in typeshed or at runtime)
     # https://github.com/hauntsaninja/useful_types/blob/5e9710f3875107d068e7679fd7fec9cfab0eff3b/useful_types/__init__.py#L285
+    #
+    # Note: index() and count() methods are intentionally omitted to allow pyright to properly
+    # infer TypedDict types when dict literals are used in lists assigned to SequenceNotStr.
     class SequenceNotStr(Protocol[_T_co]):
         @overload
         def __getitem__(self, index: SupportsIndex, /) -> _T_co: ...
@@ -251,8 +254,6 @@ if TYPE_CHECKING:
         def __contains__(self, value: object, /) -> bool: ...
         def __len__(self) -> int: ...
         def __iter__(self) -> Iterator[_T_co]: ...
-        def index(self, value: Any, start: int = 0, stop: int = ..., /) -> int: ...
-        def count(self, value: Any, /) -> int: ...
         def __reversed__(self) -> Iterator[_T_co]: ...
 else:
     # just point this to a normal `Sequence` at runtime to avoid having to special case

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "moderation_api"
-__version__ = "1.0.0"  # x-release-please-version
+__version__ = "1.0.2"  # x-release-please-version

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/actions/execute_execute_response.py

@@ -6,5 +6,7 @@ __all__ = ["ExecuteExecuteResponse"]
 
 
 class ExecuteExecuteResponse(BaseModel):
+    """Execution result"""
+
     success: bool
     """Whether the action was executed successfully"""

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_create_params.py

@@ -41,6 +41,11 @@ class AuthorCreateParams(TypedDict, total=False):
 
 
 class MetadataTyped(TypedDict, total=False):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool]
     """Whether the author's email is verified"""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_create_response.py

@@ -11,6 +11,8 @@ __all__ = ["AuthorCreateResponse", "Block", "Metadata", "Metrics", "RiskEvaluati
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_list_response.py

@@ -20,6 +20,8 @@ __all__ = [
 
 
 class AuthorBlock(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -28,6 +30,11 @@ class AuthorBlock(BaseModel):
 
 
 class AuthorMetadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -68,6 +75,8 @@ class AuthorMetrics(BaseModel):
 
 
 class AuthorRiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_retrieve_response.py

@@ -11,6 +11,8 @@ __all__ = ["AuthorRetrieveResponse", "Block", "Metadata", "Metrics", "RiskEvalua
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_update_params.py

@@ -38,6 +38,11 @@ class AuthorUpdateParams(TypedDict, total=False):
 
 
 class MetadataTyped(TypedDict, total=False):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool]
     """Whether the author's email is verified"""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/author_update_response.py

@@ -11,6 +11,8 @@ __all__ = ["AuthorUpdateResponse", "Block", "Metadata", "Metrics", "RiskEvaluati
 
 
 class Block(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -19,6 +21,11 @@ class Block(BaseModel):
 
 
 class Metadata(BaseModel):
+    """Additional metadata provided by your system.
+
+    We recommend including any relevant information that may assist in the moderation process.
+    """
+
     email_verified: Optional[bool] = None
     """Whether the author's email is verified"""
 
@@ -59,6 +66,8 @@ class Metrics(BaseModel):
 
 
 class RiskEvaluation(BaseModel):
+    """Risk assessment details, if available."""
+
     risk_level: Optional[float] = None
     """Calculated risk level based on more than 10 behavioral signals."""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/content_submit_params.py

@@ -85,6 +85,8 @@ class ContentSubmitParams(TypedDict, total=False):
 
 
 class ContentText(TypedDict, total=False):
+    """Text"""
+
     text: Required[str]
     """The content text"""
 
@@ -92,6 +94,8 @@ class ContentText(TypedDict, total=False):
 
 
 class ContentImage(TypedDict, total=False):
+    """Image"""
+
     type: Required[Literal["image"]]
 
     url: Required[str]
@@ -99,6 +103,8 @@ class ContentImage(TypedDict, total=False):
 
 
 class ContentVideo(TypedDict, total=False):
+    """Video"""
+
     type: Required[Literal["video"]]
 
     url: Required[str]
@@ -106,6 +112,8 @@ class ContentVideo(TypedDict, total=False):
 
 
 class ContentAudio(TypedDict, total=False):
+    """Audio"""
+
     type: Required[Literal["audio"]]
 
     url: Required[str]
@@ -113,6 +121,8 @@ class ContentAudio(TypedDict, total=False):
 
 
 class ContentObjectDataText(TypedDict, total=False):
+    """Text"""
+
     text: Required[str]
     """The content text"""
 
@@ -120,6 +130,8 @@ class ContentObjectDataText(TypedDict, total=False):
 
 
 class ContentObjectDataImage(TypedDict, total=False):
+    """Image"""
+
     type: Required[Literal["image"]]
 
     url: Required[str]
@@ -127,6 +139,8 @@ class ContentObjectDataImage(TypedDict, total=False):
 
 
 class ContentObjectDataVideo(TypedDict, total=False):
+    """Video"""
+
     type: Required[Literal["video"]]
 
     url: Required[str]
@@ -134,6 +148,8 @@ class ContentObjectDataVideo(TypedDict, total=False):
 
 
 class ContentObjectDataAudio(TypedDict, total=False):
+    """Audio"""
+
     type: Required[Literal["audio"]]
 
     url: Required[str]
@@ -146,6 +162,8 @@ ContentObjectData: TypeAlias = Union[
 
 
 class ContentObject(TypedDict, total=False):
+    """Object"""
+
     data: Required[Dict[str, ContentObjectData]]
     """Values in the object. Can be mixed content types."""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/content_submit_response.py

@@ -32,6 +32,8 @@ __all__ = [
 
 
 class AuthorBlock(BaseModel):
+    """Block or suspension details, if applicable. Null if the author is enabled."""
+
     reason: Optional[str] = None
     """The moderators reason why the author was blocked or suspended."""
 
@@ -48,6 +50,11 @@ class AuthorTrustLevel(BaseModel):
 
 
 class Author(BaseModel):
+    """The author of the content if your account has authors enabled.
+
+    Requires you to send authorId when submitting content.
+    """
+
     id: str
     """Author ID in Moderation API"""
 
@@ -64,6 +71,8 @@ class Author(BaseModel):
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemText(BaseModel):
+    """Text"""
+
     text: str
     """The content text"""
 
@@ -71,6 +80,8 @@ class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObj
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemImage(BaseModel):
+    """Image"""
+
     type: Literal["image"]
 
     url: str
@@ -78,6 +89,8 @@ class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObj
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemVideo(BaseModel):
+    """Video"""
+
     type: Literal["video"]
 
     url: str
@@ -85,6 +98,8 @@ class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObj
 
 
 class ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectContentItemAudio(BaseModel):
+    """Audio"""
+
     type: Literal["audio"]
 
     url: str
@@ -100,6 +115,8 @@ ContentModifiedModifiedNestedObjectContentContentModifiedModifiedNestedObjectCon
 
 
 class Content(BaseModel):
+    """Potentially modified content."""
+
     id: str
     """The unique identifier for the content.
 
@@ -119,6 +136,8 @@ class Content(BaseModel):
 
 
 class Evaluation(BaseModel):
+    """The evaluation of the content after running the channel policies."""
+
     flag_probability: float
     """The probability that the content should be flagged."""
 
@@ -136,6 +155,8 @@ class Evaluation(BaseModel):
 
 
 class InsightSentimentInsight(BaseModel):
+    """Sentiment insight"""
+
     id: Literal["sentiment"]
 
     probability: float
@@ -146,6 +167,8 @@ class InsightSentimentInsight(BaseModel):
 
 
 class InsightLanguageInsight(BaseModel):
+    """Language insight"""
+
     id: Literal["language"]
 
     probability: float
@@ -159,6 +182,8 @@ Insight: TypeAlias = Union[InsightSentimentInsight, InsightLanguageInsight]
 
 
 class Meta(BaseModel):
+    """Metadata about the moderation request"""
+
     channel_key: str
     """The unique key of the channel where the content was handled.
 
@@ -183,6 +208,8 @@ class PolicyClassifierOutputLabel(BaseModel):
 
 
 class PolicyClassifierOutput(BaseModel):
+    """Classifier policy."""
+
     id: str
     """The unique identifier for the classifier output."""
 
@@ -207,6 +234,8 @@ class PolicyEntityMatcherOutputMatch(BaseModel):
 
 
 class PolicyEntityMatcherOutput(BaseModel):
+    """Entity matcher policy."""
+
     id: str
 
     flagged: bool
@@ -224,6 +253,8 @@ Policy: TypeAlias = Union[PolicyClassifierOutput, PolicyEntityMatcherOutput]
 
 
 class Recommendation(BaseModel):
+    """The recommendation for the content based on the evaluation."""
+
     action: Literal["review", "allow", "reject"]
     """The action to take based on the recommendation"""
 

{moderation_api-1.0.0 → moderation_api-1.0.2}/src/moderation_api/types/wordlist_get_embedding_status_response.py

@@ -8,6 +8,8 @@ __all__ = ["WordlistGetEmbeddingStatusResponse"]
 
 
 class WordlistGetEmbeddingStatusResponse(BaseModel):
+    """Embedding status details"""
+
     progress: float
     """Percentage of words that have been embedded (0-100)"""
 

moderation_api-1.0.0/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-  ".": "1.0.0"
-}