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

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: GetContactRoleDetails.*
//ExcludeTypes: 
//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.*;

public class dtos
{

    /**
    * Get details of the specified contact role, including details of the contacts and organisations sharing it
    */
    @Route(Path="/contactrole/{ContactRoleId}")
    @Api(Description="Get details of the specified contact role, including details of the contacts and organisations sharing it")
    public static class GetContactRoleDetails extends PagedModel implements IReturn<GetContactRoleDetailsResponse>
    {
        /**
        * The Contact Role Guid. Records retrieved will belong to this contact.
        */
        @ApiMember(DataType="Guid", Description="The Contact Role Guid. Records retrieved will belong to this contact.", IsRequired=true, Name="ContactRoleId", ParameterType="query")
        public UUID ContactRoleId = null;

        /**
        * Text filter
        */
        @ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")
        public String SearchText = null;
        
        public UUID getContactRoleId() { return ContactRoleId; }
        public GetContactRoleDetails setContactRoleId(UUID value) { this.ContactRoleId = value; return this; }
        public String getSearchText() { return SearchText; }
        public GetContactRoleDetails setSearchText(String value) { this.SearchText = value; return this; }
        private static Object responseType = GetContactRoleDetailsResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="Details of the specified contact role, including details of the contacts and organisations sharing it")
    public static class GetContactRoleDetailsResponse
    {
        public ViewRoleModel ContactRole = null;
        public ResponseStatus ResponseStatus = null;
        
