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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetDefaultUserProfile.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export class UserProfileSummaryModel
{
    /** @description User Profile Id */
    // @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    public UserProfileId: string;

    /** @description User linked to the profile */
    // @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    public UserId: string;

    /** @description Contact linked to the profile */
    // @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    public ContactId: string;

    /** @description User linked to the profile */
    // @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
    public UserName: string;

    /** @description User Profile Name */
    // @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
    public ProfileName: string;

    /** @description Full name of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    public ContactFullName: string;

    /** @description Email Address of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    public EmailAddress: string;

    /** @description Email signature of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
    public EmailSignature: string;

    /** @description Mobile number of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
    public MobileNumber: string;

    /** @description Phone number of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
    public PhoneNumber: string;

    /** @description 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="ContactTypeId")
    public ContactTypeId: string;

    /** @description 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")
    public ContactTypeName: string;

    /** @description First name of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
    public FirstName: string;

    /** @description Surname of the contact linked to the profile */
    // @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
    public Surname: string;

    /** @description Title of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
    public Title: string;

    /** @description Legal name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    public LegalName: string;

    /** @description Trading name of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    public TradingName: string;

    /** @description Australian Business Number */
    // @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    public Abn: string;

    /** @description Australian Company Number */
    // @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    public Acn: string;

    /** @description Australian Registered Body Number */
    // @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    public Arbn: string;

    /** @description Indicates if the Contact is registered for GST. */
    // @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    public GstRegistered: boolean;

    /** @description True if english is a secondary language for the contact. */
    // @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
    public ESL: boolean;

    /** @description Language that is the primary language for the contact. */
    // @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
    public Language: string;

    /** @description True if an interpreter is required. */
    // @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    public InterpreterRequired: boolean;

    /** @description Licensee specific notes about the contact. */
    // @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
    public LicenseeNotes: string;

    /** @description Profile photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    public ProfilePhotoUrl: string;

    /** @description Thumbnail photo of contact linked to the profile */
    // @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    public ProfilePhotoThumbnailUrl: string;

    /** @description Profile photo id of contact linked to the profile */
    // @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
    public ProfileImageId: string;

    /** @description Profile description */
    // @ApiMember(DataType="string", Description="Profile description", Name="Description")
    public Description: string;

    /** @description Employment Industry */
    // @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    public EmploymentIndustry: string;

    /** @description Employment Role */
    // @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    public EmploymentRole: string;

    /** @description Areas of Work */
    // @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    public EmploymentGeographicArea: string;

    /** @description The contacts timezone. */
    // @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    public Timezone: string;

    /** @description Timezone Name */
    // @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    public TimezoneName: string;

    /** @description The primary address of the contact */
    // @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    public PrimaryAddress: string;

    /** @description Is this an active contact? Or an inactive contact (deleted account)? */
    // @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
    public IsActiveContact: boolean;

    public constructor(init?: Partial<UserProfileSummaryModel>) { (Object as any).assign(this, init); }
}

export class ContactDetailModel
{
    /** @description Id of the Contact Method */
    // @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    public ContactMethodId: string;

    /** @description Contact Method Name */
    // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    public ContactMethodName: string;

    /** @description If the contact method is an address, this will contain the address details. */
    // @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
    public ContactAddress: ContactAddressModel;

    /** @description If the contact method is a phone, this will contain the phone details */
    // @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
    public ContactPhone: PhoneModel;

    /** @description Id of the country */
    // @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    public CountryId?: string;

    /** @description A summary string representing the contact details */
    // @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    public ContactDetails: string;

    /** @description Notes about the contact details */
    // @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    public Notes: string;

    /** @description Area Code if contact details are a phone number */
    // @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
    public ContactDetailsCode: string;

    /** @description Order number of the contact method */
    // @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    public OrderContactMethod: number;

    /** @description True if this is the primary contact method */
    // @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
    public IsPrimaryContactMethod: boolean;

    /** @description True if this contact method is an address */
    // @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
    public IsAddress: boolean;

    public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}

export class ContactDetailModel
{
    /** @description Contact Method Id */
    // @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
    public ContactMethodId: string;

    /** @description Contact Method Name */
    // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
    public ContactMethodName: string;

    /** @description Contact Address Details */
    // @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
    public ContactAddress: ContactAddressModel;

    /** @description Contact Phone Details */
    // @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
    public ContactPhone: PhoneModel;

    /** @description Country id */
    // @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
    public CountryId?: string;

    /** @description Contact Details */
    // @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
    public ContactDetails: string;

    /** @description Notes */
    // @ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")
    public Notes: string;

    /** @description Contact Details Code */
    // @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
    public ContactDetailsCode: string;

