/* Options: Date: 2025-12-29 18:01:39 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="body") 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="body") 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="body") 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="body") 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="body") 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="body") 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.", Name="Contacts", ParameterType="body") public var contacts:IList? /** * List of contact-staff details. */ // @ApiMember(DataType="string", Description="List of contact-staff details.", Name="ContactStaff", ParameterType="body") public var contactStaff:IList? required public init(){} } public class SubscriptionContactModel : Codable { /** * Guid of the contact object within PSTPF. */ // @ApiMember(DataType="Guid", Description="Guid of the contact object within PSTPF.", Name="ContactId", ParameterType="body") public var contactId:String? /** * 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") public var contactType:String? /** * 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") public var maritalStatus:String? /** * 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") 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="body") 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="body") 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="body") public var surname:String? /** * The full name for the contact. */ // @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body") public var fullName:String? /** * A short name for the contact. */ // @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body") 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="body") 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="body") public var title:String? /** * A salutation for the contact. */ // @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body") 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="body") 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="body") 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="body") public var arbn:String? /** * A trading name for the contact. */ // @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="body") public var tradingName:String? /** * A legal name for the contact. */ // @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="body") public var legalName:String? /** * Any notes/description for the contact. */ // @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body") public var notes:String? /** * Contact Employment Industry. */ // @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="body") public var employmentIndustry:String? /** * Contact Employment Role. */ // @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="body") public var employmentRole:String? /** * Contact Employment Geographic Area. */ // @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body") public var employmentGeographicArea:String? /** * The Contacts Drivers Licence Number */ // @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body") 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="body") public var gstRegistered:Bool? /** * The status of the contact in PSTPF */ // @ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body") public var recordStatus:String? /** * A list of roles this contact has. */ // @ApiMember(DataType="List", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body") 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.", Name="ContactDetails", ParameterType="body") public var contactDetails:[ContactDetailModel]? /** * Custom Content XML for the contact. */ // @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body") public var customContentXML:String? /** * URL to the Primary Image. */ // @ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body") public var blobImageURLPrimary:String? /** * URL to the Primary Image thumbnail. */ // @ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body") public var blobImageURLPrimaryThumbnail:String? /** * The primary mobile for the contact. */ // @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="body") public var primaryMobile:String? /** * The primary email for the contact. */ // @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body") 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 PSTPF. */ // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within PSTPF.", Name="RoleId", ParameterType="body") 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="body") public var alternateKey:String? required public init(){} } public class ContactDetailModel : Codable { /** * Id of the Contact Method */ // @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body") public var contactMethodId:String? /** * Contact Method Name */ // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body") public var contactMethodName:String? /** * 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") public var contactAddress:ContactAddressModel? /** * 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") public var contactPhone:PhoneModel? /** * Id of the country */ // @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body") public var countryId:String? /** * A summary string representing the contact details */ // @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body") public var contactDetails:String? /** * Notes about the contact details */ // @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body") public var notes:String? /** * 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") public var contactDetailsCode:String? /** * Order number of the contact method */ // @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body") public var orderContactMethod:Int? /** * True if this is the primary contact method */ // @ApiMember(DataType="bool", Description="True if this is the primary contact method", Name="IsPrimaryContactMethod", ParameterType="body") public var isPrimaryContactMethod:Bool? /** * True if this contact method is an address */ // @ApiMember(DataType="bool", Description="True if this contact method is an address", Name="IsAddress", ParameterType="body") 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="body") 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.", Name="Latitude", ParameterType="body") 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.", Name="Longitude", ParameterType="body") 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="body") 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="body") public var suburbId:String? /** * The suburb name. */ // @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body") 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="body") public var stateShortName:String? /** * The suburb postcode. */ // @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body") 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="body") 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="body") public var countryName:String? /** * ISO Country Code. */ // @ApiMember(Description="ISO Country Code.", ParameterType="query") public var isoCountryCode:String? /** * The address Lot number. */ // @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body") public var lotNumber:String? /** * The address Sub Unit number. */ // @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body") public var subUnit:String? /** * The address building number. */ // @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body") public var buildingNumber:String? /** * The address street number. */ // @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body") 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="body") public var streetName:String? /** * A formatted address Line 1. */ // @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body") public var addressLineOne:String? /** * A formatted address Line 2. */ // @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body") public var addressLineTwo:String? /** * The full address string. */ // @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body") 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="body") public var isPhysical:Bool? /** * Notes about the address. */ // @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes") 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="body") public var autoMapCoordinates:Bool? /** * Location Coordinates for the address. */ // @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body") public var locationCoordinates:LocationCoordinatesModel? required public init(){} } public class ContactAddressModel : Codable { /** * Address Details */ // @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body") public var address:AddressModel? /** * True if this is a postal address. */ // @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body") public var isPostal:Bool? /** * True if this is the primary address. */ // @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body") public var isPrimaryLocation:Bool? /** * 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") public var isRegisteredLocation:Bool? /** * Suburb Name */ // @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body") public var suburbName:String? /** * State Name */ // @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body") public var stateName:String? /** * Country Name */ // @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body") public var countryName:String? required public init(){} } public class PhoneModel : Codable { /** * Country Code */ // @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body") public var countryCode:String? /** * Area Code */ // @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body") public var areaCode:String? /** * Local Number */ // @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body") 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(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", 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(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", ParameterType="query") public var longitude:Double? /** * The altitude of an address - the altitude above sea level." */ // @ApiMember(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query") public var altitude:Double? /** * Accuracy of the latitude and longitude. */ // @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query") public var accuracy:Double? /** * Accurancy of the Altitude. */ // @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query") public var altitudeAccuracy:Double? /** * Direction you are heading. */ // @ApiMember(Description="Direction you are heading.", ParameterType="query") public var heading:Double? /** * Speed you are going. */ // @ApiMember(Description="Speed you are going.", ParameterType="query") public var speed:Double? /** * Speed your altitude is ascending/descending at. */ // @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query") public var verticalSpeed:Double? required public init(){} }