""" Options:
Date: 2026-04-04 08:34:39
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: GetApplianceComponentHelp.*
#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 HelpContentModel:
    # @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
    name: Optional[str] = None
    """
    Content Name - Can be used as a heading/title.
    """


    # @ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")
    url: Optional[str] = None
    """
    URL containing the help notes. This will either be a web page or a html blob file containing the information.
    """


    # @ApiMember(Description="If true, the URL is a blob file and details should be shown in a pop up or tooltip, if false, this is a full URL to a web page and should be opened in a new tab.", ParameterType="query")
    is_snippet: bool = False
    """
    If true, the URL is a blob file and details should be shown in a pop up or tooltip, if false, this is a full URL to a web page and should be opened in a new tab.
    """


    # @ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")
    is_user_facing: bool = False
    """
    If true, this content is for external client/users. False means it is a developer note.
    """


    # @ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")
    index: int = 0
    """
    If you have multiple snippets, this is an order you should display them in.
    """


    # @ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")
    status_id: Optional[str] = None
    """
    This is the document status of the help content. It will be either draft or final.
    """


# @ApiResponse(Description="A list of help content")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApplianceComponentHelpResponse:
    # @ApiMember(Description="List of help content.", ParameterType="query")
    help_content: Optional[List[HelpContentModel]] = None
    """
    List of help content.
    """


    # @ApiMember(Description="Response Status", ParameterType="query")
    response_status: Optional[ResponseStatus] = None
    """
    Response Status
    """


# @Route("/component/{ApplianceComponentId}/help/")
# @Api(Description="Get all help content for the specified UI Appliance Component")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetApplianceComponentHelp(IReturn[GetApplianceComponentHelpResponse]):
    """
    Get all help content for the specified UI Appliance Component
    """

    # @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    appliance_component_id: Optional[str] = None
    """
    Appliance Component Id to retrieve help for.
    """