devrev-Python-SDK 2.13.0__py3-none-any.whl → 2.14.1__py3-none-any.whl

devrev/client.py

@@ -38,6 +38,7 @@ from devrev.services.recommendations import (
     AsyncRecommendationsService,
     RecommendationsService,
 )
+from devrev.services.rev_orgs import AsyncRevOrgsService, RevOrgsService
 from devrev.services.rev_users import AsyncRevUsersService, RevUsersService
 from devrev.services.search import AsyncSearchService, SearchService
 from devrev.services.slas import AsyncSlasService, SlasService
@@ -160,6 +161,7 @@ class DevRevClient:
         self._groups = GroupsService(self._http)
         self._links = LinksService(self._http)
         self._parts = PartsService(self._http)
+        self._rev_orgs = RevOrgsService(self._http)
         self._rev_users = RevUsersService(self._http)
         self._slas = SlasService(self._http)
         self._tags = TagsService(self._http)
@@ -242,6 +244,11 @@ class DevRevClient:
         """Access the Parts service."""
         return self._parts
 
+    @property
+    def rev_orgs(self) -> RevOrgsService:
+        """Access the Rev Orgs service for managing revenue organizations."""
+        return self._rev_orgs
+
     @property
     def rev_users(self) -> RevUsersService:
         """Access the Rev Users service."""
@@ -482,6 +489,7 @@ class AsyncDevRevClient:
         self._groups = AsyncGroupsService(self._http)
         self._links = AsyncLinksService(self._http)
         self._parts = AsyncPartsService(self._http)
+        self._rev_orgs = AsyncRevOrgsService(self._http)
         self._rev_users = AsyncRevUsersService(self._http)
         self._slas = AsyncSlasService(self._http)
         self._tags = AsyncTagsService(self._http)
@@ -564,6 +572,11 @@ class AsyncDevRevClient:
         """Access the Parts service."""
         return self._parts
 
+    @property
+    def rev_orgs(self) -> AsyncRevOrgsService:
+        """Access the Rev Orgs service for managing revenue organizations."""
+        return self._rev_orgs
+
     @property
     def rev_users(self) -> AsyncRevUsersService:
         """Access the Rev Users service."""

devrev/models/__init__.py

@@ -260,6 +260,20 @@ from devrev.models.recommendations import (
     MessageRole,
     TokenUsage,
 )
