/* Options:
Date: 2026-04-04 01:20:16
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get all help content for the specified UI Appliance Component
*/
@Route(Path="/component/{ApplianceComponentId}/help/")
@Api(Description="Get all help content for the specified UI Appliance Component")
open class GetApplianceComponentHelp : IReturn<GetApplianceComponentHelpResponse>
{
    /**
    * Appliance Component Id to retrieve help for.
    */
    @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    open var ApplianceComponentId:UUID? = null
    companion object { private val responseType = GetApplianceComponentHelpResponse::class.java }
    override fun getResponseType(): Any? = GetApplianceComponentHelp.responseType
}

@ApiResponse(Description="A list of help content")
open class GetApplianceComponentHelpResponse
{
    /**
    * List of help content.
    */
    @ApiMember(Description="List of help content.", ParameterType="query")
    open var HelpContent:ArrayList<HelpContentModel>? = null

    /**
    * Response Status
    */
    @ApiMember(Description="Response Status", ParameterType="query")
    open var ResponseStatus:ResponseStatus? = null
}

open class HelpContentModel
{
    /**
    * Content Name - Can be used as a heading/title.
    */
    @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
    open var Name:String? = null

    /**
    * URL containing the help notes. This will either be a web page or a html blob file containing the information.
    */
    @ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")
    open var URL:String? = null

    /**
    * 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, 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")
    open var IsSnippet:Boolean? = null

    /**
    * If true, this content is for external client/users. False means it is a developer note.
    */
    @ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")
    open var IsUserFacing:Boolean? = null

    /**
    * If you have multiple snippets, this is an order you should display them in.
    */
    @ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")
    open var Index:Int? = null

    /**
    * This is the document status of the help content. It will be either draft or final.
    */
    @ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")
    open var StatusId:UUID? = null
}