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

devrev/models/rev_users.py

@@ -0,0 +1,177 @@
+"""Rev User models for DevRev SDK.
+
+This module contains Pydantic models for Rev User-related API operations.
+Rev Users are external customer users in DevRev.
+"""
+
+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,
+    DateTimeFilter,
+    DevRevBaseModel,
+    DevRevResponseModel,
+    OrgSummary,
+    PaginatedResponse,
+    UserSummary,
+)
+
+
+class RevUserState(str, Enum):
+    """Rev user state enumeration."""
+
+    ACTIVE = "active"
+    DELETED = "deleted"
+
+
+class RevUser(DevRevResponseModel):
+    """DevRev Rev User model.
+
+    Represents an external customer user in DevRev.
+    """
+
+    id: str = Field(..., description="Rev user ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="User's display name")
+    display_picture: str | None = Field(default=None, description="Profile picture artifact ID")
+    description: str | None = Field(default=None, description="User description")
+    email: str | None = Field(default=None, description="Email address")
+    phone_numbers: list[str] | None = Field(default=None, description="Phone numbers")
+    state: RevUserState | None = Field(default=None, description="User state")
+    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 user"
+    )
+    modified_by: UserSummary | None = Field(
+        default=None, description="User who last modified this rev user"
+    )
+    rev_org: OrgSummary | None = Field(default=None, description="Associated Rev organization")
+    external_ref: str | None = Field(default=None, description="External reference identifier")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+
+
+class RevUserSummary(DevRevResponseModel):
+    """Summary of a Rev User for list/reference operations."""
+
+    id: str = Field(..., description="Rev user ID")
+    display_id: str | None = Field(default=None, description="Human-readable display ID")
+    display_name: str | None = Field(default=None, description="User's display name")
+    email: str | None = Field(default=None, description="Email address")
+    rev_org: OrgSummary | None = Field(default=None, description="Associated Rev organization")
+
+
+# Request Models
+
+
+class RevUsersCreateRequest(DevRevBaseModel):
+    """Request to create a Rev user."""
+
+    rev_org: str = Field(..., description="Rev organization ID to associate with")
+    description: str | None = Field(default=None, description="User description")
+    display_name: str | None = Field(default=None, description="Display name")
+    display_picture: str | None = Field(default=None, description="Profile picture artifact ID")
+    email: str | None = Field(default=None, description="Email address")
+    external_ref: str | None = Field(default=None, description="External reference identifier")
+    phone_numbers: list[str] | None = Field(default=None, description="Phone numbers")
+    custom_schema_spec: CustomSchemaSpec | None = Field(
+        default=None, description="Custom schema spec"
+    )
+
+
+class RevUsersGetRequest(DevRevBaseModel):
+    """Request to get a Rev user by ID."""
+
+    id: str = Field(..., description="Rev user ID")
+
+
+class RevUsersListRequest(DevRevBaseModel):
+    """Request to list Rev users."""
+
+    associations: list[str] | None = Field(
+        default=None, description="Filter by account/workspace IDs"
+    )
+    created_by: list[str] | None = Field(default=None, description="Filter by creator user IDs")
+    created_date: DateTimeFilter | None = Field(default=None, description="Filter by creation date")
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    email: list[str] | None = Field(default=None, description="Filter by emails")
+    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: DateTimeFilter | None = Field(
+        default=None, description="Filter by modification date"
+    )
+    rev_org: list[str] | None = Field(default=None, description="Filter by Rev org IDs")
+    sort_by: list[str] | None = Field(default=None, description="Sort order")
+
+
+class RevUsersUpdateRequest(DevRevBaseModel):
+    """Request to update a Rev user."""
+
+    id: str = Field(..., description="Rev user ID")
+    description: str | None = Field(default=None, description="New description")
+    display_name: str | None = Field(default=None, description="New display name")
+    display_picture: str | None = Field(default=None, description="New profile picture artifact ID")
+    email: str | None = Field(default=None, description="New email address")
+    external_ref: str | None = Field(default=None, description="New external reference")
+    phone_numbers: list[str] | None = Field(default=None, description="New phone numbers")
+    custom_fields: dict[str, Any] | None = Field(
+        default=None, description="Custom fields to update"
+    )
+
+
+class RevUsersDeleteRequest(DevRevBaseModel):
+    """Request to delete a Rev user."""
+
+    id: str = Field(..., description="Rev user ID to delete")
+
+
+class RevUsersMergeRequest(DevRevBaseModel):
+    """Request to merge Rev users."""
+
+    primary_user: str = Field(..., description="Primary user ID (will be retained)")
+    secondary_user: str = Field(..., description="Secondary user ID (will be merged)")
+
+
+# Response Models
+
+
+class RevUsersCreateResponse(DevRevResponseModel):
+    """Response from creating a Rev user."""
+
+    rev_user: RevUser = Field(..., description="Created Rev user")
+
+
+class RevUsersGetResponse(DevRevResponseModel):
+    """Response from getting a Rev user."""
+
+    rev_user: RevUser = Field(..., description="Retrieved Rev user")
+
+
+class RevUsersListResponse(PaginatedResponse):
+    """Response from listing Rev users."""
+
+    rev_users: list[RevUser] = Field(..., description="List of Rev users")
+
+
+class RevUsersUpdateResponse(DevRevResponseModel):
+    """Response from updating a Rev user."""
+
+    rev_user: RevUser = Field(..., description="Updated Rev user")
+
+
+class RevUsersDeleteResponse(DevRevResponseModel):
+    """Response from deleting a Rev user."""
+
+    pass  # Empty response body
+
+
+class RevUsersMergeResponse(DevRevResponseModel):
+    """Response from merging Rev users."""
+
+    pass  # Empty response body (async processing)

