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

devrev/models/dev_users.py

@@ -0,0 +1,258 @@
+"""Dev User models for DevRev SDK.
+
+This module contains Pydantic models for Dev User-related API operations.
+Dev Users are internal organization 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,
+    DateFilter,
+    DevRevBaseModel,
+    DevRevResponseModel,
+    PaginatedResponse,
+    UserSummary,
+)
+
+
+class DevUserState(str, Enum):
+    """Dev user state enumeration."""
+
+    ACTIVE = "active"
+    DEACTIVATED = "deactivated"
+    SHADOW = "shadow"
+
+
+class DevUserExternalIdentity(DevRevResponseModel):
+    """External identity linked to a Dev user."""
+
+    id: str = Field(..., description="External identity ID")
+    issuer: str = Field(..., description="Identity issuer")
+    display_name: str | None = Field(default=None, description="Display name in external source")
+
+
+class DevUser(DevRevResponseModel):
+    """DevRev Dev User model.
+
+    Represents an internal organization user in DevRev.
+    """
+
+    id: str = Field(..., description="Dev 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")
+    email: str | None = Field(default=None, description="Email address")
+    full_name: str | None = Field(default=None, description="Full name")
+    phone_numbers: list[str] | None = Field(default=None, description="Phone numbers")
+    state: DevUserState | 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")
+    external_identities: list[DevUserExternalIdentity] | None = Field(
+        default=None, description="Linked external identities"
+    )
+    reports_to: UserSummary | None = Field(default=None, description="Manager")
+    custom_fields: dict[str, Any] | None = Field(default=None, description="Custom fields")
+
+
+class DevUserSummary(DevRevResponseModel):
+    """Summary of a Dev User for list/reference operations."""
+
+    id: str = Field(..., description="Dev 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")
+
+
+# Request Models
+
+
+class DevUserExternalIdentityFilter(DevRevBaseModel):
+    """Filter for Dev user external identity."""
+
+    id: str | None = Field(default=None, description="External identity ID")
+    issuer: str | None = Field(default=None, description="Identity issuer")
+
+
+class DevUsersCreateRequestStateEnum(str, Enum):
+    """Allowed states for Dev user creation."""
+
+    SHADOW = "shadow"
+
+
+class DevUsersCreateRequest(DevRevBaseModel):
+    """Request to create a Dev user."""
+
+    email: str = Field(..., description="Email address")
+    state: DevUsersCreateRequestStateEnum = Field(
+        ..., description="Initial user state (must be shadow)"
+    )
+    display_name: str | None = Field(default=None, description="Display name")
+    full_name: str | None = Field(default=None, description="Full name")
+    reports_to: str | None = Field(default=None, description="Manager user ID")
+    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 DevUsersGetRequest(DevRevBaseModel):
+    """Request to get a Dev user by ID."""
+
+    id: str = Field(..., description="Dev user ID")
+
+
+class DevUsersListRequest(DevRevBaseModel):
+    """Request to list Dev users."""
+
+    created_date: DateFilter | 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_identity: list[DevUserExternalIdentityFilter] | None = Field(
+        default=None, description="Filter by external identity"
+    )
+    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"
+    )
+    phone_numbers: list[str] | None = Field(default=None, description="Filter by phone numbers")
+    sort_by: list[str] | None = Field(default=None, description="Sort order")
+    state: list[DevUserState] | None = Field(default=None, description="Filter by states")
+
+
+class DevUsersUpdateRequest(DevRevBaseModel):
+    """Request to update a Dev user."""
+
+    id: str = Field(..., description="Dev user ID")
+    display_name: str | None = Field(default=None, description="New display name")
+    display_picture: str | None = Field(default=None, description="New profile picture artifact ID")
+    full_name: str | None = Field(default=None, description="New full name")
+    reports_to: str | None = Field(default=None, description="New manager user ID")
+    custom_fields: dict[str, Any] | None = Field(
+        default=None, description="Custom fields to update"
+    )
+
+
+class DevUsersActivateRequest(DevRevBaseModel):
+    """Request to activate a Dev user."""
+
+    id: str = Field(..., description="Dev user ID")
+
+
+class DevUsersDeactivateRequest(DevRevBaseModel):
+    """Request to deactivate a Dev user."""
+
+    id: str = Field(..., description="Dev user ID")
+
+
+class DevUsersIdentitiesLinkRequest(DevRevBaseModel):
+    """Request to link an external identity to a Dev user."""
+
+    dev_user: str = Field(..., description="Dev user ID")
+    id: str = Field(..., description="External identity ID")
+    issuer: str = Field(..., description="Identity issuer")
+    display_name: str | None = Field(default=None, description="Display name in external source")
+
+
+class DevUsersIdentitiesUnlinkRequest(DevRevBaseModel):
+    """Request to unlink an external identity from a Dev user."""
+
+    dev_user: str = Field(..., description="Dev user ID")
+    id: str = Field(..., description="External identity ID")
+    issuer: str = Field(..., description="Identity issuer")
+
+
+class DevUsersSelfUpdateRequest(DevRevBaseModel):
+    """Request to update the authenticated user."""
+
+    display_name: str | None = Field(default=None, description="New display name")
+    display_picture: str | None = Field(default=None, description="New profile picture artifact ID")
+    full_name: str | None = Field(default=None, description="New full name")
+
+
+class DevUsersSelfRequest(DevRevBaseModel):
+    """Request to get the authenticated user (self)."""
+
+    pass  # Empty request body
+
+
+class DevUsersMergeRequest(DevRevBaseModel):
+    """Request to merge two Dev 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 DevUsersCreateResponse(DevRevResponseModel):
+    """Response from creating a Dev user."""
+
+    dev_user: DevUser = Field(..., description="Created Dev user")
+
+
+class DevUsersGetResponse(DevRevResponseModel):
+    """Response from getting a Dev user."""
+
+    dev_user: DevUser = Field(..., description="Retrieved Dev user")
+
+
+class DevUsersListResponse(PaginatedResponse):
+    """Response from listing Dev users."""
+
+    dev_users: list[DevUser] = Field(..., description="List of Dev users")
+
+
+class DevUsersUpdateResponse(DevRevResponseModel):
+    """Response from updating a Dev user."""
+
+    dev_user: DevUser = Field(..., description="Updated Dev user")
+
+
+class DevUsersActivateResponse(DevRevResponseModel):
+    """Response from activating a Dev user."""
+
+    dev_user: DevUser = Field(..., description="Activated Dev user")
+
+
+class DevUsersDeactivateResponse(DevRevResponseModel):
+    """Response from deactivating a Dev user."""
+
+    pass  # Empty response body
+
+
+class DevUsersIdentitiesLinkResponse(DevRevResponseModel):
+    """Response from linking an external identity."""
+
+    dev_user: DevUser = Field(..., description="Updated Dev user")
+
+
+class DevUsersIdentitiesUnlinkResponse(DevRevResponseModel):
+    """Response from unlinking an external identity."""
+
+    dev_user: DevUser = Field(..., description="Updated Dev user")
+
+
+class DevUsersMergeResponse(DevRevResponseModel):
+    """Response from merging Dev users."""
+
+    pass  # Empty response body
+
+
+class DevUsersSelfResponse(DevRevResponseModel):
+    """Response from getting the authenticated user."""
+
+    dev_user: DevUser = Field(..., description="Authenticated Dev user")
+
+
+class DevUsersSelfUpdateResponse(DevRevResponseModel):
+    """Response from updating the authenticated user."""
+
+    dev_user: DevUser = Field(..., description="Updated Dev user")

