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

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
//MakePropertiesOptional: True
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Get all help content for the specified UI Appliance Component
*/
// @Route("/component/{ApplianceComponentId}/help/")
// @Api(Description="Get all help content for the specified UI Appliance Component")
public class GetApplianceComponentHelp : IReturn, Codable
{
    public typealias Return = GetApplianceComponentHelpResponse

    /**
    * Appliance Component Id to retrieve help for.
    */
    // @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    public var applianceComponentId:String?

    required public init(){}
}

// @ApiResponse(Description="A list of help content")
public class GetApplianceComponentHelpResponse : Codable
{
    /**
    * List of help content.
    */
    // @ApiMember(Description="List of help content.", ParameterType="query")
    public var helpContent:[HelpContentModel]?

    /**
    * Response Status
    */
    // @ApiMember(Description="Response Status", ParameterType="query")
    public var responseStatus:ResponseStatus?

    required public init(){}
}

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

    /**
    * 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")
    public var url:String?

    /**
    * 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")
    public var isSnippet:Bool?

    /**
    * 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")
    public var isUserFacing:Bool?

    /**
    * 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")
    public var index:Int?

    /**
    * 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")
    public var statusId:String?

    required public init(){}
}