/* Options:
Date: 2026-04-04 06:50:21
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: GetContactRolesForLicensee.*
//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 contact roles (custom and/or standard) for the specified licensee
*/
@Route(Path="/contactroles/{LicenseeId}")
@Api(Description="Get contact roles (custom and/or standard) for the specified licensee")
open class GetContactRolesForLicensee : IReturn<GetContactRolesForLicenseeResponse>
{
    /**
    * Get contact roles (custom and/or standard) for the specified licensee
    */
    @ApiMember(DataType="Guid", Description="Get contact roles (custom and/or standard) for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
    open var LicenseeId:UUID? = null

    /**
    * Contact Types
    */
    @ApiMember(DataType="List<Guid>", Description="Contact Types", Name="ContactTypes", ParameterType="query")
    open var ContactTypes:ArrayList<UUID>? = null

    /**
    * Custom/Standard filter
    */
    @ApiMember(DataType="List<Guid>", Description="Custom/Standard filter", Name="OwnerFilterIds", ParameterType="query")
    open var OwnerFilterIds:ArrayList<UUID>? = null

    /**
    * Active/Archived filter
    */
    @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
    open var RecordStatus:String? = null

    /**
    * Text filter
    */
    @ApiMember(DataType="string", Description="Text filter", Name="SearchText", ParameterType="query")
    open var SearchText:String? = null
    companion object { private val responseType = GetContactRolesForLicenseeResponse::class.java }
    override fun getResponseType(): Any? = GetContactRolesForLicensee.responseType
}

@ApiResponse(Description="List of contact roles (custom and/or standard) for the specified licensee")
open class GetContactRolesForLicenseeResponse
{
    open var Roles:ArrayList<RoleModel>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class RoleModel
{
    /**
    * Role Id
    */
    @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
    open var RoleId:UUID? = null

    /**
    * Role Name
    */
    @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    open var RoleName:String? = null

    /**
    * Is the role a licensee role?
    */
    @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
    open var IsLicenseeRole:Boolean? = null

    /**
    * Is manage contacts role?
    */
    @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
    open var IsManageContacts:Boolean? = null

    /**
    * Is the role a Platform role?
    */
    @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
    open var IsPlatformRole:Boolean? = null

    /**
    * Is the role a services role?
    */
    @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
    open var IsServiceRole:Boolean? = null

    /**
    * Is the role a customer role?
    */
    @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
    open var IsCustomerRole:Boolean? = null

    /**
    * Is the role a functional role?
    */
    @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
    open var IsFunctionalRole:Boolean? = null

    /**
    * Is the role an auto-accept role?
    */
    @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
    open var IsRequestAutoAccepted:Boolean? = null

    /**
    * Suite that the role belongs to
    */
    @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
    open var SuiteId:UUID? = null

    /**
    * Suite that the role belongs to
    */
    @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
    open var SuiteName:String? = null

    /**
    * 'A' (Active) or 'I' (Inactive)
    */
    @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
    open var RecordStatus:String? = null

    /**
    * Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
    */
    @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
    open var ObjectConnectionId:UUID? = null
}