devrev/models/slas.py

@@ -0,0 +1,112 @@
+"""SLA 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
+
+
+class SlaStatus(str, Enum):
+    """SLA policy status enumeration."""
+
+    DRAFT = "draft"
+    PUBLISHED = "published"
+    ARCHIVED = "archived"
+
+
+class SlaTrackerStatus(str, Enum):
+    """SLA tracker status enumeration (for active SLA tracking)."""
+
+    ACTIVE = "active"
+    PAUSED = "paused"
+    BREACHED = "breached"
+    COMPLETED = "completed"
+
+
+class Sla(DevRevResponseModel):
+    """DevRev SLA model."""
+
+    id: str = Field(..., description="SLA ID")
+    name: str = Field(..., description="SLA name")
+    description: str | None = Field(default=None, description="SLA description")
+    status: str | None = Field(default=None, description="SLA status (draft/published/archived)")
+    target_time: int | None = Field(default=None, description="Target time in minutes")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class SlaSummary(DevRevResponseModel):
+    """Summary of an SLA."""
+
+    id: str = Field(..., description="SLA ID")
+    name: str | None = Field(default=None, description="SLA name")
+
+
+class SlasCreateRequest(DevRevBaseModel):
+    """Request to create an SLA."""
+
+    name: str = Field(..., description="SLA name")
+    description: str | None = Field(default=None, description="Description")
+    target_time: int | None = Field(default=None, description="Target time in minutes")
+
+
+class SlasGetRequest(DevRevBaseModel):
+    """Request to get an SLA by ID."""
+
+    id: str = Field(..., description="SLA ID")
+
+
+class SlasListRequest(DevRevBaseModel):
+    """Request to list SLAs."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class SlasUpdateRequest(DevRevBaseModel):
+    """Request to update an SLA."""
+
+    id: str = Field(..., description="SLA ID")
+    name: str | None = Field(default=None, description="New name")
+    description: str | None = Field(default=None, description="New description")
+
+
+class SlasTransitionRequest(DevRevBaseModel):
+    """Request to transition an SLA status."""
+
+    id: str = Field(..., description="SLA ID")
+    status: str | SlaStatus | SlaTrackerStatus = Field(..., description="New status")
+
+
+class SlasCreateResponse(DevRevResponseModel):
+    """Response from creating an SLA."""
+
+    sla: Sla = Field(..., description="Created SLA")
+
+
+class SlasGetResponse(DevRevResponseModel):
+    """Response from getting an SLA."""
+
+    sla: Sla = Field(..., description="Retrieved SLA")
+
+
+class SlasListResponse(PaginatedResponse):
+    """Response from listing SLAs."""
+
+    slas: list[Sla] = Field(..., description="List of SLAs")
+
+
+class SlasUpdateResponse(DevRevResponseModel):
+    """Response from updating an SLA."""
+
+    sla: Sla = Field(..., description="Updated SLA")
+
+
+class SlasTransitionResponse(DevRevResponseModel):
+    """Response from transitioning an SLA."""
+
+    sla: Sla = Field(..., description="Transitioned SLA")

