devrev-Python-SDK 2.7.0__py3-none-any.whl → 2.8.1__py3-none-any.whl

devrev/client.py

@@ -9,6 +9,7 @@ from devrev.config import APIVersion, DevRevConfig, get_config
 from devrev.exceptions import BetaAPIRequiredError
 from devrev.services.accounts import AccountsService, AsyncAccountsService
 from devrev.services.articles import ArticlesService, AsyncArticlesService
+from devrev.services.artifacts import ArtifactsService, AsyncArtifactsService
 from devrev.services.brands import AsyncBrandsService, BrandsService
 from devrev.services.code_changes import AsyncCodeChangesService, CodeChangesService
 from devrev.services.conversations import (
@@ -151,7 +152,8 @@ class DevRevClient:
 
         # Initialize services
         self._accounts = AccountsService(self._http)
-        self._articles = ArticlesService(self._http)
+        self._articles = ArticlesService(self._http, parent_client=self)
+        self._artifacts = ArtifactsService(self._http)
         self._code_changes = CodeChangesService(self._http)
         self._conversations = ConversationsService(self._http)
         self._dev_users = DevUsersService(self._http)
@@ -205,6 +207,11 @@ class DevRevClient:
         """Access the Articles service."""
         return self._articles
 
+    @property
+    def artifacts(self) -> ArtifactsService:
+        """Access the Artifacts service."""
+        return self._artifacts
+
     @property
     def code_changes(self) -> CodeChangesService:
         """Access the Code Changes service."""
@@ -467,7 +474,8 @@ class AsyncDevRevClient:
 
         # Initialize async services
         self._accounts = AsyncAccountsService(self._http)
-        self._articles = AsyncArticlesService(self._http)
+        self._articles = AsyncArticlesService(self._http, parent_client=self)
+        self._artifacts = AsyncArtifactsService(self._http)
         self._code_changes = AsyncCodeChangesService(self._http)
         self._conversations = AsyncConversationsService(self._http)
         self._dev_users = AsyncDevUsersService(self._http)
@@ -521,6 +529,11 @@ class AsyncDevRevClient:
         """Access the Articles service."""
         return self._articles
 
+    @property
+    def artifacts(self) -> AsyncArtifactsService:
+        """Access the Artifacts service."""
+        return self._artifacts
+
     @property
     def code_changes(self) -> AsyncCodeChangesService:
         """Access the Code Changes service."""

devrev/models/__init__.py

@@ -38,6 +38,23 @@ from devrev.models.articles import (
     ArticleSummary,
     ArticlesUpdateRequest,
     ArticlesUpdateResponse,
+    ArticleWithContent,
+)
+from devrev.models.artifacts import (
+    Artifact,
+    ArtifactGetRequest,
+    ArtifactGetResponse,
+    ArtifactListRequest,
+    ArtifactListResponse,
+    ArtifactLocateRequest,
+    ArtifactLocateResponse,
+    ArtifactPrepareFormData,
+    ArtifactPrepareRequest,
+    ArtifactPrepareResponse,
+    ArtifactVersionsDeleteRequest,
+    ArtifactVersionsDeleteResponse,
+    ArtifactVersionsPrepareRequest,
+    ArtifactVersionsPrepareResponse,
 )
 from devrev.models.base import (
     CustomSchemaSpec,
@@ -473,8 +490,24 @@ __all__ = [
     "Article",
     "ArticleSummary",
     "ArticleStatus",
+    "ArticleWithContent",
     "ArticlesCountRequest",
     "ArticlesCountResponse",
+    # Artifacts
+    "Artifact",
+    "ArtifactPrepareFormData",
+    "ArtifactPrepareRequest",
+    "ArtifactPrepareResponse",
+    "ArtifactGetRequest",
+    "ArtifactGetResponse",
+    "ArtifactListRequest",
+    "ArtifactListResponse",
+    "ArtifactLocateRequest",
+    "ArtifactLocateResponse",
+    "ArtifactVersionsPrepareRequest",
+    "ArtifactVersionsPrepareResponse",
+    "ArtifactVersionsDeleteRequest",
+    "ArtifactVersionsDeleteResponse",
     "ArticlesCreateRequest",
     "ArticlesCreateResponse",
     "ArticlesGetRequest",

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,12 +106,29 @@ 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)"
     )
     owned_by: list[UserSummary] | None = Field(default=None, description="Owners of the article")
     created_date: datetime | None = Field(default=None, description="Creation date")
     modified_date: datetime | None = Field(default=None, description="Last modified")
+    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):
@@ -51,8 +138,32 @@ class ArticleSummary(DevRevResponseModel):
     title: str | None = Field(default=None, description="Article title")
 
 
