/* Options:
Date: 2026-04-04 06:45:39
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: GetObjectCommunication.*
//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.*


/**
* Get communication related to the specified object.
*/
@Route(Path="/communication/object/{ObjectId}")
@Api(Description="Get communication related to the specified object.")
open class GetObjectCommunication : IReturn<GetObjectCommunicationResponse>
{
    /**
    * Object to get communication for.
    */
    @ApiMember(Description="Object to get communication for.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null
    companion object { private val responseType = GetObjectCommunicationResponse::class.java }
    override fun getResponseType(): Any? = GetObjectCommunication.responseType
}

@ApiResponse(Description="Communication related to the object.")
open class GetObjectCommunicationResponse
{
    open var Communication:ArrayList<CommunicationModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CommunicationModel
{
    /**
    * Communication Id
    */
    @ApiMember(DataType="Guid", Description="Communication Id", IsRequired=true, Name="CommunicationId")
    open var CommunicationId:UUID? = 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")
    open var CommunicationTypeId:UUID? = null

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

    /**
    * Communication Subject
    */
    @ApiMember(DataType="string", Description="Communication Subject", Name="Subject")
    open var Subject:String? = null

    /**
    * Communication Body
    */
    @ApiMember(DataType="string", Description="Communication Body", IsRequired=true, Name="Body")
    open var Body:String? = null

    /**
    * Date and Time communication record created
    */
    @ApiMember(DataType="DateTime", Description="Date and Time communication record created", IsRequired=true, Name="CreatedAt")
    open var CreatedAt:Date? = 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")
    open var ReleaseAt:Date? = null

    /**
    * Sender or the creater of the communication
    */
    @ApiMember(Description="Sender or the creater of the communication", IsRequired=true, Name="Sender")
    open var Sender:UserProfileModel? = 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")
    open var Recipients:ArrayList<UserProfileModel> = ArrayList<UserProfileModel>()

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

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

    /**
    * Indicates whether the sender is a customer
    */
    @ApiMember(DataType="Boolean", Description="Indicates whether the sender is a customer", IsRequired=true, Name="SentByCustomer")
    open var SentByCustomer:Boolean? = 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")
    open var SentByStaff:Boolean? = 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
}