/* Options:
Date: 2026-01-09 13:45:42
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://production-eros-platform-apisubscription.azurewebsites.net/api

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


/**
* Returns a list of contacts a licensee is linked to. Contacts are returned in batches.
*/
@Route(Path="/licensee/contacts", Verbs="GET")
@Api(Description="Returns a list of contacts a licensee is linked to. Contacts are returned in batches.")
open class GetLicenseeContactList : IReturn<GetLicenseeContactListResponse>
{
    /**
    * Number of contacts to retrieve per call.
    */
    @ApiMember(DataType="int", Description="Number of contacts to retrieve per call.", IsRequired=true, Name="BatchSize", ParameterType="body")
    open var BatchSize:Int? = null

    /**
    * Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.
    */
    @ApiMember(DataType="int", Description="Call number (1=1st, 2=2nd) this should progress upwards until all contacts have been retrieved.", IsRequired=true, Name="BatchNumber", ParameterType="body")
    open var BatchNumber:Int? = null

    /**
    * An optional role that a contact must have in order to be returned. 
    */
    @ApiMember(DataType="Guid", Description="An optional role that a contact must have in order to be returned. ", Name="ContactRole", ParameterType="body")
    open var ContactRole:UUID? = null
    companion object { private val responseType = GetLicenseeContactListResponse::class.java }
    override fun getResponseType(): Any? = GetLicenseeContactList.responseType
}

@ApiResponse(Description="List of Contacts")
open class GetLicenseeContactListResponse
{
    /**
    * List of contacts.
    */
    @ApiMember(DataType="List<ConnectedContactModel>", Description="List of contacts.", Name="Contacts", ParameterType="body")
    open var Contacts:ArrayList<ConnectedContactModel>? = null

    /**
    * Details of the api response. Success/Fail.
    */
    @ApiMember(DataType="ResponseStatus", Description="Details of the api response. Success/Fail.", Name="ResponseStatus", ParameterType="body")
    open var ResponseStatus:ResponseStatus? = null
}

open class ConnectedContactModel
{
    /**
    * Guid of the contact object within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="body")
    open var ContactId:UUID? = null

    /**
    * The salutation(preferred name) for the contact. Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="The salutation(preferred name) for the contact. Applies to a person contact type.", Name="Salutation", ParameterType="body")
    open var Salutation:String? = null

    /**
    * The title for the contact. Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="The title for the contact. Applies to a person contact type.", Name="Title", ParameterType="body")
    open var Title:String? = null

    /**
    * The first given name for the contact.  Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="The first given name for the contact.  Applies to a person contact type.", Name="FirstName", ParameterType="body")
    open var FirstName:String? = null

    /**
    * Any middle names for the contact.  Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="Any middle names for the contact.  Applies to a person contact type.", Name="MiddleName", ParameterType="body")
    open var MiddleName:String? = null

    /**
    * The surname for the contact.  Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="The surname for the contact.  Applies to a person contact type.", Name="Surname", ParameterType="body")
    open var Surname:String? = null

    /**
    * The full name for the contact.
    */
    @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body")
    open var FullName:String? = null

    /**
    * A legal name for the contact. Applies to an organisation contact type.
    */
    @ApiMember(DataType="string", Description="A legal name for the contact. Applies to an organisation contact type.", Name="LegalName", ParameterType="body")
    open var LegalName:String? = null

    /**
    * A trading name for the contact. Applies to an organisation contact type.
    */
    @ApiMember(DataType="string", Description="A trading name for the contact. Applies to an organisation contact type.", Name="TradingName", ParameterType="body")
    open var TradingName:String? = null

    /**
    * The birth date for the contact.  Applies to a person contact type.
    */
    @ApiMember(DataType="DateTime?", Description="The birth date for the contact.  Applies to a person contact type.", Name="BirthDate", ParameterType="body")
    open var BirthDate:Date? = null

    /**
    * Guid of the marital status within Eros.
    */
    @ApiMember(DataType="Guid?", Description="Guid of the marital status within Eros.", Name="MaritalStatusId", ParameterType="body")
    open var MaritalStatusId:UUID? = null

    /**
    * The contacts marital status if set.
    */
    @ApiMember(DataType="string", Description="The contacts marital status if set.", Name="MaritalStatusName", ParameterType="body")
    open var MaritalStatusName:String? = null