+class ArticleWithContent(DevRevResponseModel):
+    """Article with its content loaded.
+
+    This model combines article metadata with the actual article body content,
+    which is stored separately as an artifact in the DevRev system.
+    """
+
+    article: Article = Field(..., description="Article metadata")
+    content: str = Field(..., description="Article body content")
+    content_format: str = Field(default="text/plain", description="Content MIME type")
+    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")
@@ -61,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):
@@ -75,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):
@@ -89,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

@@ -0,0 +1,127 @@
+"""Artifact models for DevRev SDK."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import Field
+
+from devrev.models.base import DevRevBaseModel, DevRevResponseModel, PaginatedResponse
+
+
+class Artifact(DevRevResponseModel):
+    """DevRev Artifact model."""
+
+    id: str = Field(..., description="Artifact 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")
+    file_size: int | None = Field(default=None, description="File size in bytes")
+    version: str | None = Field(default=None, description="Artifact version")
+
+
+class ArtifactPrepareFormData(DevRevResponseModel):
+    """Form data field for artifact upload."""
+
+    key: str = Field(..., description="Form field key")
+    value: str = Field(..., description="Form field value")
+
+
+class ArtifactPrepareRequest(DevRevBaseModel):
+    """Request to prepare an artifact for upload."""
+
+    file_name: str = Field(..., description="Name of file being uploaded")
+    file_type: str | None = Field(default=None, description="MIME type of the file")
+    configuration_set: str | None = Field(
+        default=None,
+        description=(
+            "Configuration set for the artifact. "
+            "Use 'article_media' for article content. "
+            "Valid values: article_media, default, email_media, job_data, "
+            "marketplace_listing_icon, marketplace_media, org_logo, plug_css, "
+            "plug_setting, plug_setting_banner_card, portal_css, "
+            "snap_in_functions_code, snap_widget, user_profile_picture, work"
+        ),
+    )
+
+
+class ArtifactPrepareResponse(DevRevResponseModel):
+    """Response from preparing an artifact upload."""
+
+    id: str = Field(..., description="Generated artifact ID")
+    url: str = Field(..., description="URL to upload file data to")
+    form_data: list[ArtifactPrepareFormData] = Field(
+        ..., description="POST policy form data for upload"
+    )
+
+
+class ArtifactGetRequest(DevRevBaseModel):
+    """Request to get an artifact."""
+
+    id: str = Field(..., description="Artifact ID")
+    version: str | None = Field(default=None, description="Specific version to fetch")
+
+
+class ArtifactGetResponse(DevRevResponseModel):
+    """Response from getting an artifact."""
+
+    artifact: Artifact = Field(..., description="Retrieved artifact")
+
+
+class ArtifactListRequest(DevRevBaseModel):
+    """Request to list artifacts."""
+
+    parent_id: str | None = Field(default=None, description="Filter artifacts by parent object ID")
+
+
+class ArtifactListResponse(PaginatedResponse):
+    """Response from listing artifacts."""
+
+    artifacts: list[Artifact] = Field(default_factory=list, description="List of artifacts")
+
+
+class ArtifactLocateRequest(DevRevBaseModel):
+    """Request to get artifact download URL."""
+
+    id: str = Field(..., description="Artifact ID")
+    version: str | None = Field(default=None, description="Specific version to locate")
+
+
+class ArtifactLocateResponse(DevRevResponseModel):
+    """Response with artifact download URL."""
+
+    url: str = Field(..., description="Download URL for the artifact")
+
+
+class ArtifactVersionsPrepareRequest(DevRevBaseModel):
+    """Request to prepare a new version of an artifact."""
+
+    id: str = Field(..., description="Artifact ID to create new version for")
+
+
+class ArtifactVersionsPrepareResponse(DevRevResponseModel):
+    """Response from preparing a new artifact version."""
+
+    id: str = Field(..., description="Artifact ID")
+    url: str = Field(..., description="URL to upload new version data to")
+    form_data: list[ArtifactPrepareFormData] = Field(
+        ..., description="POST policy form data for upload"
+    )
+
+
+class ArtifactVersionsDeleteRequest(DevRevBaseModel):
+    """Request to delete an artifact version."""
+
+    id: str = Field(..., description="Artifact ID")
+    version: str = Field(..., description="Version to delete")
+
+
+class ArtifactVersionsDeleteResponse(DevRevResponseModel):
+    """Response from deleting an artifact version."""
+
+    pass