/* Options:
Date: 2026-04-04 01:21:43
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: GetPermissionMatrix.*
//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 a value for the current permission and object. Including the relevant data that affects the permission value outcome.
*/
@Route(Path="/permissions/{PermissionId}/matrix/")
@Api(Description="Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.")
open class GetPermissionMatrix : IReturn<GetPermissionMatrixResponse>
{
    /**
    * Permission Id to retrieve matrix for.
    */
    @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
    open var PermissionId:UUID? = null

    /**
    * Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.
    */
    @ApiMember(DataType="Guid", Description="Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.", IsRequired=true, Name="ObjectId")
    open var ObjectId:UUID? = null
    companion object { private val responseType = GetPermissionMatrixResponse::class.java }
    override fun getResponseType(): Any? = GetPermissionMatrix.responseType
}

@ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
open class GetPermissionMatrixResponse
{
    open var PermissionLevelValue:Boolean? = null
    open var PermissionsMatrix:ArrayList<PermissionLevelModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class PermissionLevelModel
{
    open var PermissionValueId:UUID? = null
    open var ObjectId:UUID? = null
    open var ObjectName:String? = null
    open var ObjectGroup:String? = null
    open var ContactsAffected:Int? = null
    open var PermissionValue:Boolean? = null
}