/* Options:
Date: 2026-04-04 01:02:54
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: GetContacts.*
//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 contacts connected to the current contact or licensee (if managing licensee contacts) by criteria
    */
    @Route(Path="/contacts")
    @Api(Description="Get contacts connected to the current contact or licensee (if managing licensee contacts) by criteria")
    public static class GetContacts extends PagedModel implements IReturn<GetContactsResponse>
    {
        /**
        * Specific search text to search for i.e. Contact Name, Employment Details etc.
        */
        @ApiMember(DataType="string", Description="Specific search text to search for i.e. Contact Name, Employment Details etc.", Name="SearchText")
        public String SearchText = null;

        /**
        * Contact Types to search for i.e. People and/ or Organisations
        */
        @ApiMember(DataType="List<Guid>", Description="Contact Types to search for i.e. People and/ or Organisations", IsRequired=true, Name="ContactTypes")
        public ArrayList<UUID> ContactTypes = new ArrayList<UUID>();

        /**
        * Contact statuses to search for i.e. Real and/ or Virtual
        */
        @ApiMember(DataType="List<Guid>", Description="Contact statuses to search for i.e. Real and/ or Virtual", IsRequired=true, Name="Statuses")
        public ArrayList<UUID> Statuses = new ArrayList<UUID>();

        /**
        * Include contacts who are were previously connected to the contact but now removed.
        */
        @ApiMember(DataType="bool", Description="Include contacts who are were previously connected to the contact but now removed.", Name="IncludeRemoved")
        public Boolean IncludeRemoved = null;

        /**
        * Return all contacts matching criteria or paged results?
        */
        @ApiMember(Description="Return all contacts matching criteria or paged results?", Name="IsPagedMode")
        public Boolean IsPagedMode = null;
        
        public String getSearchText() { return SearchText; }
        public GetContacts setSearchText(String value) { this.SearchText = value; return this; }
        public ArrayList<UUID> getContactTypes() { return ContactTypes; }
        public GetContacts setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
        public ArrayList<UUID> getStatuses() { return Statuses; }
        public GetContacts setStatuses(ArrayList<UUID> value) { this.Statuses = value; return this; }
        public Boolean isIncludeRemoved() { return IncludeRemoved; }
        public GetContacts setIncludeRemoved(Boolean value) { this.IncludeRemoved = value; return this; }
        public Boolean getIsPagedMode() { return IsPagedMode; }
        public GetContacts setIsPagedMode(Boolean value) { this.IsPagedMode = value; return this; }
        private static Object responseType = GetContactsResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="Contacts connected to contact by criteria and response status")
    public static class GetContactsResponse
    {
        public ArrayList<UserProfileModel> Contacts = null;
        public Integer TotalContacts = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<UserProfileModel> getContacts() { return Contacts; }
        public GetContactsResponse setContacts(ArrayList<UserProfileModel> value) { this.Contacts = value; return this; }
        public Integer getTotalContacts() { return TotalContacts; }
        public GetContactsResponse setTotalContacts(Integer value) { this.TotalContacts = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetContactsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = 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 UserProfileModel extends UserProfileSummaryModel
    {
        /**
        * Contact Date of Birth (when person type)
        */
        @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")
        public Date BirthDate = null;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        /**
        * Have all connections to the contact been removed?
        */
        @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
        public Boolean IsRemovedContact = 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")
        public Boolean IsDefault = 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")
        public Boolean IsEmailEditable = 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")
        public String PrimaryImageContent = 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")
        public String PrimaryImageContentType = null;

        /**
        * Primary image file name
        */
        @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")
        public String PrimaryImageFileName = null;
        
        public Date getBirthDate() { return BirthDate; }
        public UserProfileModel setBirthDate(Date value) { this.BirthDate = value; return this; }
        public String getMaritalStatusName() { return MaritalStatusName; }
        public UserProfileModel setMaritalStatusName(String value) { this.MaritalStatusName = value; return this; }
        public String getGenderName() { return GenderName; }
        public UserProfileModel setGenderName(String value) { this.GenderName = value; return this; }
        public UUID getGenderId() { return GenderId; }
        public UserProfileModel setGenderId(UUID value) { this.GenderId = value; return this; }
        public ArrayList<ContactDetailModel> getContactDetails() { return ContactDetails; }
        public UserProfileModel setContactDetails(ArrayList<ContactDetailModel> value) { this.ContactDetails = value; return this; }
        public ContactDetailModel getPrimaryStreetAddress() { return PrimaryStreetAddress; }
        public UserProfileModel setPrimaryStreetAddress(ContactDetailModel value) { this.PrimaryStreetAddress = value; return this; }
        public ContactDetailModel getPrimaryPostalAddress() { return PrimaryPostalAddress; }
        public UserProfileModel setPrimaryPostalAddress(ContactDetailModel value) { this.PrimaryPostalAddress = value; return this; }
        public ContactDetailModel getPrimaryRegisteredAddress() { return PrimaryRegisteredAddress; }
        public UserProfileModel setPrimaryRegisteredAddress(ContactDetailModel value) { this.PrimaryRegisteredAddress = value; return this; }
        public ContactDetailModel getPrimaryEmail() { return PrimaryEmail; }
        public UserProfileModel setPrimaryEmail(ContactDetailModel value) { this.PrimaryEmail = value; return this; }
        public ContactDetailModel getPrimaryMobile() { return PrimaryMobile; }
        public UserProfileModel setPrimaryMobile(ContactDetailModel value) { this.PrimaryMobile = value; return this; }
        public ContactDetailModel getPrimaryPhone() { return PrimaryPhone; }
        public UserProfileModel setPrimaryPhone(ContactDetailModel value) { this.PrimaryPhone = value; return this; }
        public ContactDetailModel getPrimaryFax() { return PrimaryFax; }
        public UserProfileModel setPrimaryFax(ContactDetailModel value) { this.PrimaryFax = value; return this; }
        public ContactDetailModel getPrimaryWeb() { return PrimaryWeb; }
        public UserProfileModel setPrimaryWeb(ContactDetailModel value) { this.PrimaryWeb = value; return this; }
        public ContactDetailModel getSocialMediaTwitter() { return SocialMediaTwitter; }
        public UserProfileModel setSocialMediaTwitter(ContactDetailModel value) { this.SocialMediaTwitter = value; return this; }
        public ContactDetailModel getSocialMediaFacebook() { return SocialMediaFacebook; }
        public UserProfileModel setSocialMediaFacebook(ContactDetailModel value) { this.SocialMediaFacebook = value; return this; }
        public ContactDetailModel getSocialMediaInstagram() { return SocialMediaInstagram; }
        public UserProfileModel setSocialMediaInstagram(ContactDetailModel value) { this.SocialMediaInstagram = value; return this; }
        public Boolean getIsRemovedContact() { return IsRemovedContact; }
        public UserProfileModel setIsRemovedContact(Boolean value) { this.IsRemovedContact = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public UserProfileModel setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public Boolean getIsEmailEditable() { return IsEmailEditable; }
        public UserProfileModel setIsEmailEditable(Boolean value) { this.IsEmailEditable = value; return this; }
        public String getPrimaryImageContent() { return PrimaryImageContent; }
        public UserProfileModel setPrimaryImageContent(String value) { this.PrimaryImageContent = value; return this; }
        public String getPrimaryImageContentType() { return PrimaryImageContentType; }
        public UserProfileModel setPrimaryImageContentType(String value) { this.PrimaryImageContentType = value; return this; }
        public String getPrimaryImageFileName() { return PrimaryImageFileName; }
        public UserProfileModel setPrimaryImageFileName(String value) { this.PrimaryImageFileName = value; return this; }
    }

}