/* Options:
Date: 2026-04-04 03:04:31
SwiftVersion: 6.0
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
//MakePropertiesOptional: True
IncludeTypes: GetObjectDimensions.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Get a list of dimensions linked to a specified object
*/
// @Route("/dimensions/object/{ObjectId}")
// @Api(Description="Get a list of dimensions linked to a specified object")
public class GetObjectDimensions : IReturn, Codable
{
    public typealias Return = GetObjectDimensionsResponse

    /**
    * Licensee Id to retrieve dimensions for.
    */
    // @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
    public var licenseeId:String?

    /**
    * Object Id to retrieve dimensions for.
    */
    // @ApiMember(DataType="Guid", Description="Object Id to retrieve dimensions for.", Name="ObjectId", ParameterType="query")
    public var objectId:String?

    required public init(){}
}

// @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
public class GetObjectDimensionsResponse : Codable
{
    /**
    * List of dimensions.
    */
    // @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    public var dimensions:[DimensionModel]?

    public var responseStatus:ResponseStatus?

    required public init(){}
}

public class DimensionModel : Codable
{
    /**
    * Id of the Dimension itself.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    public var dimensionId:String?

    /**
    * Dimension name.
    */
    // @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    public var name:String?

    /**
    * Dimension description.
    */
    // @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    public var Description:String?

    /**
    * Dimension shortened name.
    */
    // @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    public var shortName:String?

    /**
    * True if the values for the dimension should have colours associated with them.
    */
    // @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
    public var hasTrafficLightForValues:Bool?

    /**
    * 
    */
    // @ApiMember(DataType="bool", Description="", Name="HasImage")
    public var hasImage:Bool?

    /**
    * Owner Id of the dimension.
    */
    // @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    public var ownerContactId:String?

    /**
    * Record status of the dimension.
    */
    // @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    public var recordStatus:String?

    /**
    * Dimension values for this dimension.
    */
    // @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    public var dimensionValues:[DimensionValueModel]?

    /**
    * Id that links this dimension to an object.
    */
    // @ApiMember(Description="Id that links this dimension to an object.")
    public var objectConnectionId:String?

    required public init(){}
}

public class DimensionValueModel : Codable
{
    /**
    * Id of the dimension value.
    */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    public var dimensionValueId:String?

    /**
    * Dimension Id this value is for.
    */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    public var dimensionId:String?

    /**
    * Name of the dimension value.
    */
    // @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    public var name:String?

    /**
    * Description of the dimension value.
    */
    // @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    public var Description:String?

    /**
    * Short Name for the dimension value.
    */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    public var shortName:String?

    /**
    * Id of the colour associated.
    */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    public var trafficLightId:String?

    /**
    * Colour associated with the dimension value.
    */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    public var trafficLightColour:String?

    /**
    * Id that links this dimension value to an object.
    */
    // @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    public var objectConnectionId:String?

    /**
    * Owner Id of the dimension value.
    */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    public var ownerContactId:String?

    /**
    * Record status of the dimension value.
    */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    public var recordStatus:String?

    required public init(){}
}