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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export class HelpContentModel
{
    /** @description Content Name - Can be used as a heading/title. */
    // @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
    public Name: string;

    /** @description 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 URL: string;

    /** @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. */
    // @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 IsSnippet: boolean;

    /** @description 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 IsUserFacing: boolean;

    /** @description 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 Index: number;

    /** @description 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 StatusId: string;

    public constructor(init?: Partial<HelpContentModel>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public ErrorCode: string;

    // @DataMember(Order=2)
    public Message: string;

    // @DataMember(Order=3)
    public StackTrace: string;

    // @DataMember(Order=4)
    public Errors: ResponseError[];

    // @DataMember(Order=5)
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="A list of help content")
export class GetApplianceComponentHelpResponse
{
    /** @description List of help content. */
    // @ApiMember(Description="List of help content.", ParameterType="query")
    public HelpContent: HelpContentModel[];

    /** @description Response Status */
    // @ApiMember(Description="Response Status", ParameterType="query")
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetApplianceComponentHelpResponse>) { (Object as any).assign(this, init); }
}

/** @description 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")
export class GetApplianceComponentHelp implements IReturn<GetApplianceComponentHelpResponse>
{
    /** @description Appliance Component Id to retrieve help for. */
    // @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
    public ApplianceComponentId: string;

    public constructor(init?: Partial<GetApplianceComponentHelp>) { (Object as any).assign(this, init); }
    public getTypeName() { return 'GetApplianceComponentHelp'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new GetApplianceComponentHelpResponse(); }
}