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

        /**
        * Significant Only or All
        */
        @ApiMember(Description="Significant Only or All", IsRequired=true, Name="RelatedItemsLevel")
        public UUID RelatedItemsLevel = null;

        /**
        * Return all connections or paged results?
        */
        @ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
        public Boolean IsPagedMode = null;
        
        public UUID getObjectId() { return ObjectId; }
        public GetRelatedItems setObjectId(UUID value) { this.ObjectId = value; return this; }
        public UUID getRelatedItemsLevel() { return RelatedItemsLevel; }
        public GetRelatedItems setRelatedItemsLevel(UUID value) { this.RelatedItemsLevel = value; return this; }
        public Boolean getIsPagedMode() { return IsPagedMode; }
        public GetRelatedItems setIsPagedMode(Boolean value) { this.IsPagedMode = value; return this; }
        private static Object responseType = GetRelatedItemsResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="Items related to the object.")
    public static class GetRelatedItemsResponse
    {
        public ArrayList<RelatedItemsModel> RelatedItems = null;
        public Integer TotalRelatedItems = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<RelatedItemsModel> getRelatedItems() { return RelatedItems; }
        public GetRelatedItemsResponse setRelatedItems(ArrayList<RelatedItemsModel> value) { this.RelatedItems = value; return this; }
        public Integer getTotalRelatedItems() { return TotalRelatedItems; }
        public GetRelatedItemsResponse setTotalRelatedItems(Integer value) { this.TotalRelatedItems = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetRelatedItemsResponse 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 RelatedItemsModel
    {
        /**
        * Object linked to the related item.
        */
        @ApiMember(DataType="Guid", Description="Object linked to the related item.", IsRequired=true, Name="ObjectId")
        public UUID ObjectId = null;

        /**
        * Related item name.
        */
        @ApiMember(DataType="string", Description="Related item name.", Name="RelatedItemName")
        public String RelatedItemName = null;

        /**
        * Related item type.
        */
        @ApiMember(DataType="string", Description="Related item type.", Name="RelatedItemType")
        public String RelatedItemType = null;

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

        /**
        * Contact who created the related item
        */
        @ApiMember(DataType="string", Description="Contact who created the related item", Name="CreatedByName")
        public String CreatedByName = null;

        /**
        * Contact who created the related item
        */
        @ApiMember(DataType="Guid", Description="Contact who created the related item", Name="CreatedById")
        public UUID CreatedById = 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")
        public String CreatedByThumbnailUrl = null;

        /**
        * Relationship between objects linked to the related item
        */
        @ApiMember(DataType="string", Description="Relationship between objects linked to the related item", Name="Relationship")
        public String Relationship = null;

        /**
        * Is the related item significant?
        */
        @ApiMember(DataType="bool", Description="Is the related item significant?", IsRequired=true, Name="IsSignificant")
        public Boolean IsSignificant = null;
        
        public UUID getObjectId() { return ObjectId; }
        public RelatedItemsModel setObjectId(UUID value) { this.ObjectId = value; return this; }
        public String getRelatedItemName() { return RelatedItemName; }
        public RelatedItemsModel setRelatedItemName(String value) { this.RelatedItemName = value; return this; }
        public String getRelatedItemType() { return RelatedItemType; }
        public RelatedItemsModel setRelatedItemType(String value) { this.RelatedItemType = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public RelatedItemsModel setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public String getCreatedByName() { return CreatedByName; }
        public RelatedItemsModel setCreatedByName(String value) { this.CreatedByName = value; return this; }
        public UUID getCreatedById() { return CreatedById; }
        public RelatedItemsModel setCreatedById(UUID value) { this.CreatedById = value; return this; }
        public String getCreatedByThumbnailUrl() { return CreatedByThumbnailUrl; }
        public RelatedItemsModel setCreatedByThumbnailUrl(String value) { this.CreatedByThumbnailUrl = value; return this; }
        public String getRelationship() { return Relationship; }
        public RelatedItemsModel setRelationship(String value) { this.Relationship = value; return this; }
        public Boolean getIsSignificant() { return IsSignificant; }
        public RelatedItemsModel setIsSignificant(Boolean value) { this.IsSignificant = value; return this; }
    }

}