+from devrev.models.rev_orgs import (
+    RevOrg,
+    RevOrgsCreateRequest,
+    RevOrgsCreateResponse,
+    RevOrgsDeleteRequest,
+    RevOrgsDeleteResponse,
+    RevOrgsGetRequest,
+    RevOrgsGetResponse,
+    RevOrgsListRequest,
+    RevOrgsListResponse,
+    RevOrgSummary,
+    RevOrgsUpdateRequest,
+    RevOrgsUpdateResponse,
+)
 from devrev.models.rev_users import (
     RevUser,
     RevUsersAssociationsAddRequest,
@@ -694,6 +708,19 @@ __all__ = [
     "ChatCompletionResponse",
     "GetReplyRequest",
     "GetReplyResponse",
+    # Rev Orgs
+    "RevOrg",
+    "RevOrgSummary",
+    "RevOrgsCreateRequest",
+    "RevOrgsCreateResponse",
+    "RevOrgsGetRequest",
+    "RevOrgsGetResponse",
+    "RevOrgsListRequest",
+    "RevOrgsListResponse",
+    "RevOrgsUpdateRequest",
+    "RevOrgsUpdateResponse",
+    "RevOrgsDeleteRequest",
+    "RevOrgsDeleteResponse",
     # Rev Users
     "RevUser",
     "RevUserSummary",
@@ -889,6 +916,12 @@ from devrev.models.accounts import (
     AccountsListResponse as _AccountsListResponse,
 )
 from devrev.models.base import TagWithValue as _TagWithValue  # noqa: F811
+from devrev.models.rev_orgs import (  # noqa: F811
+    RevOrg as _RevOrg,
+)
+from devrev.models.rev_orgs import (
+    RevOrgsListResponse as _RevOrgsListResponse,
+)
 from devrev.models.works import (  # noqa: F811
     Work as _Work,
 )
@@ -904,6 +937,8 @@ _TagWithValue.model_rebuild()
 _Account.model_rebuild()
 _AccountsListResponse.model_rebuild()
 _AccountsExportResponse.model_rebuild()
+_RevOrg.model_rebuild()
+_RevOrgsListResponse.model_rebuild()
 _Work.model_rebuild()
 _WorksListResponse.model_rebuild()
 _WorksExportResponse.model_rebuild()

devrev/models/rev_orgs.py

@@ -0,0 +1,159 @@
+"""Rev Org models for DevRev SDK.
+
+This module contains Pydantic models for Rev Org (Revenue Organization)-related
+API operations. Rev Orgs represent customer organizations in DevRev.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any
+
+from pydantic import Field
+
+from devrev.models.accounts import AccountSummary
+from devrev.models.base import (
+    CustomSchemaSpec,
+    DateFilter,
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    TagWithValue,
+    UserSummary,
+)
+
+
+class RevOrg(DevRevResponseModel):
+    """DevRev Rev Org (Revenue Organization) model.
+
+    Represents a customer organization in DevRev, typically associated
+    with an Account.
+    """
+
+    id: str = Field(..., description="Rev org ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="Rev org display name")
+    description: str | None = Field(default=None, description="Rev org description")
+    account: AccountSummary | None = Field(default=None, description="Associated account")
+    created_date: datetime | None = Field(default=None, description="Creation timestamp")
+    modified_date: datetime | None = Field(default=None, description="Last modification timestamp")
+    created_by: UserSummary | None = Field(
+        default=None, description="User who created this rev org"
+    )
+    modified_by: UserSummary | None = Field(
+        default=None, description="User who last modified this rev org"
+    )
+    domain: str | None = Field(default=None, description="Domain")
+    external_ref: str | None = Field(default=None, description="External reference identifier")
+    external_refs: list[str] | None = Field(default=None, description="External references")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    sub_type: str | None = Field(default=None, description="Rev org subtype")
+    tags: list[TagWithValue] | None = Field(default=None, description="Tags")
+    tier: str | None = Field(default=None, description="Rev org tier")
+    artifacts: list[str] | None = Field(default=None, description="Associated artifact IDs")
+
+
+class RevOrgSummary(DevRevResponseModel):
+    """Summary of a Rev Org for list/reference operations."""
+
+    id: str = Field(..., description="Rev org ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="Rev org display name")
+
+
+# Request Models
+
+
+class RevOrgsGetRequest(DevRevBaseModel):
+    """Request to get a rev org."""
+
+    id: str | None = Field(default=None, description="Rev org ID")
+    account: str | None = Field(
+        default=None, description="Account ID to get the default rev org for"
+    )
+
+
+class RevOrgsListRequest(DevRevBaseModel):
+    """Request to list rev orgs."""
+
+    account: list[str] | None = Field(default=None, description="Filter by account IDs")
+    created_by: list[str] | None = Field(default=None, description="Filter by creator user IDs")
+    created_date: DateFilter | None = Field(default=None, description="Filter by creation date")
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    display_name: list[str] | None = Field(default=None, description="Filter by display names")
+    domains: list[str] | None = Field(default=None, description="Filter by domains")
+    external_refs: list[str] | None = Field(default=None, description="Filter by external refs")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results to return")
+    modified_date: DateFilter | None = Field(
+        default=None, description="Filter by modification date"
+    )
+    owned_by: list[str] | None = Field(default=None, description="Filter by owner user IDs")
+    tags: list[str] | None = Field(default=None, description="Filter by tag IDs")
+
+
+class RevOrgsCreateRequest(DevRevBaseModel):
+    """Request to create a rev org."""
+
+    display_name: str = Field(..., description="Rev org display name", min_length=1, max_length=256)
+    account: str = Field(..., description="Parent account ID")
+    description: str | None = Field(default=None, description="Rev org description")
+    external_ref: str | None = Field(default=None, description="External reference identifier")
+    tier: str | None = Field(default=None, description="Rev org tier")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    custom_schema_spec: CustomSchemaSpec | None = Field(
+        default=None, description="Custom schema spec"
+    )
+
+
+class RevOrgsUpdateRequest(DevRevBaseModel):
+    """Request to update a rev org."""
+
+    id: str = Field(..., description="Rev org ID")
+    display_name: str | None = Field(default=None, description="New display name")
+    description: str | None = Field(default=None, description="New description")
+    tier: str | None = Field(default=None, description="New tier")
+    custom_fields: dict[str, Any] | None = Field(
+        default=None, description="Custom fields to update"
+    )
+    artifacts: dict[str, Any] | None = Field(
+        default=None, description="Artifact set/remove operations"
+    )
+
+
+class RevOrgsDeleteRequest(DevRevBaseModel):
+    """Request to delete a rev org."""
+
+    id: str = Field(..., description="Rev org ID to delete")
+
+
+# Response Models
+
+
+class RevOrgsGetResponse(DevRevResponseModel):
+    """Response from getting a rev org."""
+
+    rev_org: RevOrg = Field(..., description="Retrieved rev org")
+
+
+class RevOrgsListResponse(PaginatedResponse):
+    """Response from listing rev orgs."""
+
+    rev_orgs: list[RevOrg] = Field(..., description="List of rev orgs")
+
+
+class RevOrgsCreateResponse(DevRevResponseModel):
+    """Response from creating a rev org."""
+
+    rev_org: RevOrg = Field(..., description="Created rev org")
+
+
+class RevOrgsUpdateResponse(DevRevResponseModel):
+    """Response from updating a rev org."""
+
+    rev_org: RevOrg = Field(..., description="Updated rev org")
+
+
+class RevOrgsDeleteResponse(DevRevResponseModel):
+    """Response from deleting a rev org."""
+
+    pass  # Empty response body

devrev/services/__init__.py

@@ -34,6 +34,7 @@ from devrev.services.recommendations import (
     AsyncRecommendationsService,
     RecommendationsService,
 )
+from devrev.services.rev_orgs import AsyncRevOrgsService, RevOrgsService
 from devrev.services.rev_users import AsyncRevUsersService, RevUsersService
 from devrev.services.search import AsyncSearchService, SearchService
 from devrev.services.slas import AsyncSlasService, SlasService
@@ -99,6 +100,9 @@ __all__ = [
     # Recommendations
     "RecommendationsService",
     "AsyncRecommendationsService",
+    # Rev Orgs
+    "RevOrgsService",
+    "AsyncRevOrgsService",
     # Rev Users
     "RevUsersService",
     "AsyncRevUsersService",

devrev/services/rev_orgs.py

@@ -0,0 +1,271 @@
+"""Rev Orgs service for DevRev SDK.
+
+This module provides the RevOrgsService for managing DevRev Rev Orgs
+(Revenue Organizations).
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from devrev.models.rev_orgs import (
+    RevOrg,
+    RevOrgsCreateRequest,
+    RevOrgsCreateResponse,
+    RevOrgsDeleteRequest,
+    RevOrgsDeleteResponse,
+    RevOrgsGetRequest,
+    RevOrgsGetResponse,
+    RevOrgsListRequest,
+    RevOrgsListResponse,
+    RevOrgsUpdateRequest,
+    RevOrgsUpdateResponse,
+)
+from devrev.services.base import AsyncBaseService, BaseService
+
+if TYPE_CHECKING:
+    from devrev.utils.http import AsyncHTTPClient, HTTPClient
+
+
+class RevOrgsService(BaseService):
+    """Synchronous service for managing DevRev Rev Orgs.
+
+    Provides methods for creating, reading, updating, and deleting
+    Rev Orgs (Revenue Organizations).
+
+    Example:
+        ```python
+        from devrev import DevRevClient
+
+        client = DevRevClient()
+        rev_orgs = client.rev_orgs.list()
+        ```
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        """Initialize the RevOrgsService."""
+        super().__init__(http_client)
+
+    def create(
+        self,
+        display_name: str,
+        account: str,
+        *,
+        description: str | None = None,
+        external_ref: str | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> RevOrg:
+        """Create a new rev org.
+
+        Args:
+            display_name: Rev org display name
+            account: Parent account ID
+            description: Rev org description
+            external_ref: External reference identifier
+            tier: Rev org tier
+            custom_fields: Custom fields
+
+        Returns:
+            The created RevOrg
+        """
+        request = RevOrgsCreateRequest(
+            display_name=display_name,
+            account=account,
+            description=description,
+            external_ref=external_ref,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = self._post("/rev-orgs.create", request, RevOrgsCreateResponse)
+        return response.rev_org
+
+    def get(self, id: str) -> RevOrg:
+        """Get a rev org by ID.
+
+        Args:
+            id: Rev org ID
+
+        Returns:
+            The RevOrg
+        """
+        request = RevOrgsGetRequest(id=id)
+        response = self._post("/rev-orgs.get", request, RevOrgsGetResponse)
+        return response.rev_org
+
+    def list(
+        self,
+        *,
+        cursor: str | None = None,
+        limit: int | None = None,
+        account: list[str] | None = None,
+        display_name: list[str] | None = None,
+        domains: list[str] | None = None,
+        external_refs: list[str] | None = None,
+        owned_by: list[str] | None = None,
+        tags: list[str] | None = None,
+    ) -> RevOrgsListResponse:
+        """List rev orgs.
+
+        Args:
+            cursor: Pagination cursor
+            limit: Maximum number of results
+            account: Filter by account IDs
+            display_name: Filter by display names
+            domains: Filter by domains
+            external_refs: Filter by external refs
+            owned_by: Filter by owner user IDs
+            tags: Filter by tag IDs
+
+        Returns:
+            Paginated list of rev orgs
+        """
+        request = RevOrgsListRequest(
+            cursor=cursor,
+            limit=limit,
+            account=account,
+            display_name=display_name,
+            domains=domains,
+            external_refs=external_refs,
+            owned_by=owned_by,
+            tags=tags,
+        )
+        return self._post("/rev-orgs.list", request, RevOrgsListResponse)
+
+    def update(
+        self,
+        id: str,
+        *,
+        display_name: str | None = None,
+        description: str | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> RevOrg:
+        """Update a rev org.
+
+        Args:
+            id: Rev org ID
+            display_name: New display name
+            description: New description
+            tier: New tier
+            custom_fields: Custom fields to update
+
+        Returns:
+            The updated RevOrg
+        """
+        request = RevOrgsUpdateRequest(
+            id=id,
+            display_name=display_name,
+            description=description,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = self._post("/rev-orgs.update", request, RevOrgsUpdateResponse)
+        return response.rev_org
+
+    def delete(self, id: str) -> None:
+        """Delete a rev org.
+
+        Args:
+            id: Rev org ID to delete
+        """
+        request = RevOrgsDeleteRequest(id=id)
+        self._post("/rev-orgs.delete", request, RevOrgsDeleteResponse)
+
+
+class AsyncRevOrgsService(AsyncBaseService):
+    """Asynchronous service for managing DevRev Rev Orgs.
+
+    Provides async methods for creating, reading, updating, and deleting
+    Rev Orgs (Revenue Organizations).
+
+    Example:
+        ```python
+        from devrev import AsyncDevRevClient
+
+        async with AsyncDevRevClient() as client:
+            rev_orgs = await client.rev_orgs.list()
+        ```
+    """
+
+    def __init__(self, http_client: AsyncHTTPClient) -> None:
+        """Initialize the AsyncRevOrgsService."""
+        super().__init__(http_client)
+
+    async def create(
+        self,
+        display_name: str,
+        account: str,
+        *,
+        description: str | None = None,
+        external_ref: str | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> RevOrg:
+        """Create a new rev org."""
+        request = RevOrgsCreateRequest(
+            display_name=display_name,
+            account=account,
+            description=description,
+            external_ref=external_ref,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = await self._post("/rev-orgs.create", request, RevOrgsCreateResponse)
+        return response.rev_org
+
+    async def get(self, id: str) -> RevOrg:
+        """Get a rev org by ID."""
+        request = RevOrgsGetRequest(id=id)
+        response = await self._post("/rev-orgs.get", request, RevOrgsGetResponse)
+        return response.rev_org
+
+    async def list(
+        self,
+        *,
+        cursor: str | None = None,
+        limit: int | None = None,
+        account: list[str] | None = None,
+        display_name: list[str] | None = None,
+        domains: list[str] | None = None,
+        external_refs: list[str] | None = None,
+        owned_by: list[str] | None = None,
+        tags: list[str] | None = None,
+    ) -> RevOrgsListResponse:
+        """List rev orgs."""
+        request = RevOrgsListRequest(
+            cursor=cursor,
+            limit=limit,
+            account=account,
+            display_name=display_name,
+            domains=domains,
+            external_refs=external_refs,
+            owned_by=owned_by,
+            tags=tags,
+        )
+        return await self._post("/rev-orgs.list", request, RevOrgsListResponse)
+
+    async def update(
+        self,
+        id: str,
+        *,
+        display_name: str | None = None,
+        description: str | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> RevOrg:
+        """Update a rev org."""
+        request = RevOrgsUpdateRequest(
+            id=id,
+            display_name=display_name,
+            description=description,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = await self._post("/rev-orgs.update", request, RevOrgsUpdateResponse)
+        return response.rev_org
+
+    async def delete(self, id: str) -> None:
+        """Delete a rev org."""
+        request = RevOrgsDeleteRequest(id=id)
+        await self._post("/rev-orgs.delete", request, RevOrgsDeleteResponse)

devrev_mcp/server.py

@@ -243,6 +243,7 @@ from devrev_mcp.tools import groups as _groups_tools  # noqa: E402, F401
 from devrev_mcp.tools import incidents as _incidents_tools  # noqa: E402, F401
 from devrev_mcp.tools import links as _links_tools  # noqa: E402, F401
 from devrev_mcp.tools import parts as _parts_tools  # noqa: E402, F401
+from devrev_mcp.tools import rev_orgs as _rev_orgs_tools  # noqa: E402, F401
 from devrev_mcp.tools import server_info as _server_info_tools  # noqa: E402, F401
 from devrev_mcp.tools import slas as _slas_tools  # noqa: E402, F401
 from devrev_mcp.tools import tags as _tags_tools  # noqa: E402, F401

devrev_mcp/tools/accounts.py

@@ -9,6 +9,7 @@ from mcp.server.fastmcp import Context
 
 from devrev.exceptions import DevRevError
 from devrev_mcp.server import _config, mcp
+from devrev_mcp.utils.don_id import validate_don_id
 from devrev_mcp.utils.errors import format_devrev_error
 from devrev_mcp.utils.formatting import serialize_model, serialize_models
 from devrev_mcp.utils.pagination import clamp_page_size, paginated_response
@@ -61,6 +62,7 @@ async def devrev_accounts_get(
     Args:
         id: The account ID.
     """
+    validate_don_id(id, "account", "devrev_accounts_get")
     app = ctx.request_context.lifespan_context
     try:
         account = await app.get_client().accounts.get(id)
@@ -124,6 +126,7 @@ if _config.enable_destructive_tools:
             description: New description.
             tier: New account tier.
         """
+        validate_don_id(id, "account", "devrev_accounts_update")
         app = ctx.request_context.lifespan_context
         try:
             account = await app.get_client().accounts.update(
@@ -146,6 +149,7 @@ if _config.enable_destructive_tools:
         Args:
             id: The account ID to delete.
         """
+        validate_don_id(id, "account", "devrev_accounts_delete")
         app = ctx.request_context.lifespan_context
         try:
             await app.get_client().accounts.delete(id)
@@ -167,6 +171,8 @@ if _config.enable_destructive_tools:
             primary_account: ID of the primary (surviving) account.
             secondary_account: ID of the secondary (merged) account.
         """
+        validate_don_id(primary_account, "account", "devrev_accounts_merge")
+        validate_don_id(secondary_account, "account", "devrev_accounts_merge")
         app = ctx.request_context.lifespan_context
         try:
             account = await app.get_client().accounts.merge(

devrev_mcp/tools/articles.py

@@ -22,6 +22,7 @@ from devrev.models.articles import (
 from devrev.models.base import SetTagWithValue
 from devrev.utils.content_converter import OutputFormat
 from devrev_mcp.server import _config, mcp
+from devrev_mcp.utils.don_id import validate_don_id
 from devrev_mcp.utils.errors import format_devrev_error
 from devrev_mcp.utils.formatting import serialize_model, serialize_models
 from devrev_mcp.utils.pagination import clamp_page_size, paginated_response
@@ -89,6 +90,7 @@ async def devrev_articles_get(
     Raises:
         RuntimeError: If the DevRev API call fails.
     """
+    validate_don_id(id, "article", "devrev_articles_get")
     app = ctx.request_context.lifespan_context
     try:
         if include_content:
@@ -251,6 +253,7 @@ if _config.enable_destructive_tools:
         Raises:
             RuntimeError: If the DevRev API call fails.
         """
+        validate_don_id(id, "article", "devrev_articles_update")
         app = ctx.request_context.lifespan_context
         try:
             article_status = None
@@ -323,6 +326,7 @@ if _config.enable_destructive_tools:
         Raises:
             RuntimeError: If the DevRev API call fails.
         """
+        validate_don_id(id, "article", "devrev_articles_delete")
         app = ctx.request_context.lifespan_context
         try:
             request = ArticlesDeleteRequest(id=id)

devrev_mcp/tools/conversations.py

@@ -16,6 +16,7 @@ from devrev.models.conversations import (
     ConversationsUpdateRequest,
 )
 from devrev_mcp.server import _config, mcp
+from devrev_mcp.utils.don_id import validate_don_id
 from devrev_mcp.utils.errors import format_devrev_error
 from devrev_mcp.utils.formatting import serialize_model, serialize_models
 from devrev_mcp.utils.pagination import clamp_page_size, paginated_response
@@ -60,6 +61,7 @@ async def devrev_conversations_get(
     Args:
         id: Conversation ID (e.g., "don:core:dvrv-us-1:devo/1:conversation/123").
     """
+    validate_don_id(id, "conversation", "devrev_conversations_get")
     app = ctx.request_context.lifespan_context
     try:
         request = ConversationsGetRequest(id=id)
@@ -108,6 +110,7 @@ if _config.enable_destructive_tools:
             title: New conversation title.
             description: New conversation description.
         """
+        validate_don_id(id, "conversation", "devrev_conversations_update")
         app = ctx.request_context.lifespan_context
         try:
             request = ConversationsUpdateRequest(id=id, title=title, description=description)
@@ -126,6 +129,7 @@ if _config.enable_destructive_tools:
         Args:
             id: Conversation ID to delete.
         """
+        validate_don_id(id, "conversation", "devrev_conversations_delete")
         app = ctx.request_context.lifespan_context
         try:
             request = ConversationsDeleteRequest(id=id)