/* Options:
Date: 2025-12-29 18:07:06
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: GetContacts.*
//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 with specified roles.  There are options to include custom and also to include each contacts connected contacts
*/
@Api(Description="Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts")
open class GetContacts : IReturn<GetContactsModel>
{
    /**
    * Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.
    */
    @ApiMember(DataType="Guid", Description="Guid representing the external system datasource requesting the contact information. This is required to return any existing object subscription details for each contact.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="body")
    open var SuiteDataSourceInstanceId:UUID? = null

    /**
    * A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)
    */
    @ApiMember(DataType="List<Guid>", Description="A list of 1 or more roles that a contact must have in order to be returned. (Roles are treated as OR not AND, ie a contact may have one or the other to be returned, but not necessarily both)", IsRequired=true, Name="ContactRoles", ParameterType="body")
    open var ContactRoles:ArrayList<UUID> = ArrayList<UUID>()

    /**
    * A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)
    */
    @ApiMember(DataType="List<Guid>", Description="A list of contact types that we want returned. If no contact types are specified all 4 major contact types are eligible to be returned. (organisation/person - real/virtual)", Name="ContactTypes", ParameterType="body")
    open var ContactTypes:ArrayList<UUID>? = null

    /**
    * Set to true if you want to include the any linked staff for each contact.
    */
    @ApiMember(DataType="bool", Description="Set to true if you want to include the any linked staff for each contact.", IsRequired=true, Name="IncludeStaff", ParameterType="body")
    open var IncludeStaff:Boolean? = null

    /**
    * To include custom content then you need to specify the view Id of the content to include.
    */
    @ApiMember(DataType="Guid", Description="To include custom content then you need to specify the view Id of the content to include.", Name="CustomContentViewId", ParameterType="body")
    open var CustomContentViewId:UUID? = null

    /**
    * Set the date to return only contacts that have been modified since a particular date.
    */
    @ApiMember(DataType="DateTime", Description="Set the date to return only contacts that have been modified since a particular date.", Name="ModifiedSince", ParameterType="body")
    open var ModifiedSince:Date? = null
    companion object { private val responseType = GetContactsModel::class.java }
    override fun getResponseType(): Any? = GetContacts.responseType
}

open class GetContactsModel
{
    /**
    * List of Contacts with details.
    */
    @ApiMember(DataType="string", Description="List of Contacts with details.", Name="Contacts", ParameterType="body")
    open var Contacts:IList<SubscriptionContactModel>? = null

    /**
    * List of contact-staff details.
    */
    @ApiMember(DataType="string", Description="List of contact-staff details.", Name="ContactStaff", ParameterType="body")
    open var ContactStaff:IList<ContactsStaff>? = null
}

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

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

    /**
    * Guid of the Marital Status List Item object within PSTPF.
    */
    @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within PSTPF.", Name="MaritalStatus", ParameterType="body")
    open var MaritalStatus:UUID? = null

    /**
    * Guid of the Gender List Item object within PSTPF.
    */
    @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within PSTPF.", Name="Gender", ParameterType="body")
    open var Gender:UUID? = 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

    /**
    * The middle name(s) for the contact.  Applies to a person contact type.
    */
    @ApiMember(DataType="string", Description="The middle name(s) 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 short name for the contact.
    */
    @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body")
    open var ShortName: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

    /**
    * 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

    /**
    * A salutation for the contact.
    */
    @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body")
    open var Salutation: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

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

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

    /**
    * Any notes/description for the contact.
    */
    @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body")
    open var Notes:String? = null

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

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

    /**
    * Contact Employment Geographic Area.
    */
    @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body")
    open var EmploymentGeographicArea:String? = null

    /**
    * The Contacts Drivers Licence Number
    */
    @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body")
    open var DriversLicence: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="body")
    open var GstRegistered:Boolean? = null

    /**
    * The status of the contact in PSTPF
    */
    @ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body")
    open var RecordStatus:String? = null

    /**
    * A list of roles this contact has.
    */
    @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body")
    open var ContactRoles:ArrayList<ContactRole>? = null

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

    /**
    * Custom Content XML for the contact.
    */
    @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body")
    open var CustomContentXML:String? = null

    /**
    * URL to the Primary Image.
    */
    @ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body")
    open var BlobImageURLPrimary:String? = null

    /**
    * URL to the Primary Image thumbnail.
    */
    @ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body")
    open var BlobImageURLPrimaryThumbnail:String? = null

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

    /**
    * The primary email for the contact.
    */
    @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body")
    open var PrimaryEmail:String? = null
}

open class ContactsStaff
{
    open var ContactId:UUID? = null
    open var ContactStaffId:UUID? = null
}

open class ContactRole
{
    /**
    * Guid of the Role List Item object within PSTPF.
    */
    @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within PSTPF.", Name="RoleId", ParameterType="body")
    open var RoleId:UUID? = null

    /**
    * The unique key that represents the role type on the external system.
    */
    @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="body")
    open var AlternateKey:String? = null
}

open class ContactDetailModel
{
    /**
    * Id of the Contact Method
    */
    @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    open var ContactMethodId:UUID? = null

    /**
    * Contact Method Name
    */
    @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    open var ContactMethodName:String? = null

    /**
    * If the contact method is an address, this will contain the address details.
    */
    @ApiMember(DataType="ContactAddressModel", Description="If the contact method is an address, this will contain the address details.", Name="ContactAddress", ParameterType="body")
    open var ContactAddress:ContactAddressModel? = null

