devrev-Python-SDK 2.8.0__py3-none-any.whl → 2.9.0__py3-none-any.whl

devrev/models/articles.py

@@ -9,9 +9,11 @@ from typing import Any
 from pydantic import Field
 
 from devrev.models.base import (
+    CustomSchemaSpec,
     DevRevBaseModel,
     DevRevResponseModel,
     PaginatedResponse,
+    SetTagWithValue,
     UserSummary,
 )
 
@@ -22,6 +24,74 @@ class ArticleStatus(StrEnum):
     DRAFT = "draft"
     PUBLISHED = "published"
     ARCHIVED = "archived"
+    REVIEW_NEEDED = "review_needed"
+
+
+class ArticleAccessLevel(StrEnum):
+    """Article access level enumeration."""
+
+    EXTERNAL = "external"
+    INTERNAL = "internal"
+    PRIVATE = "private"
+    PUBLIC = "public"
+    RESTRICTED = "restricted"
+
+
+class ArticleType(StrEnum):
+    """Article type enumeration."""
+
+    ARTICLE = "article"
+    CONTENT_BLOCK = "content_block"
+    PAGE = "page"
+
+
+class ArticleContentFormat(StrEnum):
+    """Article content format enumeration."""
+
+    DRDFV2 = "drdfv2"
+    RT = "rt"
+
+
+class CursorMode(StrEnum):
+    """Cursor pagination direction."""
+
+    AFTER = "after"
+    BEFORE = "before"
+
+
+class ArticleScope(DevRevResponseModel):
+    """Scope/visibility level of an article.
+
+    Values observed from the API:
+    - ``{"id": 1, "label": "internal", "ordinal": 1}``
+    - ``{"id": 2, "label": "external", "ordinal": 2}``
+    """
+
+    id: int = Field(..., description="Scope numeric ID (1=internal, 2=external)")
+    label: str | None = Field(default=None, description="Human-readable label")
+    ordinal: int | None = Field(default=None, description="Sort ordinal")
+
+
+class ArticleTagSummary(DevRevResponseModel):
+    """Tag summary as returned within an article's ``tags`` array."""
+
+    id: str = Field(..., description="Tag DON ID")
+    name: str | None = Field(default=None, description="Tag name")
+    display_id: str | None = Field(default=None, description="Tag display ID")
+
+
+class ArticleTagWithValue(DevRevResponseModel):
+    """Tag entry on an article, wrapping the tag summary with an optional value."""
+
+    tag: ArticleTagSummary = Field(..., description="Tag details")
+    value: str | None = Field(default=None, description="Optional tag value")
+
+
+class ArticleParentSummary(DevRevResponseModel):
+    """Summary of a parent directory (collection) for an article."""
+
+    id: str = Field(..., description="Directory DON ID")
+    display_id: str | None = Field(default=None, description="Display ID")
 
 
 class Article(DevRevResponseModel):
@@ -36,6 +106,7 @@ class Article(DevRevResponseModel):
     title: str = Field(..., description="Article title")
     description: str | None = Field(default=None, description="Article description/body")
     status: ArticleStatus | None = Field(default=None, description="Article status")
+    article_type: str | None = Field(default=None, description="Article type (article, page, etc.)")
     authored_by: list[UserSummary] | None = Field(
         default=None, description="Authors of the article (API returns array, not single object)"
     )
@@ -45,6 +116,19 @@ class Article(DevRevResponseModel):
     resource: dict[str, Any] | None = Field(
         default=None, description="Resource configuration including artifact references"
     )
+    applies_to_parts: list[dict[str, Any]] | None = Field(
+        default=None, description="Parts this article applies to"
+    )
+    scope: ArticleScope | None = Field(
+        default=None, description="Visibility scope (internal/external)"
+    )
+    tags: list[ArticleTagWithValue] | None = Field(
+        default=None, description="Tags applied to the article"
+    )
+    parent: ArticleParentSummary | None = Field(
+        default=None, description="Parent directory/collection"
+    )
+    language: str | None = Field(default=None, description="Language code (e.g., 'en')")
 
 
 class ArticleSummary(DevRevResponseModel):
@@ -67,8 +151,19 @@ class ArticleWithContent(DevRevResponseModel):
     content_version: str | None = Field(default=None, description="Artifact version")
 
 
+class SetSharedWithMembership(DevRevBaseModel):
+    """Shared-with membership for articles."""
+
+    member: str = Field(..., description="Member ID")
+    role: str | None = Field(default=None, description="Role")
+
+
 class ArticlesCreateRequest(DevRevBaseModel):
-    """Request to create an article."""
+    """Request to create an article.
+
+    Supports associating the article with parts, a parent collection (directory),
+    scope (internal/external), and tags at creation time.
+    """
 
     title: str = Field(..., description="Article title")
     description: str | None = Field(default=None, description="Article description/body")
@@ -77,6 +172,17 @@ class ArticlesCreateRequest(DevRevBaseModel):
     resource: dict[str, Any] = Field(
         default_factory=dict, description="Resource configuration for the article"
     )
+    applies_to_parts: list[str] | None = Field(
+        default=None, description="List of part IDs this article applies to"
+    )
+    scope: int | None = Field(default=None, description="Visibility scope: 1=internal, 2=external")
+    tags: list[SetTagWithValue] | None = Field(
+        default=None, description="Tags to apply (list of {'id': 'tag_id', 'value': ...})"
+    )
+    parent: str | None = Field(default=None, description="Parent directory/collection DON ID")
+    article_type: str | None = Field(
+        default=None, description="Article type: 'article' (default), 'page', 'content_block'"
+    )
 
 
 class ArticlesGetRequest(DevRevBaseModel):
