""" Options:
Date: 2026-04-04 02:55:59
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: SaveUserProfile.*
#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 ContactDetailModel:
    # @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    contact_method_id: Optional[str] = None
    """
    Id of the Contact Method
    """


    # @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    contact_method_name: Optional[str] = None
    """
    Contact Method Name
    """


    # @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
    contact_address: Optional[ContactAddressModel] = None
    """
    If the contact method is an address, this will contain the address details.
    """


    # @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
    contact_phone: Optional[PhoneModel] = None
    """
    If the contact method is a phone, this will contain the phone details
    """


    # @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    country_id: Optional[str] = None
    """
    Id of the country
    """


    # @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    contact_details: Optional[str] = None
    """
    A summary string representing the contact details
    """


    # @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    notes: Optional[str] = None
    """
    Notes about the contact details
    """


    # @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
    contact_details_code: Optional[str] = None
    """
    Area Code if contact details are a phone number
    """


    # @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    order_contact_method: int = 0
    """
    Order number of the contact method
    """


    # @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
    is_primary_contact_method: bool = False
    """
    True if this is the primary contact method
    """


    # @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
    is_address: bool = False
    """
    True if this contact method is an address
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactDetailModel:
    # @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
    contact_method_id: Optional[str] = None
    """
    Contact Method Id
    """


    # @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
    contact_method_name: Optional[str] = None
    """
    Contact Method Name
    """


    # @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
    contact_address: Optional[ContactAddressModel] = None
    """
    Contact Address Details
    """


    # @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
    contact_phone: Optional[PhoneModel] = None
    """
    Contact Phone Details
    """


    # @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
    country_id: Optional[str] = None
    """
    Country id
    """


    # @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
    contact_details: Optional[str] = None
    """
    Contact Details
    """


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


    # @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
    contact_details_code: Optional[str] = None
    """
    Contact Details Code
    """


    # @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
    order_contact_method: int = 0
    """
    Order of Contact Method Id
    """


    # @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
    is_primary_contact_method: bool = False
    """
    Contact Method Id
    """


    # @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
    is_address: bool = False
    """
    Is contact details an address
    """


    # @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
    contact_contact_detail_id: Optional[str] = None
    """
    Contact Contact Detail Id
    """


    # @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
    contact_id: Optional[str] = None
    """
    Contact Id
    """


    # @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
    contact_detail_id: Optional[str] = None
    """
    Contact Details Id
    """


    # @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
    is_primary_location: bool = False
    """
    Is contact details a primary location
    """


    # @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
    is_registered_location: bool = False
    """
    Is contact details a registered location
    """


    # @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
    is_postal: bool = False
    """
    Is contact details a postal address
    """


    # @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
    is_phone: bool = False
    """
    Is contact details a phone number
    """


    # @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
    email_signature_id: Optional[str] = None
    """
    Email Signature Id
    """


    # @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
    email_signature_h_t_m_l: Optional[str] = None
    """
    Email Signature HTML
    """


    # @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
    email_signature_text: Optional[str] = None
    """
    Email Signature Text
    """


    # @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
    api_framework_alternate_key: Optional[str] = None
    """
    API Key from Framework
    """


# @Api(Description="Updates a Users Profile information'")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveUserProfile(IReturn[ResponseStatus]):
    """
    Updates a Users Profile information'
    """

    # @ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")
    user_profile_id: Optional[str] = None
    """
    The users profile Guid.
    """


    # @ApiMember(DataType="Guid", Description="The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.", IsRequired=true, Name="UserId", ParameterType="query")
    user_id: Optional[str] = None
    """
    The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
    """


    # @ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")
    contact_id: Optional[str] = None
    """
    The users contact Guid.
    """


    # @ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")
    profile_name: Optional[str] = None
    """
    The users profile name.
    """


    # @ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")
    title: Optional[str] = None
    """
    The users (contact) title.
    """


    # @ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")
    first_name: Optional[str] = None
    """
    The users (contact) first name(s).
    """


    # @ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")
    surname: Optional[str] = None
    """
    The users (contact) surname.
    """


    # @ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")
    description: Optional[str] = None
    """
    The contact profile description.
    """


    # @ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")
    employment_industry: Optional[str] = None
    """
    The contacts profession/trade/industry details.
    """


    # @ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")
    employment_role: Optional[str] = None
    """
    The contact details of who they work/subcontract for.
    """


    # @ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")
    employment_geographic_area: Optional[str] = None
    """
    The contacts work area/suburbs.
    """


    # @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    timezone: Optional[str] = None
    """
    The contacts timezone.
    """


    # @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact. Note: an email must always be set for a business.", IsRequired=true, Name="ContactDetails", ParameterType="query")
    contact_details: List[ContactDetailModel] = field(default_factory=list)
    """
    A list of the contact details for the contact. Note: an email must always be set for a business.
    """


    # @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactType")
    contact_type: Optional[str] = None
    """
    Type of contact (person, organisation etc.) 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="Abn of contact linked to the profile", Name="Abn")
    abn: Optional[str] = None
    """
    Abn of contact linked to the profile
    """


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


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


    # @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="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
    gender_id: Optional[str] = None
    """
    The Gender Guid of the contact.
    """