    /**
    * Guid of the gender within Eros.
    */
    @ApiMember(DataType="Guid?", Description="Guid of the gender within Eros.", Name="GenderId", ParameterType="body")
    open var GenderId:UUID? = null

    /**
    * The contacts gender if set.
    */
    @ApiMember(DataType="string", Description="The contacts gender if set.", Name="GenderName", ParameterType="body")
    open var GenderName:String? = null

    /**
    * Preferred language of the contact.
    */
    @ApiMember(DataType="string", Description="Preferred language of the contact.", Name="Language", ParameterType="body")
    open var Language:String? = null

    /**
    * If true, the contact requires an interpreter.
    */
    @ApiMember(DataType="bool", Description="If true, the contact requires an interpreter.", Name="InterpreterRequired", ParameterType="body")
    open var InterpreterRequired:Boolean? = null

    /**
    * Contact Type name of the contact.
    */
    @ApiMember(DataType="string", Description="Contact Type name of the contact.", Name="ContactTypeName", ParameterType="body")
    open var ContactTypeName:String? = null

    /**
    * Guid of the Contact Type List Item object within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", Name="ContactTypeId", ParameterType="body")
    open var ContactTypeId:UUID? = null

    /**
    * Description of the contact for their external profile.
    */
    @ApiMember(DataType="string", Description="Description of the contact for their external profile.", Name="Description", ParameterType="body")
    open var Description:String? = null

    /**
    * Contact 'Profession/Trade/Industry' details for their external profile.
    */
    @ApiMember(DataType="string", Description="Contact 'Profession/Trade/Industry' details for their external profile.", Name="EmploymentIndustry", ParameterType="body")
    open var EmploymentIndustry:String? = null

    /**
    * Contact 'Working/Subcontracting for' details for their external profile.
    */
    @ApiMember(DataType="string", Description="Contact 'Working/Subcontracting for' details for their external profile.", Name="EmploymentRole", ParameterType="body")
    open var EmploymentRole:String? = null

    /**
    * Contact 'Work Area/Suburbs' detail for their external profile.
    */
    @ApiMember(DataType="string", Description="Contact 'Work Area/Suburbs' detail for their external profile.", Name="EmploymentGeographicArea", ParameterType="body")
    open var EmploymentGeographicArea:String? = null

    /**
    * The A.B.N for the contact.
    */
    @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="body")
    open var Abn:String? = null

    /**
    * The A.C.N for the contact.
    */
    @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="body")
    open var Acn:String? = null

    /**
    * The A.R.B.N for the contact.
    */
    @ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="body")
    open var Arbn:String? = null

    /**
    * Timezone name that applies to the contact.
    */
    @ApiMember(DataType="string", Description="Timezone name that applies to the contact.", Name="TimezoneName", ParameterType="body")
    open var TimezoneName:String? = null

    /**
    * A list of the contact details for the contact.
    */
    @ApiMember(DataType="List<ConnectedContactDetailModel>", Description="A list of the contact details for the contact.", Name="ContactDetails", ParameterType="body")
    open var ContactDetails:ArrayList<ConnectedContactDetailModel>? = null

    /**
    * A list of the contact addresses for the contact
    */
    @ApiMember(DataType="List<ConnectedContactAddressModel>", Description="A list of the contact addresses for the contact", Name="ContactAddresses", ParameterType="body")
    open var ContactAddresses:ArrayList<ConnectedContactAddressModel>? = null

    /**
    * True if this contact has at least 1 active connection to the licensee. Without an active connection only public profile information for the contact is returned.
    */
    @ApiMember(DataType="bool", Description="True if this contact has at least 1 active connection to the licensee. Without an active connection only public profile information for the contact is returned.", Name="IsContactConnected", ParameterType="body")
    open var IsContactConnected:Boolean? = null

    /**
    * A list of connections this contact has with the licensee. May be active or a pending request to connect.
    */
    @ApiMember(DataType="List<ConnectedContactConnectionsModel>", Description="A list of connections this contact has with the licensee. May be active or a pending request to connect.", Name="Connections", ParameterType="body")
    open var Connections:ArrayList<ConnectedContactConnectionsModel>? = null

    /**
    * A list of projects this contact is linked to as a customer.
    */
    @ApiMember(DataType="List<ContactLinkedCustomerProjectsModel>", Description="A list of projects this contact is linked to as a customer.", Name="Projects", ParameterType="body")
    open var Projects:ArrayList<ContactLinkedCustomerProjectsModel>? = null

    /**
    * A list of integration subscriptions used to link this contact to external records in other licensee owned systems.
    */
    @ApiMember(DataType="List<ConnectedContactSubscriptionsModel>", Description="A list of integration subscriptions used to link this contact to external records in other licensee owned systems.", Name="Subscriptions", ParameterType="body")
    open var Subscriptions:ArrayList<ConnectedContactSubscriptionsModel>? = null
}

