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

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetAutomationNotificationsForObject.*
//ExcludeTypes: 
//InitializeCollections: False
//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.*


/**
* Get (automation) notifications that are setup for an object
*/
@Route(Path="/automation/notification/{ObjectId}/list", Verbs="GET")
// @Route(Path="/automation/notification/{ObjectId}/list/standard", Verbs="GET")
// @Route(Path="/automation/notification/{ObjectId}/list/templated", Verbs="GET")
@Api(Description="Get (automation) notifications that are setup for an object")
open class GetAutomationNotificationsForObject : IReturn<GetAutomationNotificationsForObjectResponse>
{
    /**
    * Object to retrieve (automation) notifications for.
    */
    @ApiMember(Description="Object to retrieve (automation) notifications for.", ParameterType="path")
    open var ObjectId:UUID? = null
    companion object { private val responseType = GetAutomationNotificationsForObjectResponse::class.java }
    override fun getResponseType(): Any? = GetAutomationNotificationsForObject.responseType
}

@ApiResponse(Description="List of (automation) notifications that are setup for an object.")
open class GetAutomationNotificationsForObjectResponse
{
    /**
    * List of (automation) notifications.
    */
    @ApiMember(Description="List of (automation) notifications.")
    open var Notifications:ArrayList<AutoNotificationModel>? = null

    open var ResponseStatus:ResponseStatus? = null
}

open class AutoNotificationModel : AutomationModel()
{
    /**
    * Contact Id of the licensee this notification has been created for.
    */
    @ApiMember(Description="Contact Id of the licensee this notification has been created for.", ParameterType="query")
    open var ContactIdLicensee:UUID? = null

    /**
    * Contact Role Group Id. If the notification is setup for people in a specified contact role group.
    */
    @ApiMember(Description="Contact Role Group Id. If the notification is setup for people in a specified contact role group.", ParameterType="query")
    open var ContactRoleGroupId:UUID? = null

    /**
    * Contact Role Id. If the notification is setup for people in a specified role.
    */
    @ApiMember(Description="Contact Role Id. If the notification is setup for people in a specified role.", ParameterType="query")
    open var ContactRoleId:UUID? = null

    /**
    * Contact Role Name. If the notification is setup for people in a specified role.
    */
    @ApiMember(Description="Contact Role Name. If the notification is setup for people in a specified role.", ParameterType="query")
    open var ContactRoleName:String? = null

    /**
    * Contact Id. If the notification is setup for a specific person.
    */
    @ApiMember(Description="Contact Id. If the notification is setup for a specific person.", ParameterType="query")
    open var ContactId:UUID? = null

    /**
    * If true, then only contacts who are connected to the relevant object are notified.
    */
    @ApiMember(Description="If true, then only contacts who are connected to the relevant object are notified.", ParameterType="query")
    open var ObjectContactConnectionRequired:Boolean? = null

    /**
    * Document Notification: If true, then the notification will include a link to download the document.
    */
    @ApiMember(Description="Document Notification: If true, then the notification will include a link to download the document.", ParameterType="query")
    open var AllowDirectAccess:Boolean? = null

    /**
    * If true, the notification is sent as soon as it can be processed
    */
    @ApiMember(Description="If true, the notification is sent as soon as it can be processed", ParameterType="query")
    open var SendImmediately:Boolean? = null

    /**
    * If true, the notification is flagged and sent out when subscription/batch emails are next sent.
    */
    @ApiMember(Description="If true, the notification is flagged and sent out when subscription/batch emails are next sent.", ParameterType="query")
    open var Batched:Boolean? = null

    /**
    * Document Notification: If true, the notification is sent when a document has a status of draft.
    */
    @ApiMember(Description="Document Notification: If true, the notification is sent when a document has a status of draft.", ParameterType="query")
    open var DraftStatus:Boolean? = null

    /**
    * Document Notification: If true, the notification is sent when a document has a status of final.
    */
    @ApiMember(Description="Document Notification: If true, the notification is sent when a document has a status of final.", ParameterType="query")
    open var FinalStatus:Boolean? = null

    /**
    * True if we want to include a report on an email notification. 
    */
    @ApiMember(Description="True if we want to include a report on an email notification. ", ParameterType="query")
    open var IncludeReport:Boolean? = null

