""" Options:
Date: 2026-04-04 01:02: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: GetContactGroups.*
#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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfileSummaryModel:
    # @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    user_profile_id: Optional[str] = None
    """
    User Profile Id
    """


    # @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    user_id: Optional[str] = None
    """
    User linked to the profile
    """


    # @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="User linked to the profile", Name="UserName")
    user_name: Optional[str] = None
    """
    User linked to the profile
    """


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


    # @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="Email signature of the contact linked to the profile", Name="EmailSignature")
    email_signature: Optional[str] = None
    """
    Email signature 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="Phone number of the contact linked to the profile", Name="PhoneNumber")
    phone_number: Optional[str] = None
    """
    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="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")
    contact_type_name: Optional[str] = None
    """
    Type of contact (person, organisation etc.) linked to the profile
    """


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


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


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


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


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


    # @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    abn: Optional[str] = None
    """
    Australian Business Number
    """


    # @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    acn: Optional[str] = None
    """
    Australian Company Number
    """


    # @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    arbn: Optional[str] = None
    """
    Australian Registered Body Number
    """


    # @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    gst_registered: bool = False
    """
    Indicates if the Contact is registered for GST.
    """


    # @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
    esl: bool = False
    """
    True if english is a secondary language for the contact.
    """


    # @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
    language: Optional[str] = None
    """
    Language that is the primary language for the contact.
    """


    # @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    interpreter_required: bool = False
    """
    True if an interpreter is required.
    """


    # @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
    licensee_notes: Optional[str] = None
    """
    Licensee specific notes about the contact.
    """


    # @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="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
    profile_image_id: Optional[str] = None
    """
    Profile photo id 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="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    timezone: Optional[str] = None
    """
    The contacts timezone.
    """


    # @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="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
    is_active_contact: bool = False
    """
    Is this an active contact? Or an inactive contact (deleted account)?
    """


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 RoleModel:
    # @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
    role_id: Optional[str] = None
    """
    Role Id
    """


    # @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    role_name: Optional[str] = None
    """
    Role Name
    """


    # @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
    is_licensee_role: bool = False
    """
    Is the role a licensee role?
    """


    # @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
    is_manage_contacts: bool = False
    """
    Is manage contacts role?
    """


    # @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
    is_platform_role: bool = False
    """
    Is the role a Platform role?
    """


    # @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
    is_service_role: bool = False
    """
    Is the role a services role?
    """


    # @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
    is_customer_role: bool = False
    """
    Is the role a customer role?
    """


    # @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
    is_functional_role: bool = False
    """
    Is the role a functional role?
    """


    # @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
    is_request_auto_accepted: bool = False
    """
    Is the role an auto-accept role?
    """


    # @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
    suite_id: Optional[str] = None
    """
    Suite that the role belongs to
    """


    # @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
    suite_name: Optional[str] = None
    """
    Suite that the role belongs to
    """


    # @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    'A' (Active) or 'I' (Inactive)
    """


    # @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
    object_connection_id: Optional[str] = None
    """
    Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactGroupConnectionModel(UserProfileSummaryModel):
    # @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
    contact_group_id: Optional[str] = None
    """
    Contact Group Id
    """


    # @ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
    contact_group_connection_id: Optional[str] = None
    """
    Connection id of the contact in the group
    """


    # @ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")
    connection_role_id: Optional[str] = None
    """
    The Id of the Role this contact is connected to the group with.
    """


    # @ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")
    index: int = 0
    """
    Order of contacts within a group, the primary contact will have an index of 1.
    """


    # @ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")
    contact_roles: Optional[List[RoleModel]] = None
    """
    List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerProjectModel:
    project_id: Optional[str] = None
    name: Optional[str] = None
    project_address: Optional[str] = None
    manager_contact_id: Optional[str] = None
    manager_contact_name: Optional[str] = None
    manager_profile_photo_url: Optional[str] = None
    manager_profile_photo_thumbnail_url: Optional[str] = None
    supervisor_contact_id: Optional[str] = None
    supervisor_contact_name: Optional[str] = None
    supervisor_profile_photo_url: Optional[str] = None
    supervisor_profile_photo_thumbnail_url: Optional[str] = None
    customer_service_contact_id: Optional[str] = None
    customer_service_contact_name: Optional[str] = None
    customer_service_profile_photo_url: Optional[str] = None
    customer_service_profile_photo_thumbnail: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactGroupModel:
    # @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
    contact_group_id: Optional[str] = None
    """
    Contact Group Id
    """


    # @ApiMember(DataType="string", Description="Contact Group Name", Name="Name")
    name: Optional[str] = None
    """
    Contact Group Name
    """


    # @ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")
    reference: Optional[str] = None
    """
    Contact Group Reference
    """


    # @ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")
    group_role_id: Optional[str] = None
    """
    Group Role Id for e.g. Customer
    """


    # @ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")
    primary_contact_name: Optional[str] = None
    """
    Primary contact in the group
    """


    # @ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")
    primary_contact_id: Optional[str] = None
    """
    Contact Id of the primary contact in the group
    """


    # @ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")
    primary_contact_photo_url: Optional[str] = None
    """
    Profile photo url of the primary contact in the group
    """


    # @ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")
    primary_contact_thumbnail_url: Optional[str] = None
    """
    Profile photo thumbnail url of the primary contact in the group
    """


    # @ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")
    number_of_contacts: int = 0
    """
    Number of contacts in the group
    """


    # @ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    Record Status of contact group
    """


    # @ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")
    contacts: Optional[List[ContactGroupConnectionModel]] = None
    """
    Details of contact in the contact group
    """


    # @ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")
    projects: Optional[List[CustomerProjectModel]] = None
    """
    Details of projects for the contact group
    """


# @ApiResponse(Description="Get contact groups for current licensee")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactGroupsResponse:
    contact_groups: Optional[List[ContactGroupModel]] = None
    # @ApiMember(DataType="int", Description="Count of total groups.", Name="TotalGroups")
    total_groups: int = 0
    """
    Count of total groups.
    """


    response_status: Optional[ResponseStatus] = None


# @Route("/contactgroups")
# @Route("/contactgroups/{ContactId}")
# @Api(Description="Get customers for current licensee")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactGroups(PagedModel, IReturn[GetContactGroupsResponse]):
    """
    Get customers for current licensee
    """

    # @ApiMember(Description="Get contactGroups for the specified contact", Name="ContactId")
    contact_id: Optional[str] = None
    """
    Get contactGroups for the specified contact
    """


    # @ApiMember(DataType="string", Description="Specific search text to search for i.e. Contact Name, Employment Details etc.", Name="SearchText")
    search_text: Optional[str] = None
    """
    Specific search text to search for i.e. Contact Name, Employment Details etc.
    """


    # @ApiMember(Description="Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.", Name="ContactGroupRoleId")
    contact_group_role_id: Optional[str] = None
    """
    Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.
    """


    # @ApiMember(Description="Include active contact groups", Name="IncludeActive")
    include_active: bool = False
    """
    Include active contact groups
    """


    # @ApiMember(Description="Include archived contact groups", Name="IncludeArchived")
    include_archived: bool = False
    """
    Include archived contact groups
    """