/* Options:
Date: 2026-04-04 04:52:59
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: GetUserProfiles.*
//ExcludeTypes: 
//DefaultImports: 
*/


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

export class UserRoleModel
{
    /** @description 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")
    public ContactRoleId: string;

    /** @description The Role Id. */
    // @ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query")
    public RoleId: string;

    /** @description The role name. */
    // @ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query")
    public RoleName: string;

    /** @description The URL of the role's image icon. */
    // @ApiMember(DataType="string", Description="The URL of the role's image icon.", Name="RolePrimaryImageURL", ParameterType="query")
    public RolePrimaryImageURL: string;

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

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

    /** @description The date the contact started having this role. */
    // @ApiMember(DataType="DateTime", Description="The date the contact started having this role.", Name="StartDate", ParameterType="query")
    public StartDate: string;

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

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

export class UserContactConnectionModel
{
    /** @description 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")
    public ContactRoleId: string;

    /** @description The role name. */
    // @ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")
    public ContactRoleName: string;

    /** @description The list item role Id. */
    // @ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")
    public ContactListItemRoleId: string;

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

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

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

    /** @description The connected contacts Id. (licensee) */
    // @ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")
    public ConnectionContactId: string;

    /** @description The connected contacts Full Name. */
    // @ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")
    public ConnectionContactName: string;

    /** @description The connected contacts role. */
    // @ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")
    public ConnectionContactRoleName: string;

    /** @description The connected contacts role Id. */
    // @ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")
    public ConnectionContactRoleId: string;

    /** @description The connected contacts list item role Id. */
    // @ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")
    public ConnectionContactListItemRoleId: string;

    /** @description The Contacts Type. */
    // @ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")
    public ContactTypeName: string;

    /** @description The URL to the Connected Contacts Photo. */
    // @ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")
    public ConnectionContactPhotoURL: string;

    /** @description . */
    // @ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")
    public IsContactLicenseeRole: boolean;

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

    /** @description The status of the connection with the contact. */
    // @ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")
    public ConnectionStatusName: string;

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

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

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

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

export class ContactEmailAddress
{
    /** @description The Contact Id of the contact. */
    // @ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")
    public ContactId: string;

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

    /** @description The Contact Email Address. */
    // @ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")
    public EmailAddress: string;

    /** @description The Contact Photo URL */
    // @ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")
    public ContactPhotoURL: string;

    public constructor(init?: Partial<ContactEmailAddress>) { (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 UserProfileWithRolesModel extends UserProfileModel
{
    /** @description 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")
    public Roles: UserRoleModel[];

    /** @description 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")
    public ContactConnections: UserContactConnectionModel[];

    /** @description 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")
    public EmailAddressBook: ContactEmailAddress[];

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

export class UserProfilesWithRolesModel
{
    /** @description A list of profiles for the user. */
    // @ApiMember(DataType="List<UserProfileWithRolesModel>", Description="A list of profiles for the user.", Name="Profiles")
    public Profiles: UserProfileWithRolesModel[];

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

/** @description Returns a Users profile information. */
// @Route("/profiles")
// @Api(Description="Returns a Users profile information.")
export class GetUserProfiles implements IReturn<UserProfilesWithRolesModel>
{
    /** @description 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")
    public UserId?: string;

    /** @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;

    /** @description Flag to exclude contact details from organisation profiles. */
    // @ApiMember(DataType="bool", Description="Flag to exclude contact details from organisation profiles.", Name="ExcludeContactDetails", ParameterType="query")
    public ExcludeContactDetails: boolean;

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