devrev/models/groups.py

@@ -0,0 +1,140 @@
+"""Group 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 GroupType(str, Enum):
+    """Group type enumeration."""
+
+    STATIC = "static"
+    DYNAMIC = "dynamic"
+
+
+class Group(DevRevResponseModel):
+    """DevRev Group model."""
+
+    id: str = Field(..., description="Group ID")
+    name: str = Field(..., description="Group name")
+    description: str | None = Field(default=None, description="Description")
+    type: GroupType | None = Field(default=None, description="Group type")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class GroupSummary(DevRevResponseModel):
+    """Summary of a Group."""
+
+    id: str = Field(..., description="Group ID")
+    name: str | None = Field(default=None, description="Group name")
+
+
+class GroupMember(DevRevResponseModel):
+    """Group member model."""
+
+    id: str = Field(..., description="Member ID")
+    member: UserSummary | None = Field(default=None, description="Member details")
+
+
+class GroupsCreateRequest(DevRevBaseModel):
+    """Request to create a group."""
+
+    name: str = Field(..., description="Group name")
+    description: str | None = Field(default=None, description="Description")
+    type: GroupType | None = Field(default=None, description="Group type")
+
+
+class GroupsGetRequest(DevRevBaseModel):
+    """Request to get a group by ID."""
+
+    id: str = Field(..., description="Group ID")
+
+
+class GroupsListRequest(DevRevBaseModel):
+    """Request to list groups."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class GroupsUpdateRequest(DevRevBaseModel):
+    """Request to update a group."""
+
+    id: str = Field(..., description="Group ID")
+    name: str | None = Field(default=None, description="New name")
+    description: str | None = Field(default=None, description="New description")
+
+
+class GroupMembersAddRequest(DevRevBaseModel):
+    """Request to add members to a group."""
+
+    group: str = Field(..., description="Group ID")
+    member: str = Field(..., description="Member ID to add")
+
+
+class GroupMembersRemoveRequest(DevRevBaseModel):
+    """Request to remove members from a group."""
+
+    group: str = Field(..., description="Group ID")
+    member: str = Field(..., description="Member ID to remove")
+
+
+class GroupMembersListRequest(DevRevBaseModel):
+    """Request to list group members."""
+
+    group: str = Field(..., description="Group ID")
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+
+
+class GroupsCreateResponse(DevRevResponseModel):
+    """Response from creating a group."""
+
+    group: Group = Field(..., description="Created group")
+
+
+class GroupsGetResponse(DevRevResponseModel):
+    """Response from getting a group."""
+
+    group: Group = Field(..., description="Retrieved group")
+
+
+class GroupsListResponse(PaginatedResponse):
+    """Response from listing groups."""
+
+    groups: list[Group] = Field(..., description="List of groups")
+
+
+class GroupsUpdateResponse(DevRevResponseModel):
+    """Response from updating a group."""
+
+    group: Group = Field(..., description="Updated group")
+
+
+class GroupMembersAddResponse(DevRevResponseModel):
+    """Response from adding members."""
+
+    pass
+
+
+class GroupMembersRemoveResponse(DevRevResponseModel):
+    """Response from removing members."""
+
+    pass
+
+
+class GroupMembersListResponse(PaginatedResponse):
+    """Response from listing members."""
+
+    members: list[GroupMember] = Field(..., description="List of members")

