""" Options:
Date: 2025-09-14 07:51:28
Version: 8.52
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://production-eros-platform-apisubscription.azurewebsites.net/api

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: GetContacts.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactRole:
    # @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
    role_id: Optional[str] = None
    """
    Guid of the Role List Item object within Eros.
    """


    # @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system.", Name="AlternateKey", ParameterType="query")
    alternate_key: Optional[str] = None
    """
    The unique key that represents the role type on the external system.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LocationCoordinatesModel:
    # @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")
    latitude: float = 0.0
    """
    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 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")
    longitude: float = 0.0
    """
    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 altitude of an address - the altitude above sea level.", Name="Altitude", ParameterType="query")
    altitude: Optional[float] = None
    """
    The altitude of an address - the altitude above sea level.
    """


    # @ApiMember(DataType="Double?", Description="Accuracy of the latitude and longitude.", Name="Accuracy", ParameterType="query")
    accuracy: Optional[float] = None
    """
    Accuracy of the latitude and longitude.
    """


    # @ApiMember(DataType="Double?", Description="Accurancy of the Altitude.", Name="AltitudeAccuracy", ParameterType="query")
    altitude_accuracy: Optional[float] = None
    """
    Accurancy of the Altitude.
    """


    # @ApiMember(DataType="Double?", Description="Direction you are heading.", Name="Heading", ParameterType="query")
    heading: Optional[float] = None
    """
    Direction you are heading.
    """


    # @ApiMember(DataType="Double?", Description="Speed you are going.", Name="Speed", ParameterType="query")
    speed: Optional[float] = None
    """
    Speed you are going.
    """


    # @ApiMember(DataType="Double?", Description="Speed your altitude is ascending/descending at.", Name="VerticalSpeed", ParameterType="query")
    vertical_speed: Optional[float] = None
    """
    Speed your altitude is ascending/descending at.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressModel:
    # @ApiMember(DataType="double", Description="The distance between this project and another specified set of gps coordinates.", Name="DistanceAway", ParameterType="query")
    distance_away: float = 0.0
    """
    The distance between this project and another specified set of gps coordinates.
    """


    # @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")
    latitude: float = 0.0
    """
    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 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")
    longitude: float = 0.0
    """
    The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.
    """


    # @ApiMember(DataType="Guid", Description="Address Format Id Guid - this will be determined by the service.", Name="AddressFormatId", ParameterType="query")
    address_format_id: Optional[str] = None
    """
    Address Format Id Guid - this will be determined by the service.
    """


    # @ApiMember(DataType="Guid", Description="Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.", Name="SuburbId", ParameterType="query")
    suburb_id: Optional[str] = None
    """
    Suburb Id Guid - this will attempt to be determined by the SuburbName, StateShortName and Postcode entered.
    """


    # @ApiMember(DataType="string", Description="The suburb name.", Name="SuburbName", ParameterType="query")
    suburb_name: Optional[str] = None
    """
    The suburb name.
    """


    # @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="query")
    state_short_name: Optional[str] = None
    """
    The shortened State Name e.g Vic for Victoria.
    """


    # @ApiMember(DataType="string", Description="The suburb postcode.", Name="PostCode", ParameterType="query")
    post_code: Optional[str] = None
    """
    The suburb postcode.
    """


    # @ApiMember(DataType="Guid", Description="Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.", Name="CountryId", ParameterType="query")
    country_id: Optional[str] = None
    """
    Country Id Guid - this will be determined by the CountrName or ISOCountryCode entered.
    """


    # @ApiMember(DataType="string", Description="the name of the country the address is within.", Name="CountryName", ParameterType="query")
    country_name: Optional[str] = None
    """
    the name of the country the address is within.
    """


    # @ApiMember(DataType="string", Description="A 2 digit ISO Country Code representing the country.", Name="ISOCountryCode", ParameterType="query")
    iso_country_code: Optional[str] = None
    """
    A 2 digit ISO Country Code representing the country.
    """


    # @ApiMember(DataType="string", Description="The address Lot number.", Name="LotNumber", ParameterType="query")
    lot_number: Optional[str] = None
    """
    The address Lot number.
    """


    # @ApiMember(DataType="string", Description="The address Sub Unit number.", Name="SubUnit", ParameterType="query")
    sub_unit: Optional[str] = None
    """
    The address Sub Unit number.
    """


    # @ApiMember(DataType="string", Description="The address building number.", Name="BuildingNumber", ParameterType="query")
    building_number: Optional[str] = None
    """
    The address building number.
    """


    # @ApiMember(DataType="string", Description="The address street number.", Name="StreetNumber", ParameterType="query")
    street_number: Optional[str] = None
    """
    The address street number.
    """


    # @ApiMember(DataType="string", Description="The address street name including street type.", Name="StreetName", ParameterType="query")
    street_name: Optional[str] = None
    """
    The address street name including street type.
    """


    # @ApiMember(DataType="string", Description="A formatted address Line 1.", Name="AddressLineOne", ParameterType="query")
    address_line_one: Optional[str] = None
    """
    A formatted address Line 1.
    """


    # @ApiMember(DataType="string", Description="A formatted address Line 2.", Name="AddressLineTwo", ParameterType="query")
    address_line_two: Optional[str] = None
    """
    A formatted address Line 2.
    """


    # @ApiMember(DataType="string", Description="The full address string.", Name="AddressFull", ParameterType="query")
    address_full: Optional[str] = None
    """
    The full address string.
    """


    # @ApiMember(DataType="bool?", Description="True if the address is a physical location.", Name="IsPhysical", ParameterType="query")
    is_physical: Optional[bool] = None
    """
    True if the address is a physical location.
    """


    # @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes", ParameterType="query")
    notes: Optional[str] = None
    """
    Notes about the address.
    """


    # @ApiMember(DataType="bool?", Description="If true, the address is eligible for having its coordinates calculated/updated.", Name="AutoMapCoordinates", ParameterType="query")
    auto_map_coordinates: Optional[bool] = None
    """
    If true, the address is eligible for having its coordinates calculated/updated.
    """


    # @ApiMember(DataType="LocationCoordinates", Description="Location Coordinates for the address.", Name="LocationCoordinates", ParameterType="query")
    location_coordinates: Optional[LocationCoordinatesModel] = None
    """
    Location Coordinates for the address.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactAddressModel:
    address: Optional[AddressModel] = None
    is_postal: bool = False
    is_primary_location: bool = False
    is_registered_location: bool = False
    suburb_name: Optional[str] = None
    state_name: Optional[str] = None
    country_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PhoneModel:
    country_code: Optional[str] = None
    area_code: Optional[str] = None
    local_number: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactDetailModel:
    contact_method_id: Optional[str] = None
    contact_method_name: Optional[str] = None
    contact_address: Optional[ContactAddressModel] = None
    contact_phone: Optional[PhoneModel] = None
    country_id: Optional[str] = None
    contact_details: Optional[str] = None
    notes: Optional[str] = None
    contact_details_code: Optional[str] = None
    order_contact_method: int = 0
    is_primary_contact_method: bool = False
    is_address: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionContactModel:
    # @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
    contact_id: Optional[str] = None
    """
    Guid of the contact object within Eros.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the Contact Type List Item object within Eros.", IsRequired=true, Name="ContactType", ParameterType="query")
    contact_type: Optional[str] = None
    """
    Guid of the Contact Type List Item object within Eros.
    """


    # @ApiMember(DataType="Guid?", Description="Guid of the Marital Status List Item object within Eros.", Name="MaritalStatus", ParameterType="query")
    marital_status: Optional[str] = None
    """
    Guid of the Marital Status List Item object within Eros.
    """


    # @ApiMember(DataType="Guid?", Description="Guid of the Gender List Item object within Eros.", Name="Gender", ParameterType="query")
    gender: Optional[str] = None
    """
    Guid of the Gender List Item object within Eros.
    """


    # @ApiMember(DataType="string", Description="The first given name for the contact.  Applies to a person contact type.", Name="FirstName", ParameterType="query")
    first_name: Optional[str] = None
    """
    The first given name 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")
    middle_name: Optional[str] = None
    """
    The middle name(s) 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")
    surname: Optional[str] = None
    """
    The surname for the contact.  Applies to a person contact type.
    """


    # @ApiMember(DataType="string", Description="The full name for the contact.", Name="FullName", ParameterType="query")
    full_name: Optional[str] = None
    """
    The full name for the contact.
    """


    # @ApiMember(DataType="string", Description="A short name for the contact.", Name="ShortName", ParameterType="query")
    short_name: Optional[str] = None
    """
    A short name for the contact.
    """


    # @ApiMember(DataType="DateTime?", Description="The birth date for the contact.  Applies to a person contact type.", Name="BirthDate", ParameterType="query")
    birth_date: Optional[datetime.datetime] = None
    """
    The birth date 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")
    title: Optional[str] = None
    """
    The title for the contact.  Applies to a person contact type.
    """


    # @ApiMember(DataType="string", Description="A salutation for the contact.", Name="Salutation", ParameterType="query")
    salutation: Optional[str] = None
    """
    A salutation for the contact.
    """


    # @ApiMember(DataType="string", Description="The A.B.N for the contact.", Name="Abn", ParameterType="query")
    abn: Optional[str] = None
    """
    The A.B.N for the contact.
    """


    # @ApiMember(DataType="string", Description="The A.C.N for the contact.", Name="Acn", ParameterType="query")
    acn: Optional[str] = None
    """
    The A.C.N for the contact.
    """


    # @ApiMember(DataType="string", Description="The A.R.B.N for the contact.", Name="Arbn", ParameterType="query")
    arbn: Optional[str] = None
    """
    The A.R.B.N for the contact.
    """


    # @ApiMember(DataType="string", Description="A trading name for the contact.", Name="TradingName", ParameterType="query")
    trading_name: Optional[str] = None
    """
    A trading name for the contact.
    """


    # @ApiMember(DataType="string", Description="A legal name for the contact.", Name="LegalName", ParameterType="query")
    legal_name: Optional[str] = None
    """
    A legal name for the contact.
    """


    # @ApiMember(DataType="string", Description="Any notes/description for the contact.", Name="Notes", ParameterType="query")
    notes: Optional[str] = None
    """
    Any notes/description for the contact.
    """


    # @ApiMember(DataType="string", Description="Contact Employment Industry.", Name="EmploymentIndustry", ParameterType="query")
    employment_industry: Optional[str] = None
    """
    Contact Employment Industry.
    """


    # @ApiMember(DataType="string", Description="Contact Employment Role.", Name="EmploymentRole", ParameterType="query")
    employment_role: Optional[str] = None
    """
    Contact Employment Role.
    """


    # @ApiMember(DataType="string", Description="Contact Employment Geographic Area.", Name="EmploymentGeographicArea", ParameterType="query")
    employment_geographic_area: Optional[str] = None
    """
    Contact Employment Geographic Area.
    """


    # @ApiMember(DataType="string", Description="The Contacts Drivers Licence Number", Name="DriversLicence", ParameterType="query")
    drivers_licence: Optional[str] = None
    """
    The Contacts Drivers Licence Number
    """


    # @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST", Name="GstRegistered", ParameterType="query")
    gst_registered: bool = False
    """
    Indicates if the Contact is registered for GST
    """


    # @ApiMember(DataType="string", Description="The status of the contact in EROS", Name="RecordStatus", ParameterType="query")
    record_status: Optional[str] = None
    """
    The status of the contact in EROS
    """


    # @ApiMember(DataType="List<ContactRole>", Description="A list of roles this contact has.", IsRequired=true, Name="ContactRoles", ParameterType="query")
    contact_roles: List[ContactRole] = field(default_factory=list)
    """
    A list of roles this contact has.
    """


    # @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact.", IsRequired=true, Name="ContactDetails", ParameterType="query")
    contact_details: List[ContactDetailModel] = field(default_factory=list)
    """
    A list of the contact details for the contact.
    """


    # @ApiMember(DataType="string", Description="Custom Content XML for the contact.", Name="CustomContentXML", ParameterType="query")
    custom_content_x_m_l: Optional[str] = None
    """
    Custom Content XML for the contact.
    """


    blob_image_u_r_l_primary: Optional[str] = None
    blob_image_u_r_l_primary_thumbnail: Optional[str] = None
    # @ApiMember(DataType="string", Description="The primary mobile for the contact.", Name="PrimaryMobile", ParameterType="query")
    primary_mobile: Optional[str] = None
    """
    The primary mobile for the contact.
    """


    # @ApiMember(DataType="string", Description="The primary email for the contact.", Name="PrimaryEmail", ParameterType="query")
    primary_email: Optional[str] = None
    """
    The primary email for the contact.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactsStaff:
    contact_id: Optional[str] = None
    contact_staff_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactsModel:
    # @ApiMember(DataType="string", Description="List of Contacts with details.", IsRequired=true, Name="Contacts", ParameterType="query")
    contacts: Optional[IList[SubscriptionContactModel]] = None
    """
    List of Contacts with details.
    """


    # @ApiMember(DataType="string", Description="List of contact-staff details.", IsRequired=true, Name="ContactStaff", ParameterType="query")
    contact_staff: Optional[IList[ContactsStaff]] = None
    """
    List of contact-staff details.
    """


# @Api(Description="Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContacts(IReturn[GetContactsModel]):
    """
    Returns a list of contacts with specified roles.  There are options to include custom and also to include each contacts connected contacts
    """

    # @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")
    suite_data_source_instance_id: Optional[str] = None
    """
    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="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="query")
    contact_roles: List[str] = field(default_factory=list)
    """
    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 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")
    contact_types: Optional[List[str]] = None
    """
    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="bool", Description="Set to true if you want to include the any linked staff for each contact.", IsRequired=true, Name="IncludeStaff", ParameterType="query")
    include_staff: bool = False
    """
    Set to true if you want to include the any linked staff for each contact.
    """


    # @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")
    custom_content_view_id: Optional[str] = None
    """
    To include custom content then you need to specify the view Id of the content to include.
    """


    # @ApiMember(DataType="DateTime", Description="Set the date to return only contacts that have been modified since a particular date.", Name="ModifiedSince", ParameterType="query")
    modified_since: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    Set the date to return only contacts that have been modified since a particular date.
    """