devrev/models/tags.py

@@ -0,0 +1,90 @@
+"""Tag 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 Tag(DevRevResponseModel):
+    """DevRev Tag model."""
+
+    id: str = Field(..., description="Tag ID")
+    name: str = Field(..., description="Tag name")
+    description: str | None = Field(default=None, description="Tag description")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class TagSummary(DevRevResponseModel):
+    """Summary of a Tag."""
+
+    id: str = Field(..., description="Tag ID")
+    name: str | None = Field(default=None, description="Tag name")
+
+
+class TagsCreateRequest(DevRevBaseModel):
+    """Request to create a tag."""
+
+    name: str = Field(..., description="Tag name")
+    description: str | None = Field(default=None, description="Tag description")
+
+
+class TagsGetRequest(DevRevBaseModel):
+    """Request to get a tag by ID."""
+
+    id: str = Field(..., description="Tag ID")
+
+
+class TagsDeleteRequest(DevRevBaseModel):
+    """Request to delete a tag."""
+
+    id: str = Field(..., description="Tag ID to delete")
+
+
+class TagsListRequest(DevRevBaseModel):
+    """Request to list tags."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class TagsUpdateRequest(DevRevBaseModel):
+    """Request to update a tag."""
+
+    id: str = Field(..., description="Tag ID")
+    name: str | None = Field(default=None, description="New name")
+    description: str | None = Field(default=None, description="New description")
+
+
+class TagsCreateResponse(DevRevResponseModel):
+    """Response from creating a tag."""
+
+    tag: Tag = Field(..., description="Created tag")
+
+
+class TagsGetResponse(DevRevResponseModel):
+    """Response from getting a tag."""
+
+    tag: Tag = Field(..., description="Retrieved tag")
+
+
+class TagsListResponse(PaginatedResponse):
+    """Response from listing tags."""
+
+    tags: list[Tag] = Field(..., description="List of tags")
+
+
+class TagsUpdateResponse(DevRevResponseModel):
+    """Response from updating a tag."""
+
+    tag: Tag = Field(..., description="Updated tag")
+
+
+class TagsDeleteResponse(DevRevResponseModel):
+    """Response from deleting a tag."""
+
+    pass

devrev/models/timeline_entries.py