devrev/models/links.py

@@ -0,0 +1,107 @@
+"""Link models for DevRev SDK."""
+
+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 (
+    DevRevBaseModel,
+    DevRevResponseModel,
+    ObjectSummary,
+    PaginatedResponse,
+)
+
+
+class LinkType(str, Enum):
+    """Link type enumeration.
+
+    Note: Additional link types may exist in the API. Unknown values
+    will be handled gracefully via Pydantic's extra='ignore' setting.
+    """
+
+    IS_BLOCKED_BY = "is_blocked_by"
+    IS_DEPENDENT_ON = "is_dependent_on"
+    IS_DEVELOPED_WITH = "is_developed_with"
+    IS_DUPLICATE_OF = "is_duplicate_of"
+    IS_OWNED_BY = "is_owned_by"
+    IS_PARENT_OF = "is_parent_of"
+    IS_PART_OF = "is_part_of"
+    IS_RELATED_TO = "is_related_to"
+    SERVES = "serves"
+
+
+class Link(DevRevResponseModel):
+    """DevRev Link model."""
+
+    id: str = Field(..., description="Link ID")
+    link_type: str = Field(..., description="Type of link (may be LinkType enum value or custom)")
+    source: str | ObjectSummary | dict[str, Any] = Field(
+        ..., description="Source object (ID or summary)"
+    )
+    target: str | ObjectSummary | dict[str, Any] = Field(
+        ..., description="Target object (ID or summary)"
+    )
+    created_date: datetime | None = Field(default=None, description="Creation date")
+
+
+class LinkSummary(DevRevResponseModel):
+    """Summary of a Link."""
+
+    id: str = Field(..., description="Link ID")
+    link_type: str | None = Field(default=None, description="Link type")
+
+
+class LinksCreateRequest(DevRevBaseModel):
+    """Request to create a link."""
+
+    link_type: str | LinkType = Field(..., description="Type of link")
+    source: str = Field(..., description="Source object ID")
+    target: str = Field(..., description="Target object ID")
+
+
+class LinksGetRequest(DevRevBaseModel):
+    """Request to get a link by ID."""
+
+    id: str = Field(..., description="Link ID")
+
+
+class LinksDeleteRequest(DevRevBaseModel):
+    """Request to delete a link."""
+
+    id: str = Field(..., description="Link ID to delete")
+
+
+class LinksListRequest(DevRevBaseModel):
+    """Request to list links."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+    object: str | None = Field(default=None, description="Filter by object ID")
+
+
+class LinksCreateResponse(DevRevResponseModel):
+    """Response from creating a link."""
+
+    link: Link = Field(..., description="Created link")
+
+
+class LinksGetResponse(DevRevResponseModel):
+    """Response from getting a link."""
+
+    link: Link = Field(..., description="Retrieved link")
+
+
+class LinksListResponse(PaginatedResponse):
+    """Response from listing links."""
+
+    links: list[Link] = Field(..., description="List of links")
+
+
+class LinksDeleteResponse(DevRevResponseModel):
+    """Response from deleting a link."""
+
+    pass

devrev/models/parts.py

@@ -0,0 +1,110 @@
+"""Part 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 PartType(str, Enum):
+    """Part type enumeration."""
+
+    PRODUCT = "product"
+    CAPABILITY = "capability"
+    FEATURE = "feature"
+    ENHANCEMENT = "enhancement"
+
+
+class Part(DevRevResponseModel):
+    """DevRev Part model."""
+
+    id: str = Field(..., description="Part ID")
+    display_id: str | None = Field(default=None, description="Display ID")
+    name: str = Field(..., description="Part name")
+    type: PartType | None = Field(default=None, description="Part type")
+    description: str | None = Field(default=None, description="Description")
+    owned_by: list[UserSummary] | None = Field(default=None, description="Owners")
+    created_date: datetime | None = Field(default=None, description="Creation date")
+    modified_date: datetime | None = Field(default=None, description="Last modified")
+
+
+class PartSummary(DevRevResponseModel):
+    """Summary of a Part."""
+
+    id: str = Field(..., description="Part ID")
+    name: str | None = Field(default=None, description="Part name")
+
+
+class PartsCreateRequest(DevRevBaseModel):
+    """Request to create a part."""
+
+    name: str = Field(..., description="Part name")
+    type: PartType = Field(..., description="Part type")
+    description: str | None = Field(default=None, description="Description")
+
+
+class PartsGetRequest(DevRevBaseModel):
+    """Request to get a part by ID."""
+
+    id: str = Field(..., description="Part ID")
+
+
+class PartsDeleteRequest(DevRevBaseModel):
+    """Request to delete a part."""
+
+    id: str = Field(..., description="Part ID to delete")
+
+
+class PartsListRequest(DevRevBaseModel):
+    """Request to list parts."""
+
+    cursor: str | None = Field(default=None, description="Pagination cursor")
+    limit: int | None = Field(default=None, ge=1, le=100, description="Max results")
+    type: list[PartType] | None = Field(default=None, description="Filter by type")
+
+
+class PartsUpdateRequest(DevRevBaseModel):
+    """Request to update a part."""
+
+    id: str = Field(..., description="Part ID")
+    name: str | None = Field(default=None, description="New name")
+    description: str | None = Field(default=None, description="New description")
+
+
+class PartsCreateResponse(DevRevResponseModel):
+    """Response from creating a part."""
+
+    part: Part = Field(..., description="Created part")
+
+
+class PartsGetResponse(DevRevResponseModel):
+    """Response from getting a part."""
+
+    part: Part = Field(..., description="Retrieved part")
+
+
+class PartsListResponse(PaginatedResponse):
+    """Response from listing parts."""
+
+    parts: list[Part] = Field(..., description="List of parts")
+
+
+class PartsUpdateResponse(DevRevResponseModel):
+    """Response from updating a part."""
+
+    part: Part = Field(..., description="Updated part")
+
+
+class PartsDeleteResponse(DevRevResponseModel):
+    """Response from deleting a part."""
+
+    pass