""" Options:
Date: 2026-04-04 08:34:39
Version: 8.52
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: GetRelatedItems.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class SortOrder(str, Enum):
    ASCENDING = 'Ascending'
    DESCENDING = 'Descending'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PagedModel:
    # @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    page_number: int = 0
    """
    Page Number to retrieve
    """


    # @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    page_size: int = 0
    """
    Number of records to retrieve
    """


    # @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    sort_index: int = 0
    """
    Index of field to sort results by
    """


    # @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    sort_order: Optional[SortOrder] = None
    """
    Sort Order - Ascending or Descending
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelatedItemsModel:
    # @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Object linked to the related item.
    """


    # @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
    related_item_name: Optional[str] = None
    """
    Related item name.
    """


    # @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
    related_item_type: Optional[str] = None
    """
    Related item type.
    """


    # @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Date of creation of the related item.
    """


    # @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
    created_by_name: Optional[str] = None
    """
    Contact who created the related item
    """


    # @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
    created_by_id: Optional[str] = None
    """
    Contact who created the related item
    """


    # @ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")
    created_by_thumbnail_url: Optional[str] = None
    """
    Profile photo of the contact who created the related item
    """


    # @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
    relationship: Optional[str] = None
    """
    Relationship between objects linked to the related item
    """


    # @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
    is_significant: bool = False
    """
    Is the related item significant?
    """


# @ApiResponse(Description="Items related to the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRelatedItemsResponse:
    related_items: Optional[List[RelatedItemsModel]] = None
    total_related_items: int = 0
    response_status: Optional[ResponseStatus] = None


# @Route("/relateditems/{ObjectId}")
# @Api(Description="Get related items related to the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetRelatedItems(PagedModel, IReturn[GetRelatedItemsResponse]):
    """
    Get related items related to the specified object.
    """

    # @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
    object_id: Optional[str] = None
    """
    Object to get related items for.
    """


    # @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
    related_items_level: Optional[str] = None
    """
    Significant Only or All
    """


    # @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    is_paged_mode: bool = False
    """
    Return all connections or paged results?
    """