/* Options:
Date: 2026-04-03 23:30:13
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: GetUserProfiles.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Returns a Users profile information.
*/
@Route(Path="/profiles")
@Api(Description="Returns a Users profile information.")
open class GetUserProfiles : IReturn<UserProfilesWithRolesModel>
{
    /**
    * The user's Guid.  If the value passed is empty, UserName must be entered.
    */
    @ApiMember(DataType="Guid?", Description="The user's Guid.  If the value passed is empty, UserName must be entered.", Name="UserId", ParameterType="query")
    open var UserId:UUID? = null

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

    /**
    * Flag to exclude contact details from organisation profiles.
    */
    @ApiMember(DataType="bool", Description="Flag to exclude contact details from organisation profiles.", Name="ExcludeContactDetails", ParameterType="query")
    open var ExcludeContactDetails:Boolean? = null
    companion object { private val responseType = UserProfilesWithRolesModel::class.java }
    override fun getResponseType(): Any? = GetUserProfiles.responseType
}

open class UserProfilesWithRolesModel
{
    /**
    * A list of profiles for the user.
    */
    @ApiMember(DataType="List<UserProfileWithRolesModel>", Description="A list of profiles for the user.", Name="Profiles")
    open var Profiles:ArrayList<UserProfileWithRolesModel>? = null
}

open class UserRoleModel
{
    /**
    * The Contact Role Id, that links the Contact to their role.
    */
    @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")
    open var ContactRoleId:UUID? = null

    /**
    * The Role Id.
    */
    @ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query")
    open var RoleId:UUID? = null

    /**
    * The role name.
    */
    @ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query")
    open var RoleName:String? = null

    /**
    * The URL of the role's image icon.
    */
    @ApiMember(DataType="string", Description="The URL of the role's image icon.", Name="RolePrimaryImageURL", ParameterType="query")
    open var RolePrimaryImageURL:String? = null

    /**
    * The URL of the role's thumbnail image icon.
    */
    @ApiMember(DataType="string", Description="The URL of the role's thumbnail image icon.", Name="RolePrimaryImageThumbnailURL", ParameterType="query")
    open var RolePrimaryImageThumbnailURL:String? = null

    /**
    * The Guid of the role's media file containing the image icon details.
    */
    @ApiMember(DataType="string", Description="The Guid of the role's media file containing the image icon details.", Name="RolePrimaryImageId", ParameterType="query")
    open var RolePrimaryImageId:UUID? = null

    /**
    * The date the contact started having this role.
    */
    @ApiMember(DataType="DateTime", Description="The date the contact started having this role.", Name="StartDate", ParameterType="query")
    open var StartDate:Date? = null

    /**
    * The date the contact will end having this role.
    */
    @ApiMember(DataType="DateTime?", Description="The date the contact will end having this role.", Name="EndDate", ParameterType="query")
    open var EndDate:Date? = null
}

open class UserContactConnectionModel
{
    /**
    * The Contact Role Id, that links the Contact to their role.
    */
    @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")
    open var ContactRoleId:UUID? = null

    /**
    * The role name.
    */
    @ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")
    open var ContactRoleName:String? = null

    /**
    * The list item role Id.
    */
    @ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")
    open var ContactListItemRoleId:UUID? = null

    /**
    * The URL of the contact role's image icon.
    */
    @ApiMember(DataType="string", Description="The URL of the contact role's image icon.", Name="ContactRolePrimaryImageURL", ParameterType="query")
    open var ContactRolePrimaryImageURL:String? = null

    /**
    * The URL of the contact role's thumbnail image icon.
    */
    @ApiMember(DataType="string", Description="The URL of the contact role's thumbnail image icon.", Name="ContactRolePrimaryImageThumbnailURL", ParameterType="query")
    open var ContactRolePrimaryImageThumbnailURL:String? = null

    /**
    * The Guid of the contact role's media file containing the image icon details.
    */
    @ApiMember(DataType="string", Description="The Guid of the contact role's media file containing the image icon details.", Name="ContactRolePrimaryImageId", ParameterType="query")
    open var ContactRolePrimaryImageId:UUID? = null

    /**
    * The connected contacts Id. (licensee)
    */
    @ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")
    open var ConnectionContactId:UUID? = null

    /**
    * The connected contacts Full Name.
    */
    @ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")
    open var ConnectionContactName:String? = null

    /**
    * The connected contacts role.
    */
    @ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")
    open var ConnectionContactRoleName:String? = null

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

    /**
    * The connected contacts list item role Id.
    */
    @ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")
    open var ConnectionContactListItemRoleId:UUID? = null

    /**
    * The Contacts Type.
    */
    @ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")
    open var ContactTypeName:String? = null

    /**
    * The URL to the Connected Contacts Photo.
    */
    @ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")
    open var ConnectionContactPhotoURL:String? = null

    /**
    * .
    */
    @ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")
    open var IsContactLicenseeRole:Boolean? = null

    /**
    * If the connection is as a licensee this is true.
    */
    @ApiMember(DataType="bool", Description="If the connection is as a licensee this is true.", Name="IsConnectionLicenseeRole", ParameterType="query")
    open var IsConnectionLicenseeRole:Boolean? = null

    /**
    * The status of the connection with the contact.
    */
    @ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")
    open var ConnectionStatusName:String? = null

    /**
    * The status Id of the connection with the contact.
    */
    @ApiMember(DataType="Guid", Description="The status Id of the connection with the contact.", Name="ConnectionStatusId", ParameterType="query")
    open var ConnectionStatusId:UUID? = null

    /**
    * The ContactRoleConnectionId of an active connection with the contact.
    */
    @ApiMember(DataType="Guid", Description="The ContactRoleConnectionId of an active connection with the contact.", Name="ConnectionId", ParameterType="query")
    open var ConnectionId:UUID? = null

    /**
    * The ContactRoleConnectionRequest of a pending connection with the contact.
    */
    @ApiMember(DataType="Guid", Description="The ContactRoleConnectionRequest of a pending connection with the contact.", Name="ConnectionRequestId", ParameterType="query")
    open var ConnectionRequestId:UUID? = null
}

open class ContactEmailAddress
{
    /**
    * The Contact Id of the contact.
    */
    @ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")
    open var ContactId:UUID? = null

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

    /**
    * The Contact Email Address.
    */
    @ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")
    open var EmailAddress:String? = null

    /**
    * The Contact Photo URL
    */
    @ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")
    open var ContactPhotoURL:String? = null
}

open class UserProfileWithRolesModel : UserProfileModel()
{
    /**
    * A list of roles assigned to the user.
    */
    @ApiMember(DataType="List<UserRoleModel>", Description="A list of roles assigned to the user.", Name="Roles", ParameterType="query")
    open var Roles:ArrayList<UserRoleModel>? = null

    /**
    * A list of contact connections assigned to the user.
    */
    @ApiMember(DataType="List<UserContactConnectionModel>", Description="A list of contact connections assigned to the user.", Name="ContactConnections", ParameterType="query")
    open var ContactConnections:ArrayList<UserContactConnectionModel>? = null

    /**
    * A list of connected contacts and their email addresses.
    */
    @ApiMember(DataType="List<ContactEmailAddressBook>", Description="A list of connected contacts and their email addresses.", Name="EmailAddressBook", ParameterType="query")
    open var EmailAddressBook:ArrayList<ContactEmailAddress>? = 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
}