    /**
    * If the contact method is a phone, this will contain the phone details
    */
    @ApiMember(DataType="PhoneModel", Description="If the contact method is a phone, this will contain the phone details", Name="ContactPhone", ParameterType="body")
    open var ContactPhone:PhoneModel? = null

    /**
    * Id of the country
    */
    @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    open var CountryId:UUID? = null

    /**
    * A summary string representing the contact details
    */
    @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    open var ContactDetails:String? = null

    /**
    * Notes about the contact details
    */
    @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    open var Notes:String? = null

    /**
    * Area Code if contact details are a phone number
    */
    @ApiMember(DataType="string", Description="Area Code if contact details are a phone number", Name="ContactDetailsCode", ParameterType="body")
    open var ContactDetailsCode:String? = null

    /**
    * Order number of the contact method
    */
    @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    open var OrderContactMethod:Int? = null

    /**
    * True if this is the primary contact method
    */
    @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body")
    open var IsPrimaryContactMethod:Boolean? = null

    /**
    * True if this contact method is an address
    */
    @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body")
    open var IsAddress:Boolean? = null
}

open class AddressModel
{
    /**
    * The distance between this project and another specified set of gps coordinates.
    */
    @ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="body")
    open var DistanceAway:Double? = null

    /**
    * The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
    */
    @ApiMember(DataType="Double?", Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", Name="Latitude", ParameterType="body")
    open var Latitude:Double? = null

    /**
    * The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
    */
    @ApiMember(DataType="Double?", Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", Name="Longitude", ParameterType="body")
    open var Longitude:Double? = null

    /**
    * Address Format Id Guid - this will be determined by the service.
    */
    @ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="body")
    open var AddressFormatId:UUID? = null

    /**
    * Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
    */
    @ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="body")
    open var SuburbId:UUID? = null

    /**
    * The suburb name.
    */
    @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
    open var SuburbName:String? = null

    /**
    * The shortened State Name e.g Vic for Victoria.
    */
    @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")
    open var StateShortName:String? = null

    /**
    * The suburb postcode.
    */
    @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
    open var PostCode:String? = null

    /**
    * Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
    */
    @ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="body")
    open var CountryId:UUID? = null

    /**
    * the name of the country the address is within.
    */
    @ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="body")
    open var CountryName:String? = null

    /**
    * ISO Country Code.
    */
    @ApiMember(Description="ISO Country Code.", ParameterType="query")
    open var ISOCountryCode:String? = null

    /**
    * The address Lot number.
    */
    @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
    open var LotNumber:String? = null

    /**
    * The address Sub Unit number.
    */
    @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
    open var SubUnit:String? = null

    /**
    * The address building number.
    */
    @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
    open var BuildingNumber:String? = null

    /**
    * The address street number.
    */
    @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
    open var StreetNumber:String? = null

    /**
    * The address street name including street type.
    */
    @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
    open var StreetName:String? = null

    /**
    * A formatted address Line 1.
    */
    @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
    open var AddressLineOne:String? = null

    /**
    * A formatted address Line 2.
    */
    @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
    open var AddressLineTwo:String? = null

    /**
    * The full address string.
    */
    @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
    open var AddressFull:String? = null

    /**
    * True if the address is a physical location.
    */
    @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="body")
    open var IsPhysical:Boolean? = null

    /**
    * Notes about the address.
    */
    @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
    open var Notes:String? = null

    /**
    * If true, the address is eligible for having its coordinates calculated/updated.
    */
    @ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="body")
    open var AutoMapCoordinates:Boolean? = null

    /**
    * Location Coordinates for the address.
    */
    @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
    open var LocationCoordinates:LocationCoordinatesModel? = null
}

open class ContactAddressModel
{
    /**
    * Address Details
    */
    @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
    open var Address:AddressModel? = null

    /**
    * True if this is a postal address.
    */
    @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
    open var IsPostal:Boolean? = null

    /**
    * True if this is the primary address.
    */
    @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
    open var IsPrimaryLocation:Boolean? = null

    /**
    * True if this address is the registered tax address.
    */
    @ApiMember(DataType="bool", Description="True if this address is the registered tax address.", Name="IsRegisteredLocation", ParameterType="body")
    open var IsRegisteredLocation:Boolean? = null

    /**
    * Suburb Name
    */
    @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
    open var SuburbName:String? = null

    /**
    * State Name
    */
    @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
    open var StateName:String? = null

    /**
    * Country Name
    */
    @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
    open var CountryName:String? = null
}

open class PhoneModel
{
    /**
    * Country Code
    */
    @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
    open var CountryCode:String? = null

    /**
    * Area Code
    */
    @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
    open var AreaCode:String? = null

    /**
    * Local Number
    */
    @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
    open var LocalNumber:String? = null
}

open class LocationCoordinatesModel
{
    /**
    * The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.
    */
    @ApiMember(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", ParameterType="query")
    open var Latitude:Double? = null

    /**
    * The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
    */
    @ApiMember(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query")
    open var Longitude:Double? = null

    /**
    * The altitude of an address - the altitude above sea level."
    */
    @ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
    open var Altitude:Double? = null

    /**
    * Accuracy of the latitude and longitude.
    */
    @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
    open var Accuracy:Double? = null

    /**
    * Accurancy of the Altitude.
    */
    @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
    open var AltitudeAccuracy:Double? = null

    /**
    * Direction you are heading.
    */
    @ApiMember(Description="Direction you are heading.", ParameterType="query")
    open var Heading:Double? = null

    /**
    * Speed you are going.
    */
    @ApiMember(Description="Speed you are going.", ParameterType="query")
    open var Speed:Double? = null

    /**
    * Speed your altitude is ascending/descending at.
    */
    @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
    open var VerticalSpeed:Double? = null
}