/* Options:
Date: 2026-04-04 01:05:45
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: GetDimensionsList.*
//ExcludeTypes: 
//DefaultImports: package:servicestack/servicestack.dart
*/

import 'package:servicestack/servicestack.dart';

class DimensionValueModel implements IConvertible
{
    /**
    * Id of the dimension value.
    */
    // @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    String? DimensionValueId;

    /**
    * Dimension Id this value is for.
    */
    // @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    String? DimensionId;

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

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

    /**
    * Short Name for the dimension value.
    */
    // @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    String? ShortName;

    /**
    * Id of the colour associated.
    */
    // @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    String? TrafficLightId;

    /**
    * Colour associated with the dimension value.
    */
    // @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    String? TrafficLightColour;

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

    /**
    * Owner Id of the dimension value.
    */
    // @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    String? OwnerContactId;

    /**
    * Record status of the dimension value.
    */
    // @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    String? RecordStatus;

    DimensionValueModel({this.DimensionValueId,this.DimensionId,this.Name,this.Description,this.ShortName,this.TrafficLightId,this.TrafficLightColour,this.ObjectConnectionId,this.OwnerContactId,this.RecordStatus});
    DimensionValueModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DimensionValueId = json['DimensionValueId'];
        DimensionId = json['DimensionId'];
        Name = json['Name'];
        Description = json['Description'];
        ShortName = json['ShortName'];
        TrafficLightId = json['TrafficLightId'];
        TrafficLightColour = json['TrafficLightColour'];
        ObjectConnectionId = json['ObjectConnectionId'];
        OwnerContactId = json['OwnerContactId'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DimensionValueId': DimensionValueId,
        'DimensionId': DimensionId,
        'Name': Name,
        'Description': Description,
        'ShortName': ShortName,
        'TrafficLightId': TrafficLightId,
        'TrafficLightColour': TrafficLightColour,
        'ObjectConnectionId': ObjectConnectionId,
        'OwnerContactId': OwnerContactId,
        'RecordStatus': RecordStatus
    };

    getTypeName() => "DimensionValueModel";
    TypeContext? context = _ctx;
}

class DimensionModel implements IConvertible
{
    /**
    * Id of the Dimension itself.
    */
    // @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
    String? DimensionId;

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

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

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

    /**
    * 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")
    bool? HasTrafficLightForValues;

    /**
    * 
    */
    // @ApiMember(DataType="bool", Description="", Name="HasImage")
    bool? HasImage;

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

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

    /**
    * Dimension values for this dimension.
    */
    // @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
    List<DimensionValueModel>? DimensionValues;

    /**
    * Id that links this dimension to an object.
    */
    // @ApiMember(Description="Id that links this dimension to an object.")
    String? ObjectConnectionId;

    DimensionModel({this.DimensionId,this.Name,this.Description,this.ShortName,this.HasTrafficLightForValues,this.HasImage,this.OwnerContactId,this.RecordStatus,this.DimensionValues,this.ObjectConnectionId});
    DimensionModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DimensionId = json['DimensionId'];
        Name = json['Name'];
        Description = json['Description'];
        ShortName = json['ShortName'];
        HasTrafficLightForValues = json['HasTrafficLightForValues'];
        HasImage = json['HasImage'];
        OwnerContactId = json['OwnerContactId'];
        RecordStatus = json['RecordStatus'];
        DimensionValues = JsonConverters.fromJson(json['DimensionValues'],'List<DimensionValueModel>',context!);
        ObjectConnectionId = json['ObjectConnectionId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DimensionId': DimensionId,
        'Name': Name,
        'Description': Description,
        'ShortName': ShortName,
        'HasTrafficLightForValues': HasTrafficLightForValues,
        'HasImage': HasImage,
        'OwnerContactId': OwnerContactId,
        'RecordStatus': RecordStatus,
        'DimensionValues': JsonConverters.toJson(DimensionValues,'List<DimensionValueModel>',context!),
        'ObjectConnectionId': ObjectConnectionId
    };

    getTypeName() => "DimensionModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="A list of dimensions")
class GetDimensionsListResponse implements IConvertible
{
    /**
    * List of dimensions.
    */
    // @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
    List<DimensionModel>? Dimensions;

    ResponseStatus? ResponseStatus;

    GetDimensionsListResponse({this.Dimensions,this.ResponseStatus});
    GetDimensionsListResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Dimensions = JsonConverters.fromJson(json['Dimensions'],'List<DimensionModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Dimensions': JsonConverters.toJson(Dimensions,'List<DimensionModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetDimensionsListResponse";
    TypeContext? context = _ctx;
}

/**
* Get a list of dimensions for a licensee, as well as any standard dimensions
*/
// @Route("/dimensions/")
// @Api(Description="Get a list of dimensions for a licensee, as well as any standard dimensions")
class GetDimensionsList implements IReturn<GetDimensionsListResponse>, IConvertible, IGet
{
    /**
    * Licensee Id to retrieve dimensions for.
    */
    // @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
    String? LicenseeId;

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

    GetDimensionsList({this.LicenseeId,this.RecordStatus});
    GetDimensionsList.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        LicenseeId = json['LicenseeId'];
        RecordStatus = json['RecordStatus'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'LicenseeId': LicenseeId,
        'RecordStatus': RecordStatus
    };

    createResponse() => GetDimensionsListResponse();
    getResponseTypeName() => "GetDimensionsListResponse";
    getTypeName() => "GetDimensionsList";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'DimensionValueModel': TypeInfo(TypeOf.Class, create:() => DimensionValueModel()),
    'DimensionModel': TypeInfo(TypeOf.Class, create:() => DimensionModel()),
    'List<DimensionValueModel>': TypeInfo(TypeOf.Class, create:() => <DimensionValueModel>[]),
    'GetDimensionsListResponse': TypeInfo(TypeOf.Class, create:() => GetDimensionsListResponse()),
    'List<DimensionModel>': TypeInfo(TypeOf.Class, create:() => <DimensionModel>[]),
    'GetDimensionsList': TypeInfo(TypeOf.Class, create:() => GetDimensionsList()),
});