    /** @description Order of Contact Method Id */
    // @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
    public OrderContactMethod: number;

    /** @description Contact Method Id */
    // @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
    public IsPrimaryContactMethod: boolean;

    /** @description Is contact details an address */
    // @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
    public IsAddress: boolean;

    /** @description Contact Contact Detail Id */
    // @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
    public ContactContactDetailId: string;

    /** @description Contact Id */
    // @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
    public ContactId: string;

    /** @description Contact Details Id */
    // @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
    public ContactDetailId: string;

    /** @description Is contact details a primary location */
    // @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
    public IsPrimaryLocation: boolean;

    /** @description Is contact details a registered location */
    // @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
    public IsRegisteredLocation: boolean;

    /** @description Is contact details a postal address */
    // @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
    public IsPostal: boolean;

    /** @description Is contact details a phone number */
    // @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
    public IsPhone: boolean;

    /** @description Email Signature Id */
    // @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
    public EmailSignatureId: string;

    /** @description Email Signature HTML */
    // @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
    public EmailSignatureHTML: string;

    /** @description Email Signature Text */
    // @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
    public EmailSignatureText: string;

    /** @description API Key from Framework */
    // @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
    public ApiFrameworkAlternateKey: string;

    public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}

export class UserProfileModel extends UserProfileSummaryModel
{
    /** @description Contact Date of Birth (when person type) */
    // @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")
    public BirthDate?: string;

    /** @description Contact marital status (when person type) */
    // @ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query")
    public MaritalStatusName: string;

    /** @description Contact gender (when person type) */
    // @ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query")
    public GenderName: string;

    /** @description The Gender Guid of the contact. */
    // @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
    public GenderId?: string;

    /** @description All contact details of the contact */
    // @ApiMember(DataType="List<ContactDetailModel>", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query")
    public ContactDetails: ContactDetailModel[];

    /** @description Primary Street Address */
    // @ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ")
    public PrimaryStreetAddress: ContactDetailModel;

    /** @description Primary Postal Address */
    // @ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ")
    public PrimaryPostalAddress: ContactDetailModel;

    /** @description Primary Registered Address */
    // @ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ")
    public PrimaryRegisteredAddress: ContactDetailModel;

    /** @description Primary Email Address */
    // @ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ")
    public PrimaryEmail: ContactDetailModel;

    /** @description Primary Mobile Number */
    // @ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile")
    public PrimaryMobile: ContactDetailModel;

    /** @description Primary Non-Mobile Number */
    // @ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone")
    public PrimaryPhone: ContactDetailModel;

    /** @description Primary Fax Number */
    // @ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax")
    public PrimaryFax: ContactDetailModel;

    /** @description Primary Web Address */
    // @ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb")
    public PrimaryWeb: ContactDetailModel;

    /** @description Social Media Twitter */
    // @ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter")
    public SocialMediaTwitter: ContactDetailModel;

    /** @description Social Media Facebook */
    // @ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook")
    public SocialMediaFacebook: ContactDetailModel;

    /** @description Social Media Instagram */
    // @ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram")
    public SocialMediaInstagram: ContactDetailModel;

    /** @description Have all connections to the contact been removed? */
    // @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    public IsRemovedContact: boolean;

    /** @description True if this is the users default profile. */
    // @ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query")
    public IsDefault: boolean;

    /** @description True if the users email on this profile can be edited. */
    // @ApiMember(DataType="bool", Description="True if the users email on this profile can be edited.", Name="IsEmailEditable", ParameterType="query")
    public IsEmailEditable: boolean;

    /** @description Primary image Content sent as a file stream contents (if not attached to the request) */
    // @ApiMember(DataType="string", Description="Primary image Content sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContent")
    public PrimaryImageContent: string;

    /** @description Primary image Content type sent as a file stream contents (if not attached to the request) */
    // @ApiMember(DataType="string", Description="Primary image Content type sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContentType")
    public PrimaryImageContentType: string;

    /** @description Primary image file name */
    // @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")
    public PrimaryImageFileName: string;

    public constructor(init?: Partial<UserProfileModel>) { super(init); (Object as any).assign(this, init); }
}

export class GetDefaultUserProfile implements IReturn<UserProfileModel>
{
    /** @description Unique Email address of the user.  If the value passed is empty, UserId must be entered. */
    // @ApiMember(DataType="string", Description="Unique Email address of the user.  If the value passed is empty, UserId must be entered.", Name="UserName", ParameterType="query")
    public UserName: string;

    public constructor(init?: Partial<GetDefaultUserProfile>) { (Object as any).assign(this, init); }
    public getTypeName() { return 'GetDefaultUserProfile'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new UserProfileModel(); }
}