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

devrev/models/accounts.py

@@ -0,0 +1,187 @@
+"""Account models for DevRev SDK.
+
+This module contains Pydantic models for Account-related API operations.
+"""
+
+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,
+    StageInfo,
+    TagWithValue,
+    UserSummary,
+)
+
+
+class AccountTier(str, Enum):
+    """Account tier enumeration."""
+
+    TIER1 = "tier-1"
+    TIER2 = "tier-2"
+    TIER3 = "tier-3"
+
+
+class Account(DevRevResponseModel):
+    """DevRev Account model.
+
+    Represents a customer account in DevRev.
+    """
+
+    id: str = Field(..., description="Account ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="Account display name")
+    description: str | None = Field(default=None, description="Account 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 account")
+    modified_by: UserSummary | None = Field(
+        default=None, description="User who last modified the account"
+    )
+    owned_by: list[UserSummary] | None = Field(default=None, description="Account owners")
+    domains: list[str] | None = Field(default=None, description="Associated domains")
+    external_refs: list[str] | None = Field(default=None, description="External references")
+    stage: StageInfo | None = Field(default=None, description="Account stage")
+    tags: list[TagWithValue] | None = Field(default=None, description="Account tags")
+    tier: str | None = Field(default=None, description="Account tier")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+
+
+class AccountSummary(DevRevResponseModel):
+    """Summary of an Account for list/reference operations."""
+
+    id: str = Field(..., description="Account ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="Account display name")
+
+
+# Request Models
+
+
+class AccountsCreateRequest(DevRevBaseModel):
+    """Request to create an account."""
+
+    display_name: str = Field(..., description="Account display name", min_length=1, max_length=256)
+    description: str | None = Field(
+        default=None, description="Account description", max_length=65536
+    )
+    domains: list[str] | None = Field(default=None, description="Associated domains")
+    external_refs: list[str] | None = Field(default=None, description="External references")
+    owned_by: list[str] | None = Field(default=None, description="Owner user IDs")
+    tier: str | None = Field(default=None, description="Account 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 AccountsGetRequest(DevRevBaseModel):
+    """Request to get an account by ID."""
+
+    id: str = Field(..., description="Account ID")
+
+
+class AccountsListRequest(DevRevBaseModel):
+    """Request to list accounts."""
+
+    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")
+    sort_by: list[str] | None = Field(default=None, description="Sort order")
+    stage_name: list[str] | None = Field(default=None, description="Filter by stage names")
+    tags: list[str] | None = Field(default=None, description="Filter by tag IDs")
+
+
+class AccountsUpdateRequest(DevRevBaseModel):
+    """Request to update an account."""
+
+    id: str = Field(..., description="Account 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"
+    )
+
+
+class AccountsDeleteRequest(DevRevBaseModel):
+    """Request to delete an account."""
+
+    id: str = Field(..., description="Account ID to delete")
+
+
+class AccountsMergeRequest(DevRevBaseModel):
+    """Request to merge two accounts."""
+
+    primary_account: str = Field(..., description="Primary account ID (will be retained)")
+    secondary_account: str = Field(..., description="Secondary account ID (will be merged)")
+
+
+class AccountsExportRequest(DevRevBaseModel):
+    """Request to export accounts."""
+
+    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")
+
+
+# Response Models
+
+
+class AccountsCreateResponse(DevRevResponseModel):
+    """Response from creating an account."""
+
+    account: Account = Field(..., description="Created account")
+
+
+class AccountsGetResponse(DevRevResponseModel):
+    """Response from getting an account."""
+
+    account: Account = Field(..., description="Retrieved account")
+
+
+class AccountsListResponse(PaginatedResponse):
+    """Response from listing accounts."""
+
+    accounts: list[Account] = Field(..., description="List of accounts")
+
+
+class AccountsUpdateResponse(DevRevResponseModel):
+    """Response from updating an account."""
+
+    account: Account = Field(..., description="Updated account")
+
+
+class AccountsDeleteResponse(DevRevResponseModel):
+    """Response from deleting an account."""
+
+    pass  # Empty response body
+
+
+class AccountsMergeResponse(DevRevResponseModel):
+    """Response from merging accounts."""
+
+    account: Account = Field(..., description="Merged account")
+
+
+class AccountsExportResponse(DevRevResponseModel):
+    """Response from exporting accounts."""
+
+    accounts: list[Account] = Field(..., description="Exported accounts")

devrev/models/articles.py

@@ -0,0 +1,109 @@
+"""Article models for DevRev SDK."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from enum import Enum
+
+from pydantic import Field
+
+from devrev.models.base import (
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    UserSummary,
+)
+
+
+class ArticleStatus(str, Enum):
+    """Article status enumeration."""
+
+    DRAFT = "draft"
+    PUBLISHED = "published"
+    ARCHIVED = "archived"
+
+
+class Article(DevRevResponseModel):
+    """DevRev Article model."""
+
+    id: str = Field(..., description="Article ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    title: str = Field(..., description="Article title")
+    content: str | None = Field(default=None, description="Article content")
+    status: ArticleStatus | None = Field(default=None, description="Article status")
+    authored_by: UserSummary | None = Field(default=None, description="Author")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class ArticleSummary(DevRevResponseModel):
+    """Summary of an Article."""
+
+    id: str = Field(..., description="Article ID")
+    title: str | None = Field(default=None, description="Article title")
+
+
+class ArticlesCreateRequest(DevRevBaseModel):
+    """Request to create an article."""
+
+    title: str = Field(..., description="Article title")
+    content: str | None = Field(default=None, description="Article content")
+    status: ArticleStatus | None = Field(default=None, description="Article status")
+
+
+class ArticlesGetRequest(DevRevBaseModel):
+    """Request to get an article by ID."""
+
+    id: str = Field(..., description="Article ID")
+
+
+class ArticlesDeleteRequest(DevRevBaseModel):
+    """Request to delete an article."""
+
+    id: str = Field(..., description="Article ID to delete")
+
+
+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")
+
+
+class ArticlesUpdateRequest(DevRevBaseModel):
+    """Request to update an article."""
+
+    id: str = Field(..., description="Article ID")
+    title: str | None = Field(default=None, description="New title")
+    content: str | None = Field(default=None, description="New content")
+    status: ArticleStatus | None = Field(default=None, description="New status")
+
+
+class ArticlesCreateResponse(DevRevResponseModel):
+    """Response from creating an article."""
+
+    article: Article = Field(..., description="Created article")
+
+
+class ArticlesGetResponse(DevRevResponseModel):
+    """Response from getting an article."""
+
+    article: Article = Field(..., description="Retrieved article")
+
+
+class ArticlesListResponse(PaginatedResponse):
+    """Response from listing articles."""
+
+    articles: list[Article] = Field(..., description="List of articles")
+
+
+class ArticlesUpdateResponse(DevRevResponseModel):
+    """Response from updating an article."""
+
+    article: Article = Field(..., description="Updated article")
+
+
+class ArticlesDeleteResponse(DevRevResponseModel):
+    """Response from deleting an article."""
+
+    pass

devrev/models/base.py

@@ -0,0 +1,147 @@
+"""Base Pydantic models and configuration for DevRev SDK.
+
+This module provides base classes and shared configuration for all models.
+"""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class DevRevBaseModel(BaseModel):
+    """Base model for all DevRev API models.
+
+    Provides consistent configuration across all models:
+    - Strict validation
+    - Extra fields forbidden
+    - Alias population from camelCase
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+        str_strip_whitespace=True,
+        validate_assignment=True,
+    )
+
+
+class DevRevResponseModel(DevRevBaseModel):
+    """Base model for API responses.
+
+    Allows extra fields to handle unknown API additions gracefully.
+    """
+
+    model_config = ConfigDict(
+        extra="ignore",
+        populate_by_name=True,
+        str_strip_whitespace=True,
+    )
+
+
+class PaginatedResponse(DevRevResponseModel):
+    """Base model for paginated API responses."""
+
+    next_cursor: str | None = Field(
+        default=None,
+        description="Cursor for fetching next page of results",
+    )
+    prev_cursor: str | None = Field(
+        default=None,
+        description="Cursor for fetching previous page of results",
+    )
+
+
+class DateFilter(DevRevBaseModel):
+    """Date filter for API requests."""
+
+    after: datetime | None = Field(
+        default=None,
+        description="Filter for objects after this timestamp",
+    )
+    before: datetime | None = Field(
+        default=None,
+        description="Filter for objects before this timestamp",
+    )
+
+
+class DateTimeFilter(DevRevBaseModel):
+    """DateTime filter for API requests with preset options."""
+
+    after: datetime | None = Field(
+        default=None,
+        description="Filter for objects after this timestamp",
+    )
+    before: datetime | None = Field(
+        default=None,
+        description="Filter for objects before this timestamp",
+    )
+    preset: str | None = Field(
+        default=None,
+        description="Preset time period filter",
+    )
+
+
+class UserSummary(DevRevResponseModel):
+    """Summary of a DevRev user."""
+
+    id: str = Field(..., description="User ID")
+    display_name: str | None = Field(default=None, description="User's display name")
+    email: str | None = Field(default=None, description="User's email address")
+    full_name: str | None = Field(default=None, description="User's full name")
+
+
+class OrgSummary(DevRevResponseModel):
+    """Summary of a DevRev organization."""
+
+    id: str = Field(..., description="Organization ID")
+    display_name: str | None = Field(default=None, description="Organization's display name")
+
+
+class ObjectSummary(DevRevResponseModel):
+    """Summary of a generic DevRev object (used for link source/target)."""
+
+    id: str = Field(..., description="Object ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    type: str | None = Field(default=None, description="Object type")
+
+
+class TagWithValue(DevRevResponseModel):
+    """Tag with value for resource tagging."""
+
+    tag: str = Field(..., description="Tag name or ID")
+    value: str | None = Field(default=None, description="Tag value")
+
+
+class SetTagWithValue(DevRevBaseModel):
+    """Tag with value for setting tags on resources."""
+
+    id: str = Field(..., description="Tag ID")
+    value: str | None = Field(default=None, description="Tag value")
+
+
+class StageInfo(DevRevResponseModel):
+    """Stage information for staged objects."""
+
+    name: str | None = Field(default=None, description="Stage name")
+    ordinal: int | None = Field(default=None, description="Stage ordinal position")
+
+
+class StageUpdate(DevRevBaseModel):
+    """Stage update request."""
+
+    name: str | None = Field(default=None, description="Stage name to set")
+
+
+class CustomSchemaSpec(DevRevBaseModel):
+    """Custom schema specification."""
+
+    validate_required_fields: bool | None = Field(
+        default=None,
+        description="Whether to validate required custom fields",
+    )
+
+
+# Common ID patterns for DevRev resources
+# Format: PREFIX-XXXXX (e.g., ACC-12345, ISS-12345, DEVU-12345)

devrev/models/code_changes.py

@@ -0,0 +1,103 @@
+"""Code Change models for DevRev SDK."""
+
+from __future__ import annotations
+
+from datetime import datetime
+
+from pydantic import Field
+
+from devrev.models.base import (
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    UserSummary,
+)
+
+
+class CodeChange(DevRevResponseModel):
+    """DevRev Code Change model."""
+
+    id: str = Field(..., description="Code change ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    title: str | None = Field(default=None, description="Title")
+    description: str | None = Field(default=None, description="Description")
+    source_url: str | None = Field(default=None, description="Source URL")
+    repository: str | None = Field(default=None, description="Repository")
+    branch: str | None = Field(default=None, description="Branch")
+    created_by: UserSummary | None = Field(default=None, description="Creator")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class CodeChangeSummary(DevRevResponseModel):
+    """Summary of a Code Change."""
+
+    id: str = Field(..., description="Code change ID")
+    title: str | None = Field(default=None, description="Title")
+
+
+class CodeChangesCreateRequest(DevRevBaseModel):
+    """Request to create a code change."""
+
+    title: str = Field(..., description="Title")
+    description: str | None = Field(default=None, description="Description")
+    source_url: str | None = Field(default=None, description="Source URL")
+    repository: str | None = Field(default=None, description="Repository")
+    branch: str | None = Field(default=None, description="Branch")
+
+
+class CodeChangesGetRequest(DevRevBaseModel):
+    """Request to get a code change by ID."""
+
+    id: str = Field(..., description="Code change ID")
+
+
+class CodeChangesDeleteRequest(DevRevBaseModel):
+    """Request to delete a code change."""
+
+    id: str = Field(..., description="Code change ID to delete")
+
+
+class CodeChangesListRequest(DevRevBaseModel):
+    """Request to list code changes."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class CodeChangesUpdateRequest(DevRevBaseModel):
+    """Request to update a code change."""
+
+    id: str = Field(..., description="Code change ID")
+    title: str | None = Field(default=None, description="New title")
+    description: str | None = Field(default=None, description="New description")
+
+
+class CodeChangesCreateResponse(DevRevResponseModel):
+    """Response from creating a code change."""
+
+    code_change: CodeChange = Field(..., description="Created code change")
+
+
+class CodeChangesGetResponse(DevRevResponseModel):
+    """Response from getting a code change."""
+
+    code_change: CodeChange = Field(..., description="Retrieved code change")
+
+
+class CodeChangesListResponse(PaginatedResponse):
+    """Response from listing code changes."""
+
+    code_changes: list[CodeChange] = Field(..., description="List of code changes")
+
+
+class CodeChangesUpdateResponse(DevRevResponseModel):
+    """Response from updating a code change."""
+
+    code_change: CodeChange = Field(..., description="Updated code change")
+
+
+class CodeChangesDeleteResponse(DevRevResponseModel):
+    """Response from deleting a code change."""
+
+    pass

devrev/models/conversations.py

@@ -0,0 +1,115 @@
+"""Conversation 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,
+    StageInfo,
+    UserSummary,
+)
+
+
+class Conversation(DevRevResponseModel):
+    """DevRev Conversation model."""
+
+    id: str = Field(..., description="Conversation ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    title: str | None = Field(default=None, description="Title")
+    description: str | None = Field(default=None, description="Description")
+    stage: StageInfo | dict[str, Any] | str | None = Field(
+        default=None, description="Current stage (string name or structured info)"
+    )
+    created_by: UserSummary | None = Field(default=None, description="Creator")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class ConversationSummary(DevRevResponseModel):
+    """Summary of a Conversation."""
+
+    id: str = Field(..., description="Conversation ID")
+    title: str | None = Field(default=None, description="Title")
+
+
+class ConversationsCreateRequest(DevRevBaseModel):
+    """Request to create a conversation."""
+
+    type: str = Field(default="support", description="Conversation type")
+    title: str | None = Field(default=None, description="Title")
+    description: str | None = Field(default=None, description="Description")
+
+
+class ConversationsGetRequest(DevRevBaseModel):
+    """Request to get a conversation by ID."""
+
+    id: str = Field(..., description="Conversation ID")
+
+
+class ConversationsDeleteRequest(DevRevBaseModel):
+    """Request to delete a conversation."""
+
+    id: str = Field(..., description="Conversation ID to delete")
+
+
+class ConversationsListRequest(DevRevBaseModel):
+    """Request to list conversations."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class ConversationsUpdateRequest(DevRevBaseModel):
+    """Request to update a conversation."""
+
+    id: str = Field(..., description="Conversation ID")
+    title: str | None = Field(default=None, description="New title")
+    description: str | None = Field(default=None, description="New description")
+
+
+class ConversationsExportRequest(DevRevBaseModel):
+    """Request to export conversations."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+
+
+class ConversationsCreateResponse(DevRevResponseModel):
+    """Response from creating a conversation."""
+
+    conversation: Conversation = Field(..., description="Created conversation")
+
+
+class ConversationsGetResponse(DevRevResponseModel):
+    """Response from getting a conversation."""
+
+    conversation: Conversation = Field(..., description="Retrieved conversation")
+
+
+class ConversationsListResponse(PaginatedResponse):
+    """Response from listing conversations."""
+
+    conversations: list[Conversation] = Field(..., description="List of conversations")
+
+
+class ConversationsUpdateResponse(DevRevResponseModel):
+    """Response from updating a conversation."""
+
+    conversation: Conversation = Field(..., description="Updated conversation")
+
+
+class ConversationsDeleteResponse(DevRevResponseModel):
+    """Response from deleting a conversation."""
+
+    pass
+
+
+class ConversationsExportResponse(PaginatedResponse):
+    """Response from exporting conversations."""
+
+    conversations: list[Conversation] = Field(..., description="Exported conversations")