@@ -0,0 +1,100 @@
+"""Timeline Entry 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 TimelineEntryType(str, Enum):
+    """Timeline entry type enumeration."""
+
+    COMMENT = "timeline_comment"
+    NOTE = "timeline_note"
+    EVENT = "timeline_event"
+
+
+class TimelineEntry(DevRevResponseModel):
+    """DevRev Timeline Entry model."""
+
+    id: str = Field(..., description="Timeline entry ID")
+    type: TimelineEntryType | None = Field(default=None, description="Entry type")
+    body: str | None = Field(default=None, description="Entry content")
+    object: str | None = Field(default=None, description="Parent object ID")
+    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 TimelineEntriesCreateRequest(DevRevBaseModel):
+    """Request to create a timeline entry."""
+
+    object: str = Field(..., description="Parent object ID")
+    type: TimelineEntryType = Field(..., description="Entry type")
+    body: str | None = Field(default=None, description="Entry content")
+
+
+class TimelineEntriesGetRequest(DevRevBaseModel):
+    """Request to get a timeline entry by ID."""
+
+    id: str = Field(..., description="Timeline entry ID")
+
+
+class TimelineEntriesDeleteRequest(DevRevBaseModel):
+    """Request to delete a timeline entry."""
+
+    id: str = Field(..., description="Timeline entry ID to delete")
+
+
+class TimelineEntriesListRequest(DevRevBaseModel):
+    """Request to list timeline entries."""
+
+    object: str = Field(..., description="Parent object ID")
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class TimelineEntriesUpdateRequest(DevRevBaseModel):
+    """Request to update a timeline entry."""
+
+    id: str = Field(..., description="Timeline entry ID")
+    body: str | None = Field(default=None, description="New content")
+
+
+class TimelineEntriesCreateResponse(DevRevResponseModel):
+    """Response from creating a timeline entry."""
+
+    timeline_entry: TimelineEntry = Field(..., description="Created entry")
+
+
+class TimelineEntriesGetResponse(DevRevResponseModel):
+    """Response from getting a timeline entry."""
+
+    timeline_entry: TimelineEntry = Field(..., description="Retrieved entry")
+
+
+class TimelineEntriesListResponse(PaginatedResponse):
+    """Response from listing timeline entries."""
+
+    timeline_entries: list[TimelineEntry] = Field(..., description="List of entries")
+
+
+class TimelineEntriesUpdateResponse(DevRevResponseModel):
+    """Response from updating a timeline entry."""
+
+    timeline_entry: TimelineEntry = Field(..., description="Updated entry")
+
+
+class TimelineEntriesDeleteResponse(DevRevResponseModel):
+    """Response from deleting a timeline entry."""
+
+    pass

devrev/models/webhooks.py

@@ -0,0 +1,109 @@
+"""Webhook 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 WebhookStatus(str, Enum):
+    """Webhook status enumeration."""
+
+    ACTIVE = "active"
+    INACTIVE = "inactive"
+
+
+class Webhook(DevRevResponseModel):
+    """DevRev Webhook model."""
+
+    id: str = Field(..., description="Webhook ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    url: str = Field(..., description="Webhook URL")
+    status: WebhookStatus | None = Field(default=None, description="Status")
+    event_types: list[str] | None = Field(default=None, description="Event types")
+    secret: str | None = Field(default=None, description="Webhook secret")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+    created_by: UserSummary | None = Field(default=None, description="Creator")
+
+
+class WebhookSummary(DevRevResponseModel):
+    """Summary of a Webhook."""
+
+    id: str = Field(..., description="Webhook ID")
+    url: str | None = Field(default=None, description="Webhook URL")
+
+
+class WebhooksCreateRequest(DevRevBaseModel):
+    """Request to create a webhook."""
+
+    url: str = Field(..., description="Webhook URL")
+    event_types: list[str] | None = Field(default=None, description="Event types")
+    secret: str | None = Field(default=None, description="Webhook secret")
+
+
+class WebhooksGetRequest(DevRevBaseModel):
+    """Request to get a webhook by ID."""
+
+    id: str = Field(..., description="Webhook ID")
+
+
+class WebhooksDeleteRequest(DevRevBaseModel):
+    """Request to delete a webhook."""
+
+    id: str = Field(..., description="Webhook ID to delete")
+
+
+class WebhooksListRequest(DevRevBaseModel):
+    """Request to list webhooks."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class WebhooksUpdateRequest(DevRevBaseModel):
+    """Request to update a webhook."""
+
+    id: str = Field(..., description="Webhook ID")
+    url: str | None = Field(default=None, description="New URL")
+    event_types: list[str] | None = Field(default=None, description="Event types")
+    status: WebhookStatus | None = Field(default=None, description="New status")
+
+
+class WebhooksCreateResponse(DevRevResponseModel):
+    """Response from creating a webhook."""
+
+    webhook: Webhook = Field(..., description="Created webhook")
+
+
+class WebhooksGetResponse(DevRevResponseModel):
+    """Response from getting a webhook."""
+
+    webhook: Webhook = Field(..., description="Retrieved webhook")
+
+
+class WebhooksListResponse(PaginatedResponse):
+    """Response from listing webhooks."""
+
+    webhooks: list[Webhook] = Field(..., description="List of webhooks")
+
+
+class WebhooksUpdateResponse(DevRevResponseModel):
+    """Response from updating a webhook."""
+
+    webhook: Webhook = Field(..., description="Updated webhook")
+
+
+class WebhooksDeleteResponse(DevRevResponseModel):
+    """Response from deleting a webhook."""
+
+    pass