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

//GlobalNamespace: 
//MakeDataContractsExtensible: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//ExportValueTypes: False
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//InitializeCollections: False
//AddNamespaces: 
*)

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type HelpContentModel() = 
        ///<summary>
        ///Content Name - Can be used as a heading/title.
        ///</summary>
        [<ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")>]
        member val Name:String = null with get,set

        ///<summary>
        ///URL containing the help notes. This will either be a web page or a html blob file containing the information.
        ///</summary>
        [<ApiMember(Description="URL containing the help notes. This will either be a web page or a html blob file containing the information.", ParameterType="query")>]
        member val URL:String = null with get,set

        ///<summary>
        ///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.
        ///</summary>
        [<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")>]
        member val IsSnippet:Boolean = new Boolean() with get,set

        ///<summary>
        ///If true, this content is for external client/users. False means it is a developer note.
        ///</summary>
        [<ApiMember(Description="If true, this content is for external client/users. False means it is a developer note.", ParameterType="query")>]
        member val IsUserFacing:Boolean = new Boolean() with get,set

        ///<summary>
        ///If you have multiple snippets, this is an order you should display them in.
        ///</summary>
        [<ApiMember(Description="If you have multiple snippets, this is an order you should display them in.", ParameterType="query")>]
        member val Index:Int32 = new Int32() with get,set

        ///<summary>
        ///This is the document status of the help content. It will be either draft or final.
        ///</summary>
        [<ApiMember(Description="This is the document status of the help content. It will be either draft or final.", ParameterType="query")>]
        member val StatusId:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ResizeArray<ResponseError> = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<ApiResponse(Description="A list of help content")>]
    [<AllowNullLiteral>]
    type GetApplianceComponentHelpResponse() = 
        ///<summary>
        ///List of help content.
        ///</summary>
        [<ApiMember(Description="List of help content.", ParameterType="query")>]
        member val HelpContent:ResizeArray<HelpContentModel> = null with get,set

        ///<summary>
        ///Response Status
        ///</summary>
        [<ApiMember(Description="Response Status", ParameterType="query")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get all help content for the specified UI Appliance Component
    ///</summary>
    [<Route("/component/{ApplianceComponentId}/help/")>]
    [<Api(Description="Get all help content for the specified UI Appliance Component")>]
    [<AllowNullLiteral>]
    type GetApplianceComponentHelp() = 
        interface IReturn<GetApplianceComponentHelpResponse>
        ///<summary>
        ///Appliance Component Id to retrieve help for.
        ///</summary>
        [<ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")>]
        member val ApplianceComponentId:Guid = new Guid() with get,set