/* Options: Date: 2025-09-14 07:27:18 SwiftVersion: 6.0 Version: 8.52 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://production-eros-platform-apisubscription.azurewebsites.net/api //BaseClass: //AddModelExtensions: True //AddServiceStackTypes: True //MakePropertiesOptional: True IncludeTypes: GetContacts.* //ExcludeTypes: //ExcludeGenericBaseTypes: False //AddResponseStatus: False //AddImplicitVersion: //AddDescriptionAsComments: True //InitializeCollections: False //TreatTypesAsStrings: //DefaultImports: Foundation,ServiceStack */ import Foundation import ServiceStack /** * 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") public class GetContacts : IReturn, Codable { public typealias Return = 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="query") public var suiteDataSourceInstanceId:String? /** * 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", 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="query") public var contactRoles:[String] = [] /** * 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", 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="query") public var contactTypes:[String]? /** * 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="query") public var includeStaff:Bool? /** * 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="query") public var customContentViewId:String? /** * 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="query") public var modifiedSince:Date? required public init(){} } public class GetContactsModel : Codable { /** * List of Contacts with details. */ // @ApiMember(DataType="string", Description="List of Contacts with details.", IsRequired=true, Name="Contacts", ParameterType="query") public var contacts:IList? /** * List of contact-staff details. */ // @ApiMember(DataType="string", Description="List of contact-staff details.", IsRequired=true, Name="ContactStaff", ParameterType="query") public var contactStaff:IList? required public init(){} } public class SubscriptionContactModel : Codable { /** * Guid of the contact object within Eros. */ // @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query") public var contactId:String? /** * Guid of the Contact Type List Item object within Eros. */ // @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", IsRequired=true, Name="ContactType", ParameterType="query") public var contactType:String? /** * Guid of the Marital Status List Item object within Eros. */ // @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within Eros.", Name="MaritalStatus", ParameterType="query") public var maritalStatus:String? /** * Guid of the Gender List Item object within Eros. */ // @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within Eros.", Name="Gender", ParameterType="query") public var gender:String? /** * 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="query") public var firstName:String? /** * 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="query") public var middleName:String? /** * 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="query") public var surname:String? /** * The full name for the contact. */ // @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="query") public var fullName:String? /** * A short name for the contact. */ // @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="query") public var shortName:String? /** * 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="query") public var birthDate:Date? /** * 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="query") public var title:String? /** * A salutation for the contact. */ // @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="query") public var salutation:String? /** * The A.B.N for the contact. */ // @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="query") public var abn:String? /** * The A.C.N for the contact. */ // @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="query") public var acn:String? /** * The A.R.B.N for the contact. */ // @ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="query") public var arbn:String? /** * A trading name for the contact. */ // @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="query") public var tradingName:String? /** * A legal name for the contact. */ // @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="query") public var legalName:String? /** * Any notes/description for the contact. */ // @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="query") public var notes:String? /** * Contact Employment Industry. */ // @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="query") public var employmentIndustry:String? /** * Contact Employment Role. */ // @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="query") public var employmentRole:String? /** * Contact Employment Geographic Area. */ // @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="query") public var employmentGeographicArea:String? /** * The Contacts Drivers Licence Number */ // @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="query") public var driversLicence:String? /** * Indicates if the Contact is registered for GST */ // @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="query") public var gstRegistered:Bool? /** * The status of the contact in EROS */ // @ApiMember(DataType="string", Description="The status of the contact in EROS", Name="RecordStatus", ParameterType="query") public var recordStatus:String? /** * A list of roles this contact has. */ // @ApiMember(DataType="List", Description="A list of roles this contact has.", IsRequired=true, Name="ContactRoles", ParameterType="query") public var contactRoles:[ContactRole] = [] /** * A list of the contact details for the contact. */ // @ApiMember(DataType="List", Description="A list of the contact details for the contact.", IsRequired=true, Name="ContactDetails", ParameterType="query") public var contactDetails:[ContactDetailModel] = [] /** * Custom Content XML for the contact. */ // @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="query") public var customContentXML:String? public var blobImageURLPrimary:String? public var blobImageURLPrimaryThumbnail:String? /** * The primary mobile for the contact. */ // @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="query") public var primaryMobile:String? /** * The primary email for the contact. */ // @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="query") public var primaryEmail:String? required public init(){} } public class ContactsStaff : Codable { public var contactId:String? public var contactStaffId:String? required public init(){} } public class ContactRole : Codable { /** * Guid of the Role List Item object within Eros. */ // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query") public var roleId:String? /** * 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="query") public var alternateKey:String? required public init(){} } public class ContactDetailModel : Codable { public var contactMethodId:String? public var contactMethodName:String? public var contactAddress:ContactAddressModel? public var contactPhone:PhoneModel? public var countryId:String? public var contactDetails:String? public var notes:String? public var contactDetailsCode:String? public var orderContactMethod:Int? public var isPrimaryContactMethod:Bool? public var isAddress:Bool? required public init(){} } public class AddressModel : Codable { /** * 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="query") public var distanceAway:Double? /** * 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.", IsRequired=true, Name="Latitude", ParameterType="query") public var latitude:Double? /** * 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.", IsRequired=true, Name="Longitude", ParameterType="query") public var longitude:Double? /** * 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="query") public var addressFormatId:String? /** * 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="query") public var suburbId:String? /** * The suburb name. */ // @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query") public var suburbName:String? /** * 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="query") public var stateShortName:String? /** * The suburb postcode. */ // @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query") public var postCode:String? /** * 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="query") public var countryId:String? /** * 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="query") public var countryName:String? /** * A 2 digit ISO Country Code representing the country. */ // @ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query") public var isoCountryCode:String? /** * The address Lot number. */ // @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query") public var lotNumber:String? /** * The address Sub Unit number. */ // @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query") public var subUnit:String? /** * The address building number. */ // @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query") public var buildingNumber:String? /** * The address street number. */ // @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query") public var streetNumber:String? /** * The address street name including street type. */ // @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query") public var streetName:String? /** * A formatted address Line 1. */ // @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query") public var addressLineOne:String? /** * A formatted address Line 2. */ // @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query") public var addressLineTwo:String? /** * The full address string. */ // @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query") public var addressFull:String? /** * True if the address is a physical location. */ // @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query") public var isPhysical:Bool? /** * Notes about the address. */ // @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query") public var notes:String? /** * 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="query") public var autoMapCoordinates:Bool? /** * Location Coordinates for the address. */ // @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query") public var locationCoordinates:LocationCoordinatesModel? required public init(){} } public class ContactAddressModel : Codable { public var address:AddressModel? public var isPostal:Bool? public var isPrimaryLocation:Bool? public var isRegisteredLocation:Bool? public var suburbName:String? public var stateName:String? public var countryName:String? required public init(){} } public class PhoneModel : Codable { public var countryCode:String? public var areaCode:String? public var localNumber:String? required public init(){} } public class LocationCoordinatesModel : Codable { /** * 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.", IsRequired=true, Name="Latitude", ParameterType="query") public var latitude:Double? /** * 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.", IsRequired=true, Name="Longitude", ParameterType="query") public var longitude:Double? /** * The altitude of an address - the altitude above sea level. */ // @ApiMember(DataType="Double?", Description="The altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query") public var altitude:Double? /** * Accuracy of the latitude and longitude. */ // @ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query") public var accuracy:Double? /** * Accurancy of the Altitude. */ // @ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query") public var altitudeAccuracy:Double? /** * Direction you are heading. */ // @ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query") public var heading:Double? /** * Speed you are going. */ // @ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query") public var speed:Double? /** * Speed your altitude is ascending/descending at. */ // @ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query") public var verticalSpeed:Double? required public init(){} }