/* Options:
Date: 2025-12-29 18:07:37
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://production-eros-platform-apisubscription.azurewebsites.net/api

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetContacts.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export class ContactRole
{
    /** @description 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 RoleId: string;

    /** @description 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 AlternateKey: string;

    public constructor(init?: Partial<ContactRole>) { (Object as any).assign(this, init); }
}

export class LocationCoordinatesModel
{
    /** @description 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 Latitude: number;

    /** @description 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 Longitude: number;

    /** @description 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 Altitude?: number;

    /** @description Accuracy of the latitude and longitude. */
    // @ApiMember(Description="Accuracy of the latitude and longitude.", ParameterType="query")
    public Accuracy?: number;

    /** @description Accurancy of the Altitude. */
    // @ApiMember(Description="Accurancy of the Altitude.", ParameterType="query")
    public AltitudeAccuracy?: number;

    /** @description Direction you are heading. */
    // @ApiMember(Description="Direction you are heading.", ParameterType="query")
    public Heading?: number;

    /** @description Speed you are going. */
    // @ApiMember(Description="Speed you are going.", ParameterType="query")
    public Speed?: number;

    /** @description Speed your altitude is ascending/descending at. */
    // @ApiMember(Description="Speed your altitude is ascending/descending at.", ParameterType="query")
    public VerticalSpeed?: number;

    public constructor(init?: Partial<LocationCoordinatesModel>) { (Object as any).assign(this, init); }
}

export class AddressModel
{
    /** @description 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 DistanceAway: number;

    /** @description 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 Latitude: number;

    /** @description 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 Longitude: number;

    /** @description 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 AddressFormatId: string;

    /** @description 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 SuburbId: string;

    /** @description The suburb name. */
    // @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="body")
    public SuburbName: string;

    /** @description 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 StateShortName: string;

    /** @description The suburb postcode. */
    // @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="body")
    public PostCode: string;

    /** @description 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 CountryId: string;

    /** @description 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 CountryName: string;

    /** @description ISO Country Code. */
    // @ApiMember(Description="ISO Country Code.", ParameterType="query")
    public ISOCountryCode: string;

    /** @description The address Lot number. */
    // @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="body")
    public LotNumber: string;

    /** @description The address Sub Unit number. */
    // @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="body")
    public SubUnit: string;

    /** @description The address building number. */
    // @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="body")
    public BuildingNumber: string;

    /** @description The address street number. */
    // @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="body")
    public StreetNumber: string;

    /** @description The address street name including street type. */
    // @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="body")
    public StreetName: string;

    /** @description A formatted address Line 1. */
    // @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="body")
    public AddressLineOne: string;

    /** @description A formatted address Line 2. */
    // @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="body")
    public AddressLineTwo: string;

    /** @description The full address string. */
    // @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="body")
    public AddressFull: string;

    /** @description 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 IsPhysical?: boolean;

    /** @description Notes about the address. */
    // @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
    public Notes: string;

    /** @description 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 AutoMapCoordinates?: boolean;

    /** @description Location Coordinates for the address. */
    // @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="body")
    public LocationCoordinates: LocationCoordinatesModel;

    public constructor(init?: Partial<AddressModel>) { (Object as any).assign(this, init); }
}

export class ContactAddressModel
{
    /** @description Address Details */
    // @ApiMember(DataType="AddressModel", Description="Address Details", Name="Address", ParameterType="body")
    public Address: AddressModel;

    /** @description True if this is a postal address. */
    // @ApiMember(DataType="bool", Description="True if this is a postal address.", Name="IsPostal", ParameterType="body")
    public IsPostal: boolean;

    /** @description True if this is the primary address. */
    // @ApiMember(DataType="bool", Description="True if this is the primary address.", Name="IsPrimaryLocation", ParameterType="body")
    public IsPrimaryLocation: boolean;

    /** @description 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 IsRegisteredLocation: boolean;

    /** @description Suburb Name */
    // @ApiMember(DataType="string", Description="Suburb Name", Name="SuburbName", ParameterType="body")
    public SuburbName: string;

    /** @description State Name */
    // @ApiMember(DataType="string", Description="State Name", Name="StateName", ParameterType="body")
    public StateName: string;

    /** @description Country Name */
    // @ApiMember(DataType="string", Description="Country Name", Name="CountryName", ParameterType="body")
    public CountryName: string;

    public constructor(init?: Partial<ContactAddressModel>) { (Object as any).assign(this, init); }
}

export class PhoneModel
{
    /** @description Country Code */
    // @ApiMember(DataType="string", Description="Country Code", Name="CountryCode", ParameterType="body")
    public CountryCode: string;

    /** @description Area Code */
    // @ApiMember(DataType="string", Description="Area Code", Name="AreaCode", ParameterType="body")
    public AreaCode: string;

    /** @description Local Number */
    // @ApiMember(DataType="string", Description="Local Number", Name="LocalNumber", ParameterType="body")
    public LocalNumber: string;

    public constructor(init?: Partial<PhoneModel>) { (Object as any).assign(this, init); }
}

export class ContactDetailModel
{
    /** @description Id of the Contact Method */
    // @ApiMember(DataType="Guid", Description="Id of the Contact Method", Name="ContactMethodId", ParameterType="body")
    public ContactMethodId: string;

    /** @description Contact Method Name */
    // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="body")
    public ContactMethodName: string;

