devrev-Python-SDK 1.0.0__py3-none-any.whl

devrev/models/works.py

@@ -0,0 +1,280 @@
+"""Work models for DevRev SDK.
+
+This module contains Pydantic models for Work-related API operations.
+Works include issues, tickets, tasks, and opportunities.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+from typing import Any
+
+from pydantic import Field
+
+from devrev.models.base import (
+    CustomSchemaSpec,
+    DateFilter,
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    SetTagWithValue,
+    StageInfo,
+    StageUpdate,
+    TagWithValue,
+    UserSummary,
+)
+
+
+class WorkType(str, Enum):
+    """Work item type enumeration."""
+
+    ISSUE = "issue"
+    TICKET = "ticket"
+    TASK = "task"
+    OPPORTUNITY = "opportunity"
+
+
+class IssuePriority(str, Enum):
+    """Issue priority enumeration."""
+
+    P0 = "p0"
+    P1 = "p1"
+    P2 = "p2"
+    P3 = "p3"
+
+
+class TicketSeverity(str, Enum):
+    """Ticket severity enumeration."""
+
+    BLOCKER = "blocker"
+    HIGH = "high"
+    LOW = "low"
+    MEDIUM = "medium"
+
+
+class TicketChannels(str, Enum):
+    """Ticket channel enumeration."""
+
+    EMAIL = "email"
+    PLUG = "plug"
+    SLACK = "slack"
+    OTHER = "other"
+
+
+class Work(DevRevResponseModel):
+    """DevRev Work item model.
+
+    Represents a work item (issue, ticket, task, or opportunity).
+    """
+
+    id: str = Field(..., description="Work item ID")
+    type: WorkType = Field(..., description="Work item type")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    title: str | None = Field(default=None, description="Work item title")
+    body: str | None = Field(default=None, description="Work item body/description")
+    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 the work")
+    modified_by: UserSummary | None = Field(
+        default=None, description="User who last modified the work"
+    )
+    owned_by: list[UserSummary] | None = Field(default=None, description="Work owners")
+    reported_by: list[UserSummary] | None = Field(
+        default=None, description="Users who reported this work"
+    )
+    applies_to_part: str | None = Field(default=None, description="Part this work applies to")
+    stage: StageInfo | None = Field(default=None, description="Work stage")
+    tags: list[TagWithValue] | None = Field(default=None, description="Work tags")
+    priority: str | None = Field(default=None, description="Issue priority")
+    severity: str | None = Field(default=None, description="Ticket severity")
+    target_close_date: datetime | None = Field(default=None, description="Target close date")
+    actual_close_date: datetime | None = Field(default=None, description="Actual close date")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    external_ref: str | None = Field(default=None, description="External reference")
+
+
+class WorkSummary(DevRevResponseModel):
+    """Summary of a Work item for list/reference operations."""
+
+    id: str = Field(..., description="Work item ID")
+    type: WorkType = Field(..., description="Work item type")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    title: str | None = Field(default=None, description="Work item title")
+
+
+# Request Models
+
+
+class WorksCreateRequestIssue(DevRevBaseModel):
+    """Issue-specific fields for work creation."""
+
+    priority: IssuePriority | None = Field(default=None, description="Issue priority")
+    priority_v2: int | None = Field(default=None, description="Priority enum ID")
+    target_start_date: datetime | None = Field(default=None, description="Target start date")
+    developed_with: list[str] | None = Field(
+        default=None, description="Part IDs associated with issue"
+    )
+
+
+class WorksCreateRequestTicket(DevRevBaseModel):
+    """Ticket-specific fields for work creation."""
+
+    account: str | None = Field(default=None, description="Associated account ID")
+    channels: list[TicketChannels] | None = Field(default=None, description="Ticket channels")
+    rev_org: str | None = Field(default=None, description="Rev organization ID")
+    severity: TicketSeverity | None = Field(default=None, description="Ticket severity")
+    is_spam: bool | None = Field(default=None, description="Whether the ticket is spam")
+    needs_response: bool | None = Field(default=None, description="Whether response is needed")
+
+
+class WorksCreateRequest(DevRevBaseModel):
+    """Request to create a work item."""
+
+    type: WorkType = Field(..., description="Work item type")
+    title: str = Field(..., description="Work title", min_length=1, max_length=256)
+    applies_to_part: str = Field(..., description="Part ID this work applies to")
+    owned_by: list[str] | None = Field(default=None, description="Owner user IDs")
+    body: str | None = Field(default=None, description="Work body", max_length=65536)
+    artifacts: list[str] | None = Field(default=None, description="Artifact IDs")
+    external_ref: str | None = Field(default=None, description="External reference")
+    target_close_date: datetime | None = Field(default=None, description="Target close date")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+    custom_schema_spec: CustomSchemaSpec | None = Field(
+        default=None, description="Custom schema spec"
+    )
+    # Issue-specific
+    priority: IssuePriority | None = Field(default=None, description="Issue priority (for issues)")
+    # Ticket-specific
+    severity: TicketSeverity | None = Field(
+        default=None, description="Ticket severity (for tickets)"
+    )
+
+
+class WorksGetRequest(DevRevBaseModel):
+    """Request to get a work item by ID."""
+
+    id: str = Field(..., description="Work item ID")
+
+
+class WorksListRequest(DevRevBaseModel):
+    """Request to list work items."""
+
+    type: list[WorkType] | None = Field(default=None, description="Filter by work types")
+    applies_to_part: list[str] | None = Field(default=None, description="Filter by part 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")
+    external_ref: 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")
+    sort_by: list[str] | None = Field(default=None, description="Sort order")
+    stage_name: list[str] | None = Field(default=None, description="Filter by stage names")
+    target_close_date: DateFilter | None = Field(
+        default=None, description="Filter by target close date"
+    )
+
+
+class WorksUpdateRequestOwnedBy(DevRevBaseModel):
+    """Owned by update for work items."""
+
+    set: list[str] | None = Field(default=None, description="Set owner IDs")
+
+
+class WorksUpdateRequestTags(DevRevBaseModel):
+    """Tags update for work items."""
+
+    set: list[SetTagWithValue] | None = Field(default=None, description="Set tags")
+
+
+class WorksUpdateRequest(DevRevBaseModel):
+    """Request to update a work item."""
+
+    id: str = Field(..., description="Work item ID")
+    title: str | None = Field(default=None, description="New title")
+    body: str | None = Field(default=None, description="New body")
+    applies_to_part: str | None = Field(default=None, description="New part ID")
+    owned_by: WorksUpdateRequestOwnedBy | None = Field(default=None, description="New owners")
+    stage: StageUpdate | None = Field(default=None, description="New stage")
+    tags: WorksUpdateRequestTags | None = Field(default=None, description="New tags")
+    target_close_date: datetime | None = Field(default=None, description="New target close date")
+    custom_fields: dict[str, Any] | None = Field(
+        default=None, description="Custom fields to update"
+    )
+    # Issue-specific
+    priority: IssuePriority | None = Field(default=None, description="New priority")
+    # Ticket-specific
+    severity: TicketSeverity | None = Field(default=None, description="New severity")
+
+
+class WorksDeleteRequest(DevRevBaseModel):
+    """Request to delete a work item."""
+
+    id: str = Field(..., description="Work item ID to delete")
+
+
+class WorksExportRequest(DevRevBaseModel):
+    """Request to export work items."""
+
+    type: list[WorkType] | None = Field(default=None, description="Filter by work types")
+    applies_to_part: list[str] | None = Field(default=None, description="Filter by part 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")
+    first: int | None = Field(default=None, ge=1, le=10000, description="Max results")
+
+
+class WorksCountRequest(DevRevBaseModel):
+    """Request to count work items."""
+
+    type: list[WorkType] | None = Field(default=None, description="Filter by work types")
+    applies_to_part: list[str] | None = Field(default=None, description="Filter by part IDs")
+    created_by: list[str] | None = Field(default=None, description="Filter by creator user IDs")
+    owned_by: list[str] | None = Field(default=None, description="Filter by owner user IDs")
+
+
+# Response Models
+
+
+class WorksCreateResponse(DevRevResponseModel):
+    """Response from creating a work item."""
+
+    work: Work = Field(..., description="Created work item")
+
+
+class WorksGetResponse(DevRevResponseModel):
+    """Response from getting a work item."""
+
+    work: Work = Field(..., description="Retrieved work item")
+
+
+class WorksListResponse(PaginatedResponse):
+    """Response from listing work items."""
+
+    works: list[Work] = Field(..., description="List of work items")
+
+
+class WorksUpdateResponse(DevRevResponseModel):
+    """Response from updating a work item."""
+
+    work: Work = Field(..., description="Updated work item")
+
+
+class WorksDeleteResponse(DevRevResponseModel):
+    """Response from deleting a work item."""
+
+    pass  # Empty response body
+
+
+class WorksExportResponse(DevRevResponseModel):
+    """Response from exporting work items."""
+
+    works: list[Work] = Field(..., description="Exported work items")
+
+
+class WorksCountResponse(DevRevResponseModel):
+    """Response from counting work items."""
+
+    count: int = Field(..., description="Number of matching work items")

devrev/py.typed

@@ -0,0 +1 @@
+

devrev/services/__init__.py

@@ -0,0 +1,74 @@
+"""DevRev SDK Service Classes.
+
+This module contains service classes for interacting with DevRev API endpoints.
+"""
+
+from devrev.services.accounts import AccountsService, AsyncAccountsService
+from devrev.services.articles import ArticlesService, AsyncArticlesService
+from devrev.services.base import AsyncBaseService, BaseService
+from devrev.services.code_changes import AsyncCodeChangesService, CodeChangesService
+from devrev.services.conversations import (
+    AsyncConversationsService,
+    ConversationsService,
+)
+from devrev.services.dev_users import AsyncDevUsersService, DevUsersService
+from devrev.services.groups import AsyncGroupsService, GroupsService
+from devrev.services.links import AsyncLinksService, LinksService
+from devrev.services.parts import AsyncPartsService, PartsService
+from devrev.services.rev_users import AsyncRevUsersService, RevUsersService
+from devrev.services.slas import AsyncSlasService, SlasService
+from devrev.services.tags import AsyncTagsService, TagsService
+from devrev.services.timeline_entries import (
+    AsyncTimelineEntriesService,
+    TimelineEntriesService,
+)
+from devrev.services.webhooks import AsyncWebhooksService, WebhooksService
+from devrev.services.works import AsyncWorksService, WorksService
+
+__all__ = [
+    # Base
+    "BaseService",
+    "AsyncBaseService",
+    # Accounts
+    "AccountsService",
+    "AsyncAccountsService",
+    # Articles
+    "ArticlesService",
+    "AsyncArticlesService",
+    # Code Changes
+    "CodeChangesService",
+    "AsyncCodeChangesService",
+    # Conversations
+    "ConversationsService",
+    "AsyncConversationsService",
+    # Dev Users
+    "DevUsersService",
+    "AsyncDevUsersService",
+    # Groups
+    "GroupsService",
+    "AsyncGroupsService",
+    # Links
+    "LinksService",
+    "AsyncLinksService",
+    # Parts
+    "PartsService",
+    "AsyncPartsService",
+    # Rev Users
+    "RevUsersService",
+    "AsyncRevUsersService",
+    # SLAs
+    "SlasService",
+    "AsyncSlasService",
+    # Tags
+    "TagsService",
+    "AsyncTagsService",
+    # Timeline Entries
+    "TimelineEntriesService",
+    "AsyncTimelineEntriesService",
+    # Webhooks
+    "WebhooksService",
+    "AsyncWebhooksService",
+    # Works
+    "WorksService",
+    "AsyncWorksService",
+]

devrev/services/accounts.py

@@ -0,0 +1,325 @@
+"""Accounts service for DevRev SDK.
+
+This module provides the AccountsService for managing DevRev accounts.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any
+
+from devrev.models.accounts import (
+    Account,
+    AccountsCreateRequest,
+    AccountsCreateResponse,
+    AccountsDeleteRequest,
+    AccountsDeleteResponse,
+    AccountsExportRequest,
+    AccountsExportResponse,
+    AccountsGetRequest,
+    AccountsGetResponse,
+    AccountsListRequest,
+    AccountsListResponse,
+    AccountsMergeRequest,
+    AccountsMergeResponse,
+    AccountsUpdateRequest,
+    AccountsUpdateResponse,
+)
+from devrev.services.base import AsyncBaseService, BaseService
+
+if TYPE_CHECKING:
+    from devrev.utils.http import AsyncHTTPClient, HTTPClient
+
+
+class AccountsService(BaseService):
+    """Synchronous service for managing DevRev accounts.
+
+    Provides methods for creating, reading, updating, and deleting accounts.
+
+    Example:
+        ```python
+        from devrev import DevRevClient
+
+        client = DevRevClient()
+        accounts = client.accounts.list()
+        ```
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        """Initialize the AccountsService."""
+        super().__init__(http_client)
+
+    def create(
+        self,
+        display_name: str,
+        *,
+        description: str | None = None,
+        domains: list[str] | None = None,
+        external_refs: list[str] | None = None,
+        owned_by: list[str] | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> Account:
+        """Create a new account.
+
+        Args:
+            display_name: Account display name
+            description: Account description
+            domains: Associated domains
+            external_refs: External references
+            owned_by: Owner user IDs
+            tier: Account tier
+            custom_fields: Custom fields
+
+        Returns:
+            The created Account
+        """
+        request = AccountsCreateRequest(
+            display_name=display_name,
+            description=description,
+            domains=domains,
+            external_refs=external_refs,
+            owned_by=owned_by,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = self._post("/accounts.create", request, AccountsCreateResponse)
+        return response.account
+
+    def get(self, id: str) -> Account:
+        """Get an account by ID.
+
+        Args:
+            id: Account ID
+
+        Returns:
+            The Account
+        """
+        request = AccountsGetRequest(id=id)
+        response = self._post("/accounts.get", request, AccountsGetResponse)
+        return response.account
+
+    def list(
+        self,
+        *,
+        cursor: str | None = None,
+        limit: int | None = None,
+        display_name: list[str] | None = None,
+        domains: list[str] | None = None,
+        owned_by: list[str] | None = None,
+    ) -> AccountsListResponse:
+        """List accounts.
+
+        Args:
+            cursor: Pagination cursor
+            limit: Maximum number of results
+            display_name: Filter by display names
+            domains: Filter by domains
+            owned_by: Filter by owner user IDs
+
+        Returns:
+            Paginated list of accounts
+        """
+        request = AccountsListRequest(
+            cursor=cursor,
+            limit=limit,
+            display_name=display_name,
+            domains=domains,
+            owned_by=owned_by,
+        )
+        return self._post("/accounts.list", request, AccountsListResponse)
+
+    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,
+    ) -> Account:
+        """Update an account.
+
+        Args:
+            id: Account ID
+            display_name: New display name
+            description: New description
+            tier: New tier
+            custom_fields: Custom fields to update
+
+        Returns:
+            The updated Account
+        """
+        request = AccountsUpdateRequest(
+            id=id,
+            display_name=display_name,
+            description=description,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = self._post("/accounts.update", request, AccountsUpdateResponse)
+        return response.account
+
+    def delete(self, id: str) -> None:
+        """Delete an account.
+
+        Args:
+            id: Account ID to delete
+        """
+        request = AccountsDeleteRequest(id=id)
+        self._post("/accounts.delete", request, AccountsDeleteResponse)
+
+    def merge(self, primary_account: str, secondary_account: str) -> Account:
+        """Merge two accounts.
+
+        Args:
+            primary_account: Primary account ID (will be retained)
+            secondary_account: Secondary account ID (will be merged)
+
+        Returns:
+            The merged Account
+        """
+        request = AccountsMergeRequest(
+            primary_account=primary_account,
+            secondary_account=secondary_account,
+        )
+        response = self._post("/accounts.merge", request, AccountsMergeResponse)
+        return response.account
+
+    def export(
+        self,
+        *,
+        created_by: Sequence[str] | None = None,
+        first: int | None = None,
+    ) -> Sequence[Account]:
+        """Export accounts.
+
+        Args:
+            created_by: Filter by creator user IDs
+            first: Maximum number of results
+
+        Returns:
+            List of exported accounts
+        """
+        request = AccountsExportRequest(
+            created_by=created_by,
+            first=first,
+        )
+        response = self._post("/accounts.export", request, AccountsExportResponse)
+        return response.accounts
+
+
+class AsyncAccountsService(AsyncBaseService):
+    """Asynchronous service for managing DevRev accounts.
+
+    Provides async methods for creating, reading, updating, and deleting accounts.
+
+    Example:
+        ```python
+        from devrev import AsyncDevRevClient
+
+        async with AsyncDevRevClient() as client:
+            accounts = await client.accounts.list()
+        ```
+    """
+
+    def __init__(self, http_client: AsyncHTTPClient) -> None:
+        """Initialize the AsyncAccountsService."""
+        super().__init__(http_client)
+
+    async def create(
+        self,
+        display_name: str,
+        *,
+        description: str | None = None,
+        domains: list[str] | None = None,
+        external_refs: list[str] | None = None,
+        owned_by: list[str] | None = None,
+        tier: str | None = None,
+        custom_fields: dict[str, Any] | None = None,
+    ) -> Account:
+        """Create a new account."""
+        request = AccountsCreateRequest(
+            display_name=display_name,
+            description=description,
+            domains=domains,
+            external_refs=external_refs,
+            owned_by=owned_by,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = await self._post("/accounts.create", request, AccountsCreateResponse)
+        return response.account
+
+    async def get(self, id: str) -> Account:
+        """Get an account by ID."""
+        request = AccountsGetRequest(id=id)
+        response = await self._post("/accounts.get", request, AccountsGetResponse)
+        return response.account
+
+    async def list(
+        self,
+        *,
+        cursor: str | None = None,
+        limit: int | None = None,
+        display_name: list[str] | None = None,
+        domains: list[str] | None = None,
+        owned_by: list[str] | None = None,
+    ) -> AccountsListResponse:
+        """List accounts."""
+        request = AccountsListRequest(
+            cursor=cursor,
+            limit=limit,
+            display_name=display_name,
+            domains=domains,
+            owned_by=owned_by,
+        )
+        return await self._post("/accounts.list", request, AccountsListResponse)
+
+    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,
+    ) -> Account:
+        """Update an account."""
+        request = AccountsUpdateRequest(
+            id=id,
+            display_name=display_name,
+            description=description,
+            tier=tier,
+            custom_fields=custom_fields,
+        )
+        response = await self._post("/accounts.update", request, AccountsUpdateResponse)
+        return response.account
+
+    async def delete(self, id: str) -> None:
+        """Delete an account."""
+        request = AccountsDeleteRequest(id=id)
+        await self._post("/accounts.delete", request, AccountsDeleteResponse)
+
+    async def merge(self, primary_account: str, secondary_account: str) -> Account:
+        """Merge two accounts."""
+        request = AccountsMergeRequest(
+            primary_account=primary_account,
+            secondary_account=secondary_account,
+        )
+        response = await self._post("/accounts.merge", request, AccountsMergeResponse)
+        return response.account
+
+    async def export(
+        self,
+        *,
+        created_by: Sequence[str] | None = None,
+        first: int | None = None,
+    ) -> Sequence[Account]:
+        """Export accounts."""
+        request = AccountsExportRequest(
+            created_by=created_by,
+            first=first,
+        )
+        response = await self._post("/accounts.export", request, AccountsExportResponse)
+        return response.accounts