        public ViewRoleModel getContactRole() { return ContactRole; }
        public GetContactRoleDetailsResponse setContactRole(ViewRoleModel value) { this.ContactRole = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetContactRoleDetailsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class UserProfileSummaryModel
    {
        /**
        * User Profile Id
        */
        @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
        public UUID UserProfileId = null;

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

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

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

        /**
        * User Profile Name
        */
        @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
        public String ProfileName = 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")
        public String ContactFullName = 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")
        public String EmailAddress = 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")
        public String EmailSignature = 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")
        public String MobileNumber = 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")
        public String PhoneNumber = 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")
        public UUID ContactTypeId = 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")
        public String ContactTypeName = 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")
        public String FirstName = null;

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

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

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

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

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

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

        /**
        * Australian Registered Body Number
        */
        @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
        public String Arbn = 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")
        public Boolean GstRegistered = 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")
        public Boolean ESL = 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")
        public String Language = null;

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

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

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

        /**
        * Thumbnail photo of contact linked to the profile
        */
        @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
        public String ProfilePhotoThumbnailUrl = 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")
        public UUID ProfileImageId = null;

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

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

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

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

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

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

        /**
        * The primary address of the contact
        */
        @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
        public String PrimaryAddress = 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")
        public Boolean IsActiveContact = null;
        
        public UUID getUserProfileId() { return UserProfileId; }
        public UserProfileSummaryModel setUserProfileId(UUID value) { this.UserProfileId = value; return this; }
        public UUID getUserId() { return UserId; }
        public UserProfileSummaryModel setUserId(UUID value) { this.UserId = value; return this; }
        public UUID getContactId() { return ContactId; }
        public UserProfileSummaryModel setContactId(UUID value) { this.ContactId = value; return this; }
        public String getUserName() { return UserName; }
        public UserProfileSummaryModel setUserName(String value) { this.UserName = value; return this; }
        public String getProfileName() { return ProfileName; }
        public UserProfileSummaryModel setProfileName(String value) { this.ProfileName = value; return this; }
        public String getContactFullName() { return ContactFullName; }
        public UserProfileSummaryModel setContactFullName(String value) { this.ContactFullName = value; return this; }
        public String getEmailAddress() { return EmailAddress; }
        public UserProfileSummaryModel setEmailAddress(String value) { this.EmailAddress = value; return this; }
        public String getEmailSignature() { return EmailSignature; }
        public UserProfileSummaryModel setEmailSignature(String value) { this.EmailSignature = value; return this; }
        public String getMobileNumber() { return MobileNumber; }
        public UserProfileSummaryModel setMobileNumber(String value) { this.MobileNumber = value; return this; }
        public String getPhoneNumber() { return PhoneNumber; }
        public UserProfileSummaryModel setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
        public UUID getContactTypeId() { return ContactTypeId; }
        public UserProfileSummaryModel setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
        public String getContactTypeName() { return ContactTypeName; }
        public UserProfileSummaryModel setContactTypeName(String value) { this.ContactTypeName = value; return this; }
        public String getFirstName() { return FirstName; }
        public UserProfileSummaryModel setFirstName(String value) { this.FirstName = value; return this; }
        public String getSurname() { return Surname; }
        public UserProfileSummaryModel setSurname(String value) { this.Surname = value; return this; }
        public String getTitle() { return Title; }
        public UserProfileSummaryModel setTitle(String value) { this.Title = value; return this; }
        public String getLegalName() { return LegalName; }
        public UserProfileSummaryModel setLegalName(String value) { this.LegalName = value; return this; }
        public String getTradingName() { return TradingName; }
        public UserProfileSummaryModel setTradingName(String value) { this.TradingName = value; return this; }
        public String getAbn() { return Abn; }
        public UserProfileSummaryModel setAbn(String value) { this.Abn = value; return this; }
        public String getAcn() { return Acn; }
        public UserProfileSummaryModel setAcn(String value) { this.Acn = value; return this; }
        public String getArbn() { return Arbn; }
        public UserProfileSummaryModel setArbn(String value) { this.Arbn = value; return this; }
        public Boolean isGstRegistered() { return GstRegistered; }
        public UserProfileSummaryModel setGstRegistered(Boolean value) { this.GstRegistered = value; return this; }
        public Boolean isEsl() { return ESL; }
        public UserProfileSummaryModel setEsl(Boolean value) { this.ESL = value; return this; }
        public String getLanguage() { return Language; }
        public UserProfileSummaryModel setLanguage(String value) { this.Language = value; return this; }
        public Boolean isInterpreterRequired() { return InterpreterRequired; }
        public UserProfileSummaryModel setInterpreterRequired(Boolean value) { this.InterpreterRequired = value; return this; }
        public String getLicenseeNotes() { return LicenseeNotes; }
        public UserProfileSummaryModel setLicenseeNotes(String value) { this.LicenseeNotes = value; return this; }
        public String getProfilePhotoUrl() { return ProfilePhotoUrl; }
        public UserProfileSummaryModel setProfilePhotoUrl(String value) { this.ProfilePhotoUrl = value; return this; }
        public String getProfilePhotoThumbnailUrl() { return ProfilePhotoThumbnailUrl; }
        public UserProfileSummaryModel setProfilePhotoThumbnailUrl(String value) { this.ProfilePhotoThumbnailUrl = value; return this; }
        public UUID getProfileImageId() { return ProfileImageId; }
        public UserProfileSummaryModel setProfileImageId(UUID value) { this.ProfileImageId = value; return this; }
        public String getDescription() { return Description; }
        public UserProfileSummaryModel setDescription(String value) { this.Description = value; return this; }
        public String getEmploymentIndustry() { return EmploymentIndustry; }
        public UserProfileSummaryModel setEmploymentIndustry(String value) { this.EmploymentIndustry = value; return this; }
        public String getEmploymentRole() { return EmploymentRole; }
        public UserProfileSummaryModel setEmploymentRole(String value) { this.EmploymentRole = value; return this; }
        public String getEmploymentGeographicArea() { return EmploymentGeographicArea; }
        public UserProfileSummaryModel setEmploymentGeographicArea(String value) { this.EmploymentGeographicArea = value; return this; }
        public UUID getTimezone() { return Timezone; }
        public UserProfileSummaryModel setTimezone(UUID value) { this.Timezone = value; return this; }
        public String getTimezoneName() { return TimezoneName; }
        public UserProfileSummaryModel setTimezoneName(String value) { this.TimezoneName = value; return this; }
        public String getPrimaryAddress() { return PrimaryAddress; }
        public UserProfileSummaryModel setPrimaryAddress(String value) { this.PrimaryAddress = value; return this; }
        public Boolean getIsActiveContact() { return IsActiveContact; }
        public UserProfileSummaryModel setIsActiveContact(Boolean value) { this.IsActiveContact = value; return this; }
    }

    public static enum SortOrder
    {
        Ascending,
        Descending;
    }

    public static class PagedModel
    {
        /**
        * Page Number to retrieve
        */
        @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
        public Integer PageNumber = null;

        /**
        * Number of records to retrieve
        */
        @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
        public Integer PageSize = null;

        /**
        * Index of field to sort results by
        */
        @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
        public Integer SortIndex = null;

        /**
        * Sort Order - Ascending or Descending
        */
        @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
        public SortOrder SortOrder = null;
        
        public Integer getPageNumber() { return PageNumber; }
        public PagedModel setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public PagedModel setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getSortIndex() { return SortIndex; }
        public PagedModel setSortIndex(Integer value) { this.SortIndex = value; return this; }
        public SortOrder getSortOrder() { return SortOrder; }
        public PagedModel setSortOrder(SortOrder value) { this.SortOrder = value; return this; }
    }

    public static class ObjectShareModel
    {
        public UUID ObjectShareId = null;
        public UUID ObjectId = null;
        public String ObjectName = null;
        public String Name = null;
        public String Description = null;
        public String Reference = null;
        public UUID ContactId = null;
        public String ContactName = null;
        public String ContactType = null;
        public String ContactImageUrlPrimary = null;
        public String ContactImageUrlPrimaryThmbnail = null;
        public UUID ShareStatusId = null;
        public String ShareStatusName = null;
        
        public UUID getObjectShareId() { return ObjectShareId; }
        public ObjectShareModel setObjectShareId(UUID value) { this.ObjectShareId = value; return this; }
        public UUID getObjectId() { return ObjectId; }
        public ObjectShareModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public String getObjectName() { return ObjectName; }
        public ObjectShareModel setObjectName(String value) { this.ObjectName = value; return this; }
        public String getName() { return Name; }
        public ObjectShareModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ObjectShareModel setDescription(String value) { this.Description = value; return this; }
        public String getReference() { return Reference; }
        public ObjectShareModel setReference(String value) { this.Reference = value; return this; }
        public UUID getContactId() { return ContactId; }
        public ObjectShareModel setContactId(UUID value) { this.ContactId = value; return this; }
        public String getContactName() { return ContactName; }
        public ObjectShareModel setContactName(String value) { this.ContactName = value; return this; }
        public String getContactType() { return ContactType; }
        public ObjectShareModel setContactType(String value) { this.ContactType = value; return this; }
        public String getContactImageUrlPrimary() { return ContactImageUrlPrimary; }
        public ObjectShareModel setContactImageUrlPrimary(String value) { this.ContactImageUrlPrimary = value; return this; }
        public String getContactImageUrlPrimaryThmbnail() { return ContactImageUrlPrimaryThmbnail; }
        public ObjectShareModel setContactImageUrlPrimaryThmbnail(String value) { this.ContactImageUrlPrimaryThmbnail = value; return this; }
        public UUID getShareStatusId() { return ShareStatusId; }
        public ObjectShareModel setShareStatusId(UUID value) { this.ShareStatusId = value; return this; }
        public String getShareStatusName() { return ShareStatusName; }
        public ObjectShareModel setShareStatusName(String value) { this.ShareStatusName = value; return this; }
    }

    public static class ListItemFilterModel
    {
        public UUID ListItemFilterId = null;
        public String FilterName = null;
        public UUID ListId = null;
        public UUID ListItemId = null;
        public Boolean ListItemIsInFilter = null;
        
        public UUID getListItemFilterId() { return ListItemFilterId; }
        public ListItemFilterModel setListItemFilterId(UUID value) { this.ListItemFilterId = value; return this; }
        public String getFilterName() { return FilterName; }
        public ListItemFilterModel setFilterName(String value) { this.FilterName = value; return this; }
        public UUID getListId() { return ListId; }
        public ListItemFilterModel setListId(UUID value) { this.ListId = value; return this; }
        public UUID getListItemId() { return ListItemId; }
        public ListItemFilterModel setListItemId(UUID value) { this.ListItemId = value; return this; }
        public Boolean isListItemIsInFilter() { return ListItemIsInFilter; }
        public ListItemFilterModel setListItemIsInFilter(Boolean value) { this.ListItemIsInFilter = value; return this; }
    }

    public static class ViewRoleModel extends PagedModel
    {
        /**
        * Role Id
        */
        @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
        public UUID RoleId = null;

        /**
        * Role Name
        */
        @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
        public String RoleName = null;

        /**
        * Role Connection Definition Id
        */
        @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
        public UUID RoleConnectionDefinitionId = null;

        /**
        * Contact Types the Role applies to
        */
        @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
        public ArrayList<UUID> ContactTypes = null;

        /**
        * Does the role require contacts to accept it?
        */
        @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
        public Boolean RequireContactsToAccept = null;

        public Boolean IsPlatformRole = null;
        public Boolean CanAddContacts = null;
        public Boolean CanShareRole = null;
        public Boolean CanEditRole = null;
        public Boolean CanEditContactTypes = null;
        public ArrayList<UserProfileSummaryModel> Contacts = null;
        public IList<ObjectShareModel> ShareDetails = null;
        public ArrayList<ListItemFilterModel> ListItemFilters = null;
        public UUID ContactIdOwner = null;
        public Integer TotalItemCount = null;
        
        public UUID getRoleId() { return RoleId; }
        public ViewRoleModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public ViewRoleModel setRoleName(String value) { this.RoleName = value; return this; }
        public UUID getRoleConnectionDefinitionId() { return RoleConnectionDefinitionId; }
        public ViewRoleModel setRoleConnectionDefinitionId(UUID value) { this.RoleConnectionDefinitionId = value; return this; }
        public ArrayList<UUID> getContactTypes() { return ContactTypes; }
        public ViewRoleModel setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
        public Boolean isRequireContactsToAccept() { return RequireContactsToAccept; }
        public ViewRoleModel setRequireContactsToAccept(Boolean value) { this.RequireContactsToAccept = value; return this; }
        public Boolean getIsPlatformRole() { return IsPlatformRole; }
        public ViewRoleModel setIsPlatformRole(Boolean value) { this.IsPlatformRole = value; return this; }
        public Boolean isCanAddContacts() { return CanAddContacts; }
        public ViewRoleModel setCanAddContacts(Boolean value) { this.CanAddContacts = value; return this; }
        public Boolean isCanShareRole() { return CanShareRole; }
        public ViewRoleModel setCanShareRole(Boolean value) { this.CanShareRole = value; return this; }
        public Boolean isCanEditRole() { return CanEditRole; }
        public ViewRoleModel setCanEditRole(Boolean value) { this.CanEditRole = value; return this; }
        public Boolean isCanEditContactTypes() { return CanEditContactTypes; }
        public ViewRoleModel setCanEditContactTypes(Boolean value) { this.CanEditContactTypes = value; return this; }
        public ArrayList<UserProfileSummaryModel> getContacts() { return Contacts; }
        public ViewRoleModel setContacts(ArrayList<UserProfileSummaryModel> value) { this.Contacts = value; return this; }
        public IList<ObjectShareModel> getShareDetails() { return ShareDetails; }
        public ViewRoleModel setShareDetails(IList<ObjectShareModel> value) { this.ShareDetails = value; return this; }
        public ArrayList<ListItemFilterModel> getListItemFilters() { return ListItemFilters; }
        public ViewRoleModel setListItemFilters(ArrayList<ListItemFilterModel> value) { this.ListItemFilters = value; return this; }
        public UUID getContactIdOwner() { return ContactIdOwner; }
        public ViewRoleModel setContactIdOwner(UUID value) { this.ContactIdOwner = value; return this; }
        public Integer getTotalItemCount() { return TotalItemCount; }
        public ViewRoleModel setTotalItemCount(Integer value) { this.TotalItemCount = value; return this; }
    }

}