    /** @description 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 ContactAddress: ContactAddressModel;

    /** @description 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 ContactPhone: PhoneModel;

    /** @description Id of the country */
    // @ApiMember(DataType="Guid?", Description="Id of the country", Name="CountryId", ParameterType="body")
    public CountryId?: string;

    /** @description A summary string representing the contact details */
    // @ApiMember(DataType="string", Description="A summary string representing the contact details", Name="ContactDetails", ParameterType="body")
    public ContactDetails: string;

    /** @description Notes about the contact details */
    // @ApiMember(DataType="string", Description="Notes about the contact details", Name="Notes", ParameterType="body")
    public Notes: string;

    /** @description 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 ContactDetailsCode: string;

    /** @description Order number of the contact method */
    // @ApiMember(DataType="int", Description="Order number of the contact method", Name="OrderContactMethod", ParameterType="body")
    public OrderContactMethod: number;

    /** @description 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 IsPrimaryContactMethod: boolean;

    /** @description 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 IsAddress: boolean;

    public constructor(init?: Partial<ContactDetailModel>) { (Object as any).assign(this, init); }
}

export class SubscriptionContactModel
{
    /** @description Guid of the contact object within PSTPF. */
    // @ApiMember(DataType="Guid", Description="Guid of the contact object within PSTPF.", Name="ContactId", ParameterType="body")
    public ContactId: string;

    /** @description 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 ContactType: string;

    /** @description 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 MaritalStatus?: string;

    /** @description 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 Gender?: string;

    /** @description 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 FirstName: string;

    /** @description 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 MiddleName: string;

    /** @description 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 Surname: string;

    /** @description The full name for the contact. */
    // @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="body")
    public FullName: string;

    /** @description A short name for the contact. */
    // @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="body")
    public ShortName: string;

    /** @description 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 BirthDate?: string;

    /** @description 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 Title: string;

    /** @description A salutation for the contact. */
    // @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="body")
    public Salutation: string;

    /** @description The A.B.N for the contact. */
    // @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="body")
    public Abn: string;

    /** @description The A.C.N for the contact. */
    // @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="body")
    public Acn: string;

    /** @description 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 Arbn: string;

    /** @description A trading name for the contact. */
    // @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="body")
    public TradingName: string;

    /** @description A legal name for the contact. */
    // @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="body")
    public LegalName: string;

    /** @description Any notes/description for the contact. */
    // @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="body")
    public Notes: string;

    /** @description Contact Employment Industry. */
    // @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="body")
    public EmploymentIndustry: string;

    /** @description Contact Employment Role. */
    // @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="body")
    public EmploymentRole: string;

    /** @description Contact Employment Geographic Area. */
    // @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="body")
    public EmploymentGeographicArea: string;

    /** @description The Contacts Drivers Licence Number */
    // @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="body")
    public DriversLicence: string;

    /** @description 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 GstRegistered: boolean;

    /** @description The status of the contact in PSTPF */
    // @ApiMember(DataType="string", Description="The status of the contact in PSTPF", Name="RecordStatus", ParameterType="body")
    public RecordStatus: string;

    /** @description A list of roles this contact has. */
    // @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", Name="ContactRoles", ParameterType="body")
    public ContactRoles: ContactRole[];

    /** @description 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")
    public ContactDetails: ContactDetailModel[];

    /** @description Custom Content XML for the contact. */
    // @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="body")
    public CustomContentXML: string;

    /** @description URL to the Primary Image. */
    // @ApiMember(DataType="string", Description="URL to the Primary Image.", Name="BlobImageURLPrimary", ParameterType="body")
    public BlobImageURLPrimary: string;

    /** @description URL to the Primary Image thumbnail. */
    // @ApiMember(DataType="string", Description="URL to the Primary Image thumbnail.", Name="BlobImageURLPrimaryThumbnail", ParameterType="body")
    public BlobImageURLPrimaryThumbnail: string;

    /** @description The primary mobile for the contact. */
    // @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="body")
    public PrimaryMobile: string;

    /** @description The primary email for the contact. */
    // @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="body")
    public PrimaryEmail: string;

    public constructor(init?: Partial<SubscriptionContactModel>) { (Object as any).assign(this, init); }
}

export class ContactsStaff
{
    public ContactId: string;
    public ContactStaffId: string;

    public constructor(init?: Partial<ContactsStaff>) { (Object as any).assign(this, init); }
}

export class GetContactsModel
{
    /** @description List of Contacts with details. */
    // @ApiMember(DataType="string", Description="List of Contacts with details.", Name="Contacts", ParameterType="body")
    public Contacts: IList<SubscriptionContactModel>;

    /** @description List of contact-staff details. */
    // @ApiMember(DataType="string", Description="List of contact-staff details.", Name="ContactStaff", ParameterType="body")
    public ContactStaff: IList<ContactsStaff>;

    public constructor(init?: Partial<GetContactsModel>) { (Object as any).assign(this, init); }
}

/** @description 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")
export class GetContacts implements IReturn<GetContactsModel>
{
    /** @description 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 SuiteDataSourceInstanceId: string;

    /** @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) */
    // @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")
    public ContactRoles: string[] = [];

    /** @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) */
    // @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")
    public ContactTypes: string[];

    /** @description 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 IncludeStaff: boolean;

    /** @description 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 CustomContentViewId: string;

    /** @description 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 ModifiedSince: string;

    public constructor(init?: Partial<GetContacts>) { (Object as any).assign(this, init); }
    public getTypeName() { return 'GetContacts'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new GetContactsModel(); }
}