open class ConnectedContactDetailModel
{
    /**
    * The type of contact detail this is (email/mobile/fax/website etc)
    */
    @ApiMember(DataType="string", Description="The type of contact detail this is (email/mobile/fax/website etc)", Name="Type", ParameterType="body")
    open var Type:String? = null

    /**
    * The contact detail. e.g (phone number or email address)
    */
    @ApiMember(DataType="string", Description="The contact detail. e.g (phone number or email address)", Name="ContactDetails", ParameterType="body")
    open var ContactDetails:String? = null
}

open class ConnectedContactAddressModel
{
    /**
    * A full address string of the address.
    */
    @ApiMember(DataType="string", Description="A full address string of the address.", Name="FullAddress", ParameterType="body")
    open var FullAddress:String? = null

    /**
    * If true, this is the contacts primary address.
    */
    @ApiMember(DataType="bool", Description="If true, this is the contacts primary address.", Name="IsPrimary", ParameterType="body")
    open var IsPrimary:Boolean? = null

    /**
    * If true, this is the contacts postal address.
    */
    @ApiMember(DataType="bool", Description="If true, this is the contacts postal address.", Name="IsPostal", ParameterType="body")
    open var IsPostal:Boolean? = null

    /**
    * If true, this is the contacts registered address.
    */
    @ApiMember(DataType="bool", Description="If true, this is the contacts registered address.", Name="IsRegistered", ParameterType="body")
    open var IsRegistered:Boolean? = null
}

open class ConnectedContactConnectionsModel
{
    /**
    * Guid of the role within Eros
    */
    @ApiMember(DataType="Guid", Description="Guid of the role within Eros", Name="RoleId", ParameterType="body")
    open var RoleId:UUID? = null

    /**
    * Name of the role this contact is connected to the licensee with.
    */
    @ApiMember(DataType="string", Description="Name of the role this contact is connected to the licensee with.", Name="Role", ParameterType="body")
    open var Role:String? = null

    /**
    * Guid of the role connections status within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the role connections status within Eros.", Name="StatusId", ParameterType="body")
    open var StatusId:UUID? = null

    /**
    * Connection status of the role. It maybe active or pending.
    */
    @ApiMember(DataType="string", Description="Connection status of the role. It maybe active or pending.", Name="Status", ParameterType="body")
    open var Status:String? = null
}

open class ContactLinkedCustomerProjectsModel
{
    /**
    * Guid of the project within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the project within Eros.", Name="ProjectId", ParameterType="body")
    open var ProjectId:UUID? = null

    /**
    * Name of the project.
    */
    @ApiMember(DataType="string", Description="Name of the project.", Name="Name", ParameterType="body")
    open var Name:String? = null
}

open class ConnectedContactSubscriptionsModel
{
    /**
    * Guid of the datasource within Eros.
    */
    @ApiMember(DataType="Guid", Description="Guid of the datasource within Eros.", Name="DatasourceId", ParameterType="body")
    open var DatasourceId:UUID? = null

    /**
    * Name of the datasource that is the external system with a record of this contact.
    */
    @ApiMember(DataType="string", Description="Name of the datasource that is the external system with a record of this contact.", Name="Datasource", ParameterType="body")
    open var Datasource:String? = null

    /**
    * Foreign Key lookup of this contact in the external system the datasource represents.
    */
    @ApiMember(DataType="string", Description="Foreign Key lookup of this contact in the external system the datasource represents.", Name="AlternateKey", ParameterType="body")
    open var AlternateKey:String? = null
}