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

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: SearchContact.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Returns a list of Contact Profiles matching the search criteria provided.
*/
@Api(Description="Returns a list of Contact Profiles matching the search criteria provided.")
open class SearchContact : IReturn<ArrayList<UserProfileModel>>
{
    /**
    * Email Address to search for the contact on.
    */
    @ApiMember(DataType="string", Description="Email Address to search for the contact on.", IsRequired=true, Name="EmailAddress", ParameterType="query")
    open var EmailAddress:String? = null
    companion object { private val responseType = object : TypeToken<ArrayList<UserProfileModel>>(){}.type }
    override fun getResponseType(): Any? = SearchContact.responseType
}

open class UserProfileSummaryModel
{
    /**
    * User Profile Id
    */
    @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    open var UserProfileId:UUID? = null

    /**
    * User linked to the profile
    */
    @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    open var UserId:UUID? = null

    /**
    * Contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * User linked to the profile
    */
    @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
    open var UserName:String? = null

    /**
    * User Profile Name
    */
    @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
    open var ProfileName:String? = null

    /**
    * Full name of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    open var ContactFullName:String? = null

    /**
    * Email Address of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    open var EmailAddress:String? = null

    /**
    * Email signature of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
    open var EmailSignature:String? = null

    /**
    * Mobile number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
    open var MobileNumber:String? = null

    /**
    * Phone number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
    open var PhoneNumber:String? = null

    /**
    * 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")
    open var ContactTypeId:UUID? = null

    /**
    * 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")
    open var ContactTypeName:String? = null

    /**
    * First name of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
    open var FirstName:String? = null

    /**
    * Surname of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
    open var Surname:String? = null

    /**
    * Title of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
    open var Title:String? = null

    /**
    * Legal name of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    open var LegalName:String? = null

    /**
    * Trading name of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    open var TradingName:String? = null

    /**
    * Australian Business Number
    */
    @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    open var Abn:String? = null

    /**
    * Australian Company Number
    */
    @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    open var Acn:String? = null

    /**
    * Australian Registered Body Number
    */
    @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    open var Arbn:String? = null

    /**
    * Indicates if the Contact is registered for GST.
    */
    @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    open var GstRegistered:Boolean? = null

    /**
    * 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")
    open var ESL:Boolean? = null

    /**
    * 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")
    open var Language:String? = null

    /**
    * True if an interpreter is required.
    */
    @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    open var InterpreterRequired:Boolean? = null

    /**
    * Licensee specific notes about the contact.
    */
    @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
    open var LicenseeNotes:String? = null

    /**
    * Profile photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    open var ProfilePhotoUrl:String? = null

    /**
    * Thumbnail photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    open var ProfilePhotoThumbnailUrl:String? = null

    /**
    * Profile photo id of contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
    open var ProfileImageId:UUID? = null

    /**
    * Profile description
    */
    @ApiMember(DataType="string", Description="Profile description", Name="Description")
    open var Description:String? = null

    /**
    * Employment Industry
    */
    @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    open var EmploymentIndustry:String? = null

    /**
    * Employment Role
    */
    @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    open var EmploymentRole:String? = null

    /**
    * Areas of Work
    */
    @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    open var EmploymentGeographicArea:String? = null

    /**
    * The contacts timezone.
    */
    @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    open var Timezone:UUID? = null

    /**
    * Timezone Name
    */
    @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    open var TimezoneName:String? = null

    /**
    * The primary address of the contact
    */
    @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    open var PrimaryAddress:String? = null

    /**
    * 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")
    open var IsActiveContact:Boolean? = null
}

open class ContactDetailModel
{
    /**
    * Id of the Contact Method
    */
    @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    open var ContactMethodId:UUID? = null

    /**
    * Contact Method Name
    */
    @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    open var ContactMethodName:String? = null

    /**
    * 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")
    open var ContactAddress:ContactAddressModel? = null

    /**
    * 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")
    open var ContactPhone:PhoneModel? = null

    /**
    * Id of the country
    */
    @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    open var CountryId:UUID? = null

    /**
    * A summary string representing the contact details
    */
    @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    open var ContactDetails:String? = null

    /**
    * Notes about the contact details
    */
    @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    open var Notes:String? = null

    /**
    * 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")
    open var ContactDetailsCode:String? = null

    /**
    * Order number of the contact method
    */
    @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    open var OrderContactMethod:Int? = null

    /**
    * True if this is the primary contact method
    */
    @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
    open var IsPrimaryContactMethod:Boolean? = null

    /**
    * True if this contact method is an address
    */
    @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
    open var IsAddress:Boolean? = null
}

