/* Options:
Date: 2026-04-04 02:59:46
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: GetDimensionValuesList.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Get a list of dimensionValues for a specified dimension
*/
// @Route("/dimensionvalues/{DimensionId}")
// @Api(Description="Get a list of dimensionValues for a specified dimension")
public class GetDimensionValuesList : IReturn, Codable
{
    public typealias Return = GetDimensionValuesListResponse

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

    /**
    * Dimension Id to retrieve dimensionValues for.
    */
    // @ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")
    public var dimensionId:String?

    /**
    * RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
    */
    // @ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")
    public var recordStatus:String?

    required public init(){}
}

// @ApiResponse(Description="A list of dimension values")
public class GetDimensionValuesListResponse : Codable
{
    /**
    * List of dimensionValues.
    */
    // @ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")
    public var dimensionValues:[DimensionValueModel]?

    public var responseStatus:ResponseStatus?

    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(){}
}