/* Options:
Date: 2026-04-04 08:43:22
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: GetConnectionsToContact.*
//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 connections to the specified contact for the requestor contact
*/
@Route(Path="/contacts/{ContactId}/connections")
@Api(Description="Get connections to the specified contact for the requestor contact")
open class GetConnectionsToContact : PagedModel(), IReturn<GetConnectionsToContactResponse>
{
    /**
    * Contact Id to get connections for
    */
    @ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
    */
    @ApiMember(DataType="Guid", Description="Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)", IsRequired=true, Name="ContactTypeId")
    open var ContactTypeId:UUID? = null

    /**
    * Contact Id requesting the details - Current user or licensee
    */
    @ApiMember(DataType="Guid", Description="Contact Id requesting the details - Current user or licensee", IsRequired=true, Name="RequestorContactId")
    open var RequestorContactId:UUID? = null

    /**
    * Return all connections or paged results?
    */
    @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    open var IsPagedMode:Boolean? = null

    /**
    * Option to return removed connections
    */
    @ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")
    open var IncludeRemoved:Boolean? = null
    companion object { private val responseType = GetConnectionsToContactResponse::class.java }
    override fun getResponseType(): Any? = GetConnectionsToContact.responseType
}

@ApiResponse(Description="Connections to the specified contact for the requestor contact")
open class GetConnectionsToContactResponse
{
    open var Connections:ArrayList<ContactConnectionModel>? = null
    open var TotalConnections:Int? = null
    open var ResponseStatus:ResponseStatus? = null
}

enum class SortOrder
{
    Ascending,
    Descending,
}

open class PagedModel
{
    /**
    * Page Number to retrieve
    */
    @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    open var PageNumber:Int? = null

    /**
    * Number of records to retrieve
    */
    @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    open var PageSize:Int? = null

    /**
    * Index of field to sort results by
    */
    @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    open var SortIndex:Int? = null

    /**
    * Sort Order - Ascending or Descending
    */
    @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    open var SortOrder:SortOrder? = null
}

open class ContactConnectionModel
{
    /**
    * Connection Id (if applicable)
    */
    @ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")
    open var ConnectionId:UUID? = null

    /**
    * Connection Request Id (if applicable)
    */
    @ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")
    open var ConnectionRequestId:UUID? = null

    /**
    * Details of the contact
    */
    @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")
    open var Contact:ContactSummaryModel? = null

    /**
    * Contact's role Id in the connection
    */
    @ApiMember(DataType="Guid", Description="Contact's role Id in the connection", IsRequired=true, Name="ContactRoleId")
    open var ContactRoleId:UUID? = null

    /**
    * Contact's role name in the connection
    */
    @ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")
    open var ContactRoleName:String? = null

    /**
    * Requestor Contact Id
    */
    @ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")
    open var RequestorContactId:UUID? = null

    /**
    * Requestor Contact Name
    */
    @ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")
    open var RequestorContactName:String? = null

    /**
    * Requestor contact's role Id in the connection
    */
    @ApiMember(DataType="Guid", Description="Requestor contact's role Id in the connection", IsRequired=true, Name="RequestorRoleId")
    open var RequestorRoleId:UUID? = null

    /**
    * Requestor's role name in the connection
    */
    @ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")
    open var RequestorRoleName:String? = null

    /**
    * Primary role in the connection to display
    */
    @ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")
    open var PrimaryRoleName:String? = null

    /**
    * Connection Status Id
    */
    @ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")
    open var ConnectionStatusId:UUID? = null

    /**
    * Connection Status Name
    */
    @ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")
    open var ConnectionStatusName:String? = null

    /**
    * Is this a pending connection request?
    */
    @ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")
    open var IsConnectionRequest:Boolean? = null

    /**
    * Is this an incoming connection request?
    */
    @ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")
    open var IsIncoming:Boolean? = null

    open var FromDate:Date? = null
    /**
    * Details of the contact suggesting this connection
    */
    @ApiMember(DataType="ContactSummaryModel", Description="Details of the contact suggesting this connection", IsRequired=true, Name="SuggesterContact")
    open var SuggesterContact:ContactSummaryModel? = null

    /**
    * Can this connection be cancelled?
    */
    @ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")
    open var AllowCancel:Boolean? = null

    /**
    * Can this connection be removed?
    */
    @ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")
    open var AllowRemove:Boolean? = null
}

open class ContactSummaryModel
{
    /**
    * Contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    open var ContactId:UUID? = 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")
    open var ContactFullName:String? = 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")
    open var EmailAddress:String? = 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")
    open var MobileNumber:String? = null

    /**
    * Primary Phone Number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
    open var PhoneNumber:String? = 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")
    open var ContactTypeId:UUID? = null

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

    /**
    * Thumbnail photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    open var ProfilePhotoThumbnailUrl:String? = null

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

    /**
    * Employment Industry
    */
    @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    open var EmploymentIndustry:String? = null

    /**
    * Employment Role
    */
    @ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
    open var EmploymentRole:String? = null

    /**
    * Areas of Work
    */
    @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    open var EmploymentGeographicArea:String? = null

    /**
    * Timezone Name
    */
    @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    open var TimezoneName:String? = null

    /**
    * The primary address of the contact
    */
    @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    open var PrimaryAddress:String? = 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
}