/* Options:
Date: 2026-04-04 02:55:30
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: GetObjectCommunicationPaged.*
//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 communication related to the specified object. (paged)
    */
    @Route(Path="/communications")
    @Api(Description="Get communication related to the specified object. (paged)")
    public static class GetObjectCommunicationPaged implements IReturn<GetObjectCommunicationResponse>
    {
        /**
        * Object to get communication for.
        */
        @ApiMember(Description="Object to get communication for.", IsRequired=true, Name="ObjectId")
        public UUID ObjectId = null;

        /**
        * Date/time from the communication records should be retrieved for.
        */
        @ApiMember(DataType="DateTime", Description="Date/time from the communication records should be retrieved for.", Name="DateTimeFrom")
        public Date DateTimeFrom = null;

        /**
        * Date/time to the communication records should be retrieved for.
        */
        @ApiMember(DataType="DateTime", Description="Date/time to the communication records should be retrieved for.", Name="DateTimeTo")
        public Date DateTimeTo = null;

        /**
        * types of communications (e.g. Email, SMS, Comment).
        */
        @ApiMember(Description="types of communications (e.g. Email, SMS, Comment).", IsRequired=true, Name="Communication Types")
        public ArrayList<UUID> CommunicationTypes = new ArrayList<UUID>();

        /**
        * Get communications matching the specified search text criteria.
        */
        @ApiMember(Description="Get communications matching the specified search text criteria.", Name="SearchText")
        public String SearchText = null;

        /**
        * Return all communications matching criteria or paged results?
        */
        @ApiMember(Description="Return all communications matching criteria or paged results?", Name="IsPagedMode")
        public Boolean IsPagedMode = null;

        /**
        * Return communications matching criteria on the specified page number if paged mode.
        */
        @ApiMember(Description="Return communications matching criteria on the specified page number if paged mode.", Name="PageNumber")
        public Integer PageNumber = null;

        /**
        * Number of communications on each page if paged mode
        */
        @ApiMember(Description="Number of communications on each page if paged mode", Name="PageSize")
        public Integer PageSize = null;

        /**
        * Index of the column to be sorted the results with
        */
        @ApiMember(Description="Index of the column to be sorted the results with", Name="SortIndex")
        public Integer SortIndex = null;

        /**
        * order of the sorting to be applied
        */
        @ApiMember(Description="order of the sorting to be applied", Name="SortOrder")
        public Integer SortOrder = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetObjectCommunicationPaged setObjectId(UUID value) { this.ObjectId = value; return this; }
        public Date getDateTimeFrom() { return DateTimeFrom; }
        public GetObjectCommunicationPaged setDateTimeFrom(Date value) { this.DateTimeFrom = value; return this; }
        public Date getDateTimeTo() { return DateTimeTo; }
        public GetObjectCommunicationPaged setDateTimeTo(Date value) { this.DateTimeTo = value; return this; }
        public ArrayList<UUID> getCommunicationTypes() { return CommunicationTypes; }
        public GetObjectCommunicationPaged setCommunicationTypes(ArrayList<UUID> value) { this.CommunicationTypes = value; return this; }
        public String getSearchText() { return SearchText; }
        public GetObjectCommunicationPaged setSearchText(String value) { this.SearchText = value; return this; }
        public Boolean getIsPagedMode() { return IsPagedMode; }
        public GetObjectCommunicationPaged setIsPagedMode(Boolean value) { this.IsPagedMode = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetObjectCommunicationPaged setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetObjectCommunicationPaged setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getSortIndex() { return SortIndex; }
        public GetObjectCommunicationPaged setSortIndex(Integer value) { this.SortIndex = value; return this; }
        public Integer getSortOrder() { return SortOrder; }
        public GetObjectCommunicationPaged setSortOrder(Integer value) { this.SortOrder = value; return this; }
        private static Object responseType = GetObjectCommunicationResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="Communication related to the object.")
    public static class GetObjectCommunicationResponse
    {
        public ArrayList<CommunicationModel> Communication = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CommunicationModel> getCommunication() { return Communication; }
        public GetObjectCommunicationResponse setCommunication(ArrayList<CommunicationModel> value) { this.Communication = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetObjectCommunicationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CommunicationModel
    {
        /**
        * Communication Id
        */
        @ApiMember(DataType="Guid", Description="Communication Id", IsRequired=true, Name="CommunicationId")
        public UUID CommunicationId = null;

        /**
        * Communication Type Id e.g. SMS, Email, Comment.
        */
        @ApiMember(DataType="Guid", Description="Communication Type Id e.g. SMS, Email, Comment.", IsRequired=true, Name="CommunicationTypeId")
        public UUID CommunicationTypeId = null;

        /**
        * Communication Type Name e.g. SMS, Email, Comment.
        */
        @ApiMember(DataType="string", Description="Communication Type Name e.g. SMS, Email, Comment.", Name="CommunicationTypeName")
        public String CommunicationTypeName = null;

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

        /**
        * Communication Body
        */
        @ApiMember(DataType="string", Description="Communication Body", IsRequired=true, Name="Body")
        public String Body = null;

        /**
        * Date and Time communication record created
        */
        @ApiMember(DataType="DateTime", Description="Date and Time communication record created", IsRequired=true, Name="CreatedAt")
        public Date CreatedAt = null;

        /**
        * Date and Time communication record released (e.g. Email sent date time)
        */
        @ApiMember(DataType="DateTime", Description="Date and Time communication record released (e.g. Email sent date time)", IsRequired=true, Name="ReleaseAt")
        public Date ReleaseAt = null;

        /**
        * Sender or the creater of the communication
        */
        @ApiMember(Description="Sender or the creater of the communication", IsRequired=true, Name="Sender")
        public UserProfileModel Sender = null;

        /**
        * Primary recipient(s) of the communication (e.g. 'To' contacts of an email).
        */
        @ApiMember(Description="Primary recipient(s) of the communication (e.g. 'To' contacts of an email).", IsRequired=true, Name="Recipients")
        public ArrayList<UserProfileModel> Recipients = new ArrayList<UserProfileModel>();

        /**
        * Cc recipient(s) of the communication.
        */
        @ApiMember(Description="Cc recipient(s) of the communication.", IsRequired=true, Name="CcRecipients")
        public ArrayList<UserProfileModel> CcRecipients = new ArrayList<UserProfileModel>();

        /**
        * Bcc recipient(s) of the communication.
        */
        @ApiMember(Description="Bcc recipient(s) of the communication.", IsRequired=true, Name="BccRecipients")
        public ArrayList<UserProfileModel> BccRecipients = new ArrayList<UserProfileModel>();

        /**
        * Indicates whether the sender is a customer
        */
        @ApiMember(DataType="Boolean", Description="Indicates whether the sender is a customer", IsRequired=true, Name="SentByCustomer")
        public Boolean SentByCustomer = null;

        /**
        * Indicates whether the sender is a staff member (Internal contact)
        */
        @ApiMember(DataType="Boolean", Description="Indicates whether the sender is a staff member (Internal contact)", IsRequired=true, Name="SentByStaff")
        public Boolean SentByStaff = null;
        
        public UUID getCommunicationId() { return CommunicationId; }
        public CommunicationModel setCommunicationId(UUID value) { this.CommunicationId = value; return this; }
        public UUID getCommunicationTypeId() { return CommunicationTypeId; }
        public CommunicationModel setCommunicationTypeId(UUID value) { this.CommunicationTypeId = value; return this; }
        public String getCommunicationTypeName() { return CommunicationTypeName; }
        public CommunicationModel setCommunicationTypeName(String value) { this.CommunicationTypeName = value; return this; }
        public String getSubject() { return Subject; }
        public CommunicationModel setSubject(String value) { this.Subject = value; return this; }
        public String getBody() { return Body; }
        public CommunicationModel setBody(String value) { this.Body = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public CommunicationModel setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getReleaseAt() { return ReleaseAt; }
        public CommunicationModel setReleaseAt(Date value) { this.ReleaseAt = value; return this; }
        public UserProfileModel getSender() { return Sender; }
        public CommunicationModel setSender(UserProfileModel value) { this.Sender = value; return this; }
        public ArrayList<UserProfileModel> getRecipients() { return Recipients; }
        public CommunicationModel setRecipients(ArrayList<UserProfileModel> value) { this.Recipients = value; return this; }
        public ArrayList<UserProfileModel> getCcRecipients() { return CcRecipients; }
        public CommunicationModel setCcRecipients(ArrayList<UserProfileModel> value) { this.CcRecipients = value; return this; }
        public ArrayList<UserProfileModel> getBccRecipients() { return BccRecipients; }
        public CommunicationModel setBccRecipients(ArrayList<UserProfileModel> value) { this.BccRecipients = value; return this; }
        public Boolean isSentByCustomer() { return SentByCustomer; }
        public CommunicationModel setSentByCustomer(Boolean value) { this.SentByCustomer = value; return this; }
        public Boolean isSentByStaff() { return SentByStaff; }
        public CommunicationModel setSentByStaff(Boolean value) { this.SentByStaff = 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; }
    }

}