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

//GlobalNamespace: 
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//InitializeCollections: False
//ExportValueTypes: False
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.Models;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.Models
{
    public partial class 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")]
        public virtual string Name { 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")]
        public virtual string URL { 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")]
        public virtual bool IsSnippet { 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")]
        public virtual bool IsUserFacing { 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")]
        public virtual int Index { 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")]
        public virtual Guid StatusId { get; set; }
    }

}

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<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")]
    public partial class GetApplianceComponentHelp
        : IReturn<GetApplianceComponentHelpResponse>
    {
        ///<summary>
        ///Appliance Component Id to retrieve help for.
        ///</summary>
        [ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")]
        public virtual Guid ApplianceComponentId { get; set; }
    }

    [ApiResponse(Description="A list of help content")]
    public partial class GetApplianceComponentHelpResponse
    {
        ///<summary>
        ///List of help content.
        ///</summary>
        [ApiMember(Description="List of help content.", ParameterType="query")]
        public virtual List<HelpContentModel> HelpContent { get; set; }

        ///<summary>
        ///Response Status
        ///</summary>
        [ApiMember(Description="Response Status", ParameterType="query")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class ResponseStatus
        : IMeta
    {
        [DataMember(Order=1)]
        public virtual string ErrorCode { get; set; }

        [DataMember(Order=2)]
        public virtual string Message { get; set; }

        [DataMember(Order=3)]
        public virtual string StackTrace { get; set; }

        [DataMember(Order=4)]
        public virtual List<ResponseError> Errors { get; set; }

        [DataMember(Order=5)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}