""" Options:
Date: 2026-04-04 02:55:08
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: GetConnectionsToContact.*
#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 ContactSummaryModel:
    # @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    contact_id: Optional[str] = None
    """
    Contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    contact_full_name: Optional[str] = None
    """
    Full name of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    email_address: Optional[str] = None
    """
    Email Address of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
    mobile_number: Optional[str] = None
    """
    Mobile Number of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
    phone_number: Optional[str] = None
    """
    Primary Phone Number of the contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
    contact_type_id: Optional[str] = None
    """
    Type of contact (person, organisation etc.) linked to the profile
    """


    # @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    profile_photo_url: Optional[str] = None
    """
    Profile photo of contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    profile_photo_thumbnail_url: Optional[str] = None
    """
    Thumbnail photo of contact linked to the profile
    """


    # @ApiMember(DataType="string", Description="Profile description", Name="Description")
    description: Optional[str] = None
    """
    Profile description
    """


    # @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    employment_industry: Optional[str] = None
    """
    Employment Industry
    """


    # @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    employment_role: Optional[str] = None
    """
    Employment Role
    """


    # @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    employment_geographic_area: Optional[str] = None
    """
    Areas of Work
    """


    # @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    timezone_name: Optional[str] = None
    """
    Timezone Name
    """


    # @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    primary_address: Optional[str] = None
    """
    The primary address of the contact
    """


    # @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    is_removed_contact: bool = False
    """
    Have all connections to the contact been removed?
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactConnectionModel:
    # @ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")
    connection_id: Optional[str] = None
    """
    Connection Id (if applicable)
    """


    # @ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")
    connection_request_id: Optional[str] = None
    """
    Connection Request Id (if applicable)
    """


    # @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")
    contact: Optional[ContactSummaryModel] = None
    """
    Details of the contact
    """


    # @ApiMember(DataType="Guid", Description="Contact's role Id in the connection", IsRequired=true, Name="ContactRoleId")
    contact_role_id: Optional[str] = None
    """
    Contact's role Id in the connection
    """


    # @ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")
    contact_role_name: Optional[str] = None
    """
    Contact's role name in the connection
    """


    # @ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")
    requestor_contact_id: Optional[str] = None
    """
    Requestor Contact Id
    """


    # @ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")
    requestor_contact_name: Optional[str] = None
    """
    Requestor Contact Name
    """


    # @ApiMember(DataType="Guid", Description="Requestor contact's role Id in the connection", IsRequired=true, Name="RequestorRoleId")
    requestor_role_id: Optional[str] = None
    """
    Requestor contact's role Id in the connection
    """


    # @ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")
    requestor_role_name: Optional[str] = None
    """
    Requestor's role name in the connection
    """


    # @ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")
    primary_role_name: Optional[str] = None
    """
    Primary role in the connection to display
    """


    # @ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")
    connection_status_id: Optional[str] = None
    """
    Connection Status Id
    """


    # @ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")
    connection_status_name: Optional[str] = None
    """
    Connection Status Name
    """


    # @ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")
    is_connection_request: bool = False
    """
    Is this a pending connection request?
    """


    # @ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")
    is_incoming: bool = False
    """
    Is this an incoming connection request?
    """


    from_date: Optional[datetime.datetime] = None
    # @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact suggesting this connection", IsRequired=true, Name="SuggesterContact")
    suggester_contact: Optional[ContactSummaryModel] = None
    """
    Details of the contact suggesting this connection
    """


    # @ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")
    allow_cancel: bool = False
    """
    Can this connection be cancelled?
    """


    # @ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")
    allow_remove: bool = False
    """
    Can this connection be removed?
    """


# @ApiResponse(Description="Connections to the specified contact for the requestor contact")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetConnectionsToContactResponse:
    connections: Optional[List[ContactConnectionModel]] = None
    total_connections: int = 0
    response_status: Optional[ResponseStatus] = None


# @Route("/contacts/{ContactId}/connections")
# @Api(Description="Get connections to the specified contact for the requestor contact")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetConnectionsToContact(PagedModel, IReturn[GetConnectionsToContactResponse]):
    """
    Get connections to the specified contact for the requestor contact
    """

    # @ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")
    contact_id: Optional[str] = None
    """
    Contact Id to get connections for
    """


    # @ApiMember(DataType="Guid", Description="Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)", IsRequired=true, Name="ContactTypeId")
    contact_type_id: Optional[str] = None
    """
    Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
    """


    # @ApiMember(DataType="Guid", Description="Contact Id requesting the details - Current user or licensee", IsRequired=true, Name="RequestorContactId")
    requestor_contact_id: Optional[str] = None
    """
    Contact Id requesting the details - Current user or licensee
    """


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


    # @ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")
    include_removed: bool = False
    """
    Option to return removed connections
    """