@@ -91,11 +197,65 @@ class ArticlesDeleteRequest(DevRevBaseModel):
     id: str = Field(..., description="Article ID to delete")
 
 
+class ArticlesListRequestSharedWith(DevRevBaseModel):
+    """Shared-with filter for listing articles."""
+
+    member: str | None = Field(default=None, description="Member ID filter")
+    role: str | None = Field(default=None, description="Role filter")
+
+
 class ArticlesListRequest(DevRevBaseModel):
     """Request to list articles."""
 
     cursor: str | None = Field(default=None, description="Pagination cursor")
     limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+    applies_to_parts: list[str] | None = Field(default=None, description="Filter by part IDs")
+    article_type: list[ArticleType] | None = Field(
+        default=None, description="Filter by article types"
+    )
+    authored_by: list[str] | None = Field(default=None, description="Filter by author user IDs")
+    brands: list[str] | None = Field(default=None, description="Filter by brand IDs")
+    created_by: list[str] | None = Field(default=None, description="Filter by creator user IDs")
+    mode: CursorMode | None = Field(default=None, description="Cursor pagination direction")
+    modified_by: list[str] | None = Field(default=None, description="Filter by modifier user IDs")
+    owned_by: list[str] | None = Field(default=None, description="Filter by owner user IDs")
+    parent: list[str] | None = Field(default=None, description="Filter by parent article IDs")
+    scope: list[int] | None = Field(default=None, description="Filter by scope values")
+    shared_with: ArticlesListRequestSharedWith | None = Field(
+        default=None, description="Filter by shared-with membership"
+    )
+    status: list[ArticleStatus] | None = Field(default=None, description="Filter by article status")
+    tags: list[str] | None = Field(default=None, description="Filter by tag IDs")
+
+
+class ArticlesUpdateRequestOwnedBy(DevRevBaseModel):
+    """Owned-by update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set owner IDs")
+
+
+class ArticlesUpdateRequestAuthoredBy(DevRevBaseModel):
+    """Authored-by update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set author IDs")
+
+
+class ArticlesUpdateRequestAliases(DevRevBaseModel):
+    """Aliases update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set aliases")
+
+
+class ArticlesUpdateRequestAppliesToParts(DevRevBaseModel):
+    """Applies-to-parts update for articles."""
+
+    set: list[str] | None = Field(default=None, description="Set part IDs")
+
+
+class ArticlesUpdateRequestTags(DevRevBaseModel):
+    """Tags update for articles."""
+
+    set: list[SetTagWithValue] | None = Field(default=None, description="Set tags")
 
 
 class ArticlesUpdateRequest(DevRevBaseModel):
@@ -105,6 +265,38 @@ class ArticlesUpdateRequest(DevRevBaseModel):
     title: str | None = Field(default=None, description="New title")
     description: str | None = Field(default=None, description="New description/body")
     status: ArticleStatus | None = Field(default=None, description="New status")
+    access_level: ArticleAccessLevel | None = Field(default=None, description="New access level")
+    aliases: ArticlesUpdateRequestAliases | None = Field(default=None, description="New aliases")
+    applies_to_parts: ArticlesUpdateRequestAppliesToParts | None = Field(
+        default=None, description="New applies-to-parts"
+    )
+    authored_by: ArticlesUpdateRequestAuthoredBy | None = Field(
+        default=None, description="New authored-by"
+    )
+    brand: str | None = Field(default=None, description="New brand ID")
+    content_format: ArticleContentFormat | None = Field(
+        default=None, description="New content format"
+    )
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    custom_schema_spec: CustomSchemaSpec | None = Field(
+        default=None, description="Custom schema spec"
+    )
+    language: str | None = Field(default=None, description="New language code")
+    notify: bool | None = Field(default=None, description="Send notifications")
+    owned_by: ArticlesUpdateRequestOwnedBy | None = Field(default=None, description="New owned-by")
+    parent: str | None = Field(default=None, description="New parent article ID")
+    published_version: str | None = Field(default=None, description="Published version")
+    release_notes: str | None = Field(default=None, description="New release notes")
+    artifacts: dict[str, Any] | None = Field(
+        default=None,
+        description="Artifacts update using set wrapper, e.g. {'set': ['artifact_id']}",
+    )
+    resource: dict[str, Any] | None = Field(
+        default=None,
+        description="Resource configuration (read-only on updates, use artifacts instead)",
+    )
+    tags: ArticlesUpdateRequestTags | None = Field(default=None, description="New tags")
+    url: str | None = Field(default=None, description="Article URL")
 
 
 class ArticlesCreateResponse(DevRevResponseModel):

devrev/models/artifacts.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from datetime import datetime
+from typing import Any
 
 from pydantic import Field
 
@@ -13,7 +14,10 @@ class Artifact(DevRevResponseModel):
     """DevRev Artifact model."""
 
     id: str = Field(..., description="Artifact ID")
-    created_by: str | None = Field(default=None, description="Creator user ID")
+    created_by: dict[str, Any] | str | None = Field(
+        default=None,
+        description="Creator - may be a user ID string or a user object dict",
+    )
     created_date: datetime | None = Field(default=None, description="Creation timestamp")
     file_name: str | None = Field(default=None, description="Original file name")
     file_type: str | None = Field(default=None, description="MIME type of the file")
@@ -72,9 +76,7 @@ class ArtifactGetResponse(DevRevResponseModel):
 class ArtifactListRequest(DevRevBaseModel):
     """Request to list artifacts."""
 
-    parent_id: str | None = Field(
-        default=None, description="Filter artifacts by parent object ID"
-    )
+    parent_id: str | None = Field(default=None, description="Filter artifacts by parent object ID")
 
 
 class ArtifactListResponse(PaginatedResponse):