devrev-Python-SDK 2.7.0__py3-none-any.whl → 2.8.0__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

@@ -42,6 +42,9 @@ class Article(DevRevResponseModel):
     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"
+    )
 
 
 class ArticleSummary(DevRevResponseModel):
@@ -51,6 +54,19 @@ 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 ArticlesCreateRequest(DevRevBaseModel):
     """Request to create an article."""
 

devrev/models/artifacts.py

@@ -0,0 +1,125 @@
+"""Artifact models for DevRev SDK."""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+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: str | None = Field(default=None, description="Creator user ID")
+    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