/* Options:
Date: 2026-04-04 01:19: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: AddContactGroup.*
//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.*


/**
* Create new contact group
*/
@Route(Path="/contactgroups", Verbs="POST")
@Api(Description="Create new contact group")
open class AddContactGroup : IReturn<AddContactGroupResponse>
{
    /**
    * Contact group name to be created
    */
    @ApiMember(Description="Contact group name to be created", Name="CustomerName")
    open var CustomerName:String? = null

    open var NameTypeId:UUID? = null
    open var Contacts:ArrayList<ContactGroupConnectionModel>? = null
    open var RecordStatus:String? = null
    companion object { private val responseType = AddContactGroupResponse::class.java }
    override fun getResponseType(): Any? = AddContactGroup.responseType
}

@ApiResponse(Description="Create contact group")
open class AddContactGroupResponse
{
    open var ContactGroupId:UUID? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class UserProfileSummaryModel
{
    /**
    * User Profile Id
    */
    @ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")
    open var UserProfileId:UUID? = null

    /**
    * User linked to the profile
    */
    @ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")
    open var UserId:UUID? = null

    /**
    * Contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * User linked to the profile
    */
    @ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")
    open var UserName:String? = null

    /**
    * User Profile Name
    */
    @ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")
    open var ProfileName:String? = null

    /**
    * Full name of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
    open var ContactFullName:String? = null

    /**
    * Email Address of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
    open var EmailAddress:String? = null

    /**
    * Email signature of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")
    open var EmailSignature:String? = null

    /**
    * Mobile number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")
    open var MobileNumber:String? = null

    /**
    * Phone number of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")
    open var PhoneNumber:String? = null

    /**
    * Type of contact (person, organisation etc.) linked to the profile
    */
    @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
    open var ContactTypeId:UUID? = null

    /**
    * Type of contact (person, organisation etc.) linked to the profile
    */
    @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")
    open var ContactTypeName:String? = null

    /**
    * First name of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")
    open var FirstName:String? = null

    /**
    * Surname of the contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")
    open var Surname:String? = null

    /**
    * Title of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")
    open var Title:String? = null

    /**
    * Legal name of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    open var LegalName:String? = null

    /**
    * Trading name of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    open var TradingName:String? = null

    /**
    * Australian Business Number
    */
    @ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")
    open var Abn:String? = null

    /**
    * Australian Company Number
    */
    @ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")
    open var Acn:String? = null

    /**
    * Australian Registered Body Number
    */
    @ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")
    open var Arbn:String? = null

    /**
    * Indicates if the Contact is registered for GST.
    */
    @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    open var GstRegistered:Boolean? = null

    /**
    * True if english is a secondary language for the contact.
    */
    @ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")
    open var ESL:Boolean? = null

    /**
    * Language that is the primary language for the contact.
    */
    @ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")
    open var Language:String? = null

    /**
    * True if an interpreter is required.
    */
    @ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")
    open var InterpreterRequired:Boolean? = null

    /**
    * Licensee specific notes about the contact.
    */
    @ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")
    open var LicenseeNotes:String? = null

    /**
    * Profile photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
    open var ProfilePhotoUrl:String? = null

    /**
    * Thumbnail photo of contact linked to the profile
    */
    @ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
    open var ProfilePhotoThumbnailUrl:String? = null

    /**
    * Profile photo id of contact linked to the profile
    */
    @ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")
    open var ProfileImageId:UUID? = null

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

    /**
    * Employment Industry
    */
    @ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
    open var EmploymentIndustry:String? = null

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

    /**
    * Areas of Work
    */
    @ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
    open var EmploymentGeographicArea:String? = null

    /**
    * The contacts timezone.
    */
    @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    open var Timezone:UUID? = null

    /**
    * Timezone Name
    */
    @ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
    open var TimezoneName:String? = null

    /**
    * The primary address of the contact
    */
    @ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
    open var PrimaryAddress:String? = null

    /**
    * Is this an active contact? Or an inactive contact (deleted account)?
    */
    @ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")
    open var IsActiveContact:Boolean? = null
}

open class ContactGroupConnectionModel : UserProfileSummaryModel()
{
    /**
    * Contact Group Id
    */
    @ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")
    open var ContactGroupId:UUID? = null

    /**
    * Connection id of the contact in the group
    */
    @ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")
    open var ContactGroupConnectionId:UUID? = null

    /**
    * The Id of the Role this contact is connected to the group with.
    */
    @ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")
    open var ConnectionRoleId:UUID? = null

    /**
    * Order of contacts within a group, the primary contact will have an index of 1.
    */
    @ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")
    open var Index:Int? = null

    /**
    * List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
    */
    @ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")
    open var ContactRoles:ArrayList<RoleModel>? = 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
}