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

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: GetApplianceComponentHelp.*
//ExcludeTypes: 
//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.*;

public class dtos
{

    /**
    * 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")
    public static class GetApplianceComponentHelp implements IReturn<GetApplianceComponentHelpResponse>
    {
        /**
        * Appliance Component Id to retrieve help for.
        */
        @ApiMember(Description="Appliance Component Id to retrieve help for.", ParameterType="path")
        public UUID ApplianceComponentId = null;
        
        public UUID getApplianceComponentId() { return ApplianceComponentId; }
        public GetApplianceComponentHelp setApplianceComponentId(UUID value) { this.ApplianceComponentId = value; return this; }
        private static Object responseType = GetApplianceComponentHelpResponse.class;
        public Object getResponseType() { return responseType; }
    }

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

        /**
        * Response Status
        */
        @ApiMember(Description="Response Status", ParameterType="query")
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<HelpContentModel> getHelpContent() { return HelpContent; }
        public GetApplianceComponentHelpResponse setHelpContent(ArrayList<HelpContentModel> value) { this.HelpContent = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetApplianceComponentHelpResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class HelpContentModel
    {
        /**
        * Content Name - Can be used as a heading/title.
        */
        @ApiMember(Description="Content Name - Can be used as a heading/title.", ParameterType="query")
        public String Name = 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")
        public String URL = 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")
        public Boolean IsSnippet = 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")
        public Boolean IsUserFacing = 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")
        public Integer Index = 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")
        public UUID StatusId = null;
        
        public String getName() { return Name; }
        public HelpContentModel setName(String value) { this.Name = value; return this; }
        public String getUrl() { return URL; }
        public HelpContentModel setUrl(String value) { this.URL = value; return this; }
        public Boolean getIsSnippet() { return IsSnippet; }
        public HelpContentModel setIsSnippet(Boolean value) { this.IsSnippet = value; return this; }
        public Boolean getIsUserFacing() { return IsUserFacing; }
        public HelpContentModel setIsUserFacing(Boolean value) { this.IsUserFacing = value; return this; }
        public Integer getIndex() { return Index; }
        public HelpContentModel setIndex(Integer value) { this.Index = value; return this; }
        public UUID getStatusId() { return StatusId; }
        public HelpContentModel setStatusId(UUID value) { this.StatusId = value; return this; }
    }

}