open class ContactDetailModel
{
    /**
    * Contact Method Id
    */
    @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
    open var ContactMethodId:UUID? = null

    /**
    * Contact Method Name
    */
    @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
    open var ContactMethodName:String? = null

    /**
    * Contact Address Details
    */
    @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
    open var ContactAddress:ContactAddressModel? = null

    /**
    * Contact Phone Details
    */
    @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
    open var ContactPhone:PhoneModel? = null

    /**
    * Country id
    */
    @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
    open var CountryId:UUID? = null

    /**
    * Contact Details
    */
    @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
    open var ContactDetails:String? = null

    /**
    * Notes
    */
    @ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")
    open var Notes:String? = null

    /**
    * Contact Details Code
    */
    @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
    open var ContactDetailsCode:String? = null

    /**
    * Order of Contact Method Id
    */
    @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
    open var OrderContactMethod:Int? = null

    /**
    * Contact Method Id
    */
    @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
    open var IsPrimaryContactMethod:Boolean? = null

    /**
    * Is contact details an address
    */
    @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
    open var IsAddress:Boolean? = null

    /**
    * Contact Contact Detail Id
    */
    @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
    open var ContactContactDetailId:UUID? = null

    /**
    * Contact Id
    */
    @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
    open var ContactId:UUID? = null

    /**
    * Contact Details Id
    */
    @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
    open var ContactDetailId:UUID? = null

    /**
    * Is contact details a primary location
    */
    @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
    open var IsPrimaryLocation:Boolean? = null

    /**
    * Is contact details a registered location
    */
    @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
    open var IsRegisteredLocation:Boolean? = null

    /**
    * Is contact details a postal address
    */
    @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
    open var IsPostal:Boolean? = null

    /**
    * Is contact details a phone number
    */
    @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
    open var IsPhone:Boolean? = null

    /**
    * Email Signature Id
    */
    @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
    open var EmailSignatureId:UUID? = null

    /**
    * Email Signature HTML
    */
    @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
    open var EmailSignatureHTML:String? = null

    /**
    * Email Signature Text
    */
    @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
    open var EmailSignatureText:String? = null

    /**
    * API Key from Framework
    */
    @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
    open var ApiFrameworkAlternateKey:String? = null
}

open class UserProfileModel : UserProfileSummaryModel()
{
    /**
    * Contact Date of Birth (when person type)
    */
    @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")
    open var BirthDate:Date? = null

    /**
    * Contact marital status (when person type)
    */
    @ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query")
    open var MaritalStatusName:String? = null

    /**
    * Contact gender (when person type)
    */
    @ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query")
    open var GenderName:String? = null

    /**
    * The Gender Guid of the contact.
    */
    @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
    open var GenderId:UUID? = null

    /**
    * All contact details of the contact
    */
    @ApiMember(DataType="List<ContactDetailModel>", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query")
    open var ContactDetails:ArrayList<ContactDetailModel>? = null

    /**
    * Primary Street Address
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ")
    open var PrimaryStreetAddress:ContactDetailModel? = null

    /**
    * Primary Postal Address
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ")
    open var PrimaryPostalAddress:ContactDetailModel? = null

    /**
    * Primary Registered Address
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ")
    open var PrimaryRegisteredAddress:ContactDetailModel? = null

    /**
    * Primary Email Address
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ")
    open var PrimaryEmail:ContactDetailModel? = null

    /**
    * Primary Mobile Number
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile")
    open var PrimaryMobile:ContactDetailModel? = null

    /**
    * Primary Non-Mobile Number
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone")
    open var PrimaryPhone:ContactDetailModel? = null

    /**
    * Primary Fax Number
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax")
    open var PrimaryFax:ContactDetailModel? = null

    /**
    * Primary Web Address
    */
    @ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb")
    open var PrimaryWeb:ContactDetailModel? = null

    /**
    * Social Media Twitter
    */
    @ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter")
    open var SocialMediaTwitter:ContactDetailModel? = null

    /**
    * Social Media Facebook
    */
    @ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook")
    open var SocialMediaFacebook:ContactDetailModel? = null

    /**
    * Social Media Instagram
    */
    @ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram")
    open var SocialMediaInstagram:ContactDetailModel? = null

    /**
    * Have all connections to the contact been removed?
    */
    @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
    open var IsRemovedContact:Boolean? = null

    /**
    * True if this is the users default profile.
    */
    @ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query")
    open var IsDefault:Boolean? = null

    /**
    * 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")
    open var IsEmailEditable:Boolean? = null

    /**
    * 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")
    open var PrimaryImageContent:String? = null

    /**
    * 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")
    open var PrimaryImageContentType:String? = null

    /**
    * Primary image file name
    */
    @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")
    open var PrimaryImageFileName:String? = null
}