""" Options:
Date: 2026-04-04 02:56:02
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: GetObjectDimensionValues.*
#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.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionModel:
    # @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    dimension_id: Optional[str] = None
    """
    Id of the Dimension itself.
    """


    # @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
    name: Optional[str] = None
    """
    Dimension name.
    """


    # @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
    description: Optional[str] = None
    """
    Dimension description.
    """


    # @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
    short_name: Optional[str] = None
    """
    Dimension shortened name.
    """


    # @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
    has_traffic_light_for_values: bool = False
    """
    True if the values for the dimension should have colours associated with them.
    """


    # @ApiMember(DataType="bool", Description="", Name="HasImage")
    has_image: bool = False
    """
    
    """

    # @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
    owner_contact_id: Optional[str] = None
    """
    Owner Id of the dimension.
    """


    # @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
    record_status: Optional[str] = None
    """
    Record status of the dimension.
    """


    # @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    dimension_values: Optional[List[DimensionValueModel]] = None
    """
    Dimension values for this dimension.
    """


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


# @ApiResponse(Description="A list of dimensions (and values if they apply) for an object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectDimensionsResponse:
    # @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    dimensions: Optional[List[DimensionModel]] = None
    """
    List of dimensions.
    """


    response_status: Optional[ResponseStatus] = None


# @Route("/dimensionvalues/object/{ObjectId}")
# @Api(Description="Get a list of dimensionValues linked to a specified object")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetObjectDimensionValues(IReturn[GetObjectDimensionsResponse]):
    """
    Get a list of dimensionValues linked to a specified object
    """

    # @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="Object Id to retrieve dimensionValues for.", Name="ObjectId", ParameterType="query")
    object_id: Optional[str] = None
    """
    Object Id to retrieve dimensionValues for.
    """