/* Options:
Date: 2026-04-04 01:22:10
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: GetRelatedItems.*
//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 related items related to the specified object.
*/
@Route(Path="/relateditems/{ObjectId}")
@Api(Description="Get related items related to the specified object.")
open class GetRelatedItems : PagedModel(), IReturn<GetRelatedItemsResponse>
{
    /**
    * Object to get related items for.
    */
    @ApiMember(Description="Object to get related items for.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null

    /**
    * Significant Only or All
    */
    @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
    open var RelatedItemsLevel:UUID? = null

    /**
    * Return all connections or paged results?
    */
    @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
    open var IsPagedMode:Boolean? = null
    companion object { private val responseType = GetRelatedItemsResponse::class.java }
    override fun getResponseType(): Any? = GetRelatedItems.responseType
}

@ApiResponse(Description="Items related to the object.")
open class GetRelatedItemsResponse
{
    open var RelatedItems:ArrayList<RelatedItemsModel>? = null
    open var TotalRelatedItems: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 RelatedItemsModel
{
    /**
    * Object linked to the related item.
    */
    @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null

    /**
    * Related item name.
    */
    @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
    open var RelatedItemName:String? = null

    /**
    * Related item type.
    */
    @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
    open var RelatedItemType:String? = null

    /**
    * Date of creation of the related item.
    */
    @ApiMember(DataType="DateTime", Description="Date of creation of the related item.", IsRequired=true, Name="CreatedAt")
    open var CreatedAt:Date? = null

    /**
    * Contact who created the related item
    */
    @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
    open var CreatedByName:String? = null

    /**
    * Contact who created the related item
    */
    @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
    open var CreatedById:UUID? = null

    /**
    * Profile photo of the contact who created the related item
    */
    @ApiMember(DataType="string", Description="Profile photo of the contact who created the related item", Name="CreatedByThumbnailUrl")
    open var CreatedByThumbnailUrl:String? = null

    /**
    * Relationship between objects linked to the related item
    */
    @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
    open var Relationship:String? = null

    /**
    * Is the related item significant?
    */
    @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
    open var IsSignificant:Boolean? = null
}