    /**
    * True if this notification is based on a template.
    */
    @ApiMember(Description="True if this notification is based on a template.", ParameterType="query")
    open var IsTemplateNotification:Boolean? = null

    /**
    * When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.
    */
    @ApiMember(Description="When Inserting a new notification we can have 1+ roles. They should be passed to this field when inserting.", ParameterType="query")
    open var Roles:ArrayList<UUID>? = null

    /**
    * Communication Type Id.
    */
    @ApiMember(Description="Communication Type Id.", ParameterType="query")
    open var CommunicationTypeId:UUID? = null

    /**
    * Communication Type.
    */
    @ApiMember(Description="Communication Type.", ParameterType="query")
    open var CommunicationType:String? = null

    /**
    * If communication type is email, this is the subject of the email to be sent.
    */
    @ApiMember(Description="If communication type is email, this is the subject of the email to be sent.", ParameterType="query")
    open var Subject:String? = null

    /**
    * This is the notification details to be sent.
    */
    @ApiMember(Description="This is the notification details to be sent.", ParameterType="query")
    open var Body:String? = null

    /**
    * If true, we will include the relevant project URL in the notification.
    */
    @ApiMember(Description="If true, we will include the relevant project URL in the notification.", ParameterType="query")
    open var IncludeURL:Boolean? = null

    /**
    * The notification Id of a notification setup in Workflow Notification Management to use for the notification.
    */
    @ApiMember(Description="The notification Id of a notification setup in Workflow Notification Management to use for the notification.", ParameterType="query")
    open var NotificationId:UUID? = null

    /**
    * The notification nameof a notification setup in Workflow Notification Management to use for the notification.
    */
    @ApiMember(Description="The notification nameof a notification setup in Workflow Notification Management to use for the notification.", ParameterType="query")
    open var NotificationName:String? = null

    /**
    * The suite id the notification is setup for
    */
    @ApiMember(Description="The suite id the notification is setup for", ParameterType="query")
    open var SuiteId:UUID? = null

    /**
    * The suite name the notification is setup for
    */
    @ApiMember(Description="The suite name the notification is setup for", ParameterType="query")
    open var SuiteName:String? = null
}

open class AutomationModel
{
    /**
    * The unique automation Id
    */
    @ApiMember(Description="The unique automation Id", ParameterType="query")
    open var AutomationId:UUID? = null

    /**
    * The automation type Id
    */
    @ApiMember(Description="The automation type Id", ParameterType="query")
    open var AutomationTypeId:UUID? = null

    /**
    * The automation type
    */
    @ApiMember(Description="The automation type", ParameterType="query")
    open var AutomationType:String? = null

    /**
    * The object this automation applies to
    */
    @ApiMember(Description="The object this automation applies to", ParameterType="query")
    open var ObjectId:UUID? = null

    /**
    * The object name this automation applies to
    */
    @ApiMember(Description="The object name this automation applies to", ParameterType="query")
    open var ObjectName:String? = null

    /**
    * The Id of the object type that this automation applies to. 
    */
    @ApiMember(Description="The Id of the object type that this automation applies to. ", ParameterType="query")
    open var RmsTableCtxIdObject:UUID? = null

    /**
    * The name of the object type that this automation applies to.
    */
    @ApiMember(Description="The name of the object type that this automation applies to.", ParameterType="query")
    open var RmsTableCtxName:String? = null

    /**
    * A guid list containing the selected system action Id's that trigger this automation.
    */
    @ApiMember(Description="A guid list containing the selected system action Id's that trigger this automation.", ParameterType="query")
    open var ActionList:ArrayList<UUID>? = null

    /**
    * A comma separated string of the selected system action names that trigger this automation.
    */
    @ApiMember(Description="A comma separated string of the selected system action names that trigger this automation.", ParameterType="query")
    open var Actions:String? = null

    /**
    * Name of the automation.
    */
    @ApiMember(Description="Name of the automation.", ParameterType="query")
    open var Name:String? = null

    /**
    * Description of the automation
    */
    @ApiMember(Description="Description of the automation", ParameterType="query")
    open var Description:String? = null

    /**
    * Owner Contact Id
    */
    @ApiMember(Description="Owner Contact Id", ParameterType="query")
    open var OwnerContactId:UUID? = null

    /**
    * Record Status of the automation.
    */
    @ApiMember(Description="Record Status of the automation.", ParameterType="query")
    open var RecordStatus:String? = null
}