""" Options:
Date: 2026-04-04 02:55:19
Version: 8.52
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: GetDimensionValuesList.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionValueModel:
    # @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    dimension_value_id: Optional[str] = None
    """
    Id of the dimension value.
    """


    # @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    dimension_id: Optional[str] = None
    """
    Dimension Id this value is for.
    """


    # @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    name: Optional[str] = None
    """
    Name of the dimension value.
    """


    # @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    description: Optional[str] = None
    """
    Description of the dimension value.
    """


    # @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    short_name: Optional[str] = None
    """
    Short Name for the dimension value.
    """


    # @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    traffic_light_id: Optional[str] = None
    """
    Id of the colour associated.
    """


    # @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    traffic_light_colour: Optional[str] = None
    """
    Colour associated with the dimension value.
    """


    # @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    object_connection_id: Optional[str] = None
    """
    Id that links this dimension value to an object.
    """


    # @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    owner_contact_id: Optional[str] = None
    """
    Owner Id of the dimension value.
    """


    # @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    record_status: Optional[str] = None
    """
    Record status of the dimension value.
    """


# @ApiResponse(Description="A list of dimension values")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionValuesListResponse:
    # @ApiMember(DataType="List<DimensionValueModel>", Description="List of dimensionValues.", Name="DimensionValues", ParameterType="query")
    dimension_values: Optional[List[DimensionValueModel]] = None
    """
    List of dimensionValues.
    """


    response_status: Optional[ResponseStatus] = None


# @Route("/dimensionvalues/{DimensionId}")
# @Api(Description="Get a list of dimensionValues for a specified dimension")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDimensionValuesList(IReturn[GetDimensionValuesListResponse]):
    """
    Get a list of dimensionValues for a specified dimension
    """

    # @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensionValues for.", Name="LicenseeId", ParameterType="query")
    licensee_id: Optional[str] = None
    """
    Licensee Id to retrieve dimensionValues for.
    """


    # @ApiMember(DataType="Guid", Description="Dimension Id to retrieve dimensionValues for.", Name="DimensionId", ParameterType="query")
    dimension_id: Optional[str] = None
    """
    Dimension Id to retrieve dimensionValues for.
    """


    # @ApiMember(DataType="string", Description="RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.", Name="RecordStatus", ParameterType="query")
    record_status: Optional[str] = None
    """
    RecordStatus of dimensionValues to retrieve. If not set 'A' active dimensionValues are retrieved.
    """