""" Options: Date: 2025-09-14 06:40:21 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: SaveProject.* #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 RuleValidationResult: rule_code: Optional[str] = None message: Optional[str] = None key: Optional[str] = None tag: Optional[str] = None error_code: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ValidationErrorList: validation_errors: Optional[List[RuleValidationResult]] = None class ISubscription: suite_data_source_instance_id: Optional[str] = None object_id: Optional[str] = None alternate_key: Optional[str] = None ignore_validation: bool = False @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class SubscriptionObjectModel(ISubscription): # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query") suite_data_source_instance_id: Optional[str] = None """ Guid representing the external systems datasource information. """ # @ApiMember(DataType="string", Description="The unique key that represents the object on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query") alternate_key: Optional[str] = None """ The unique key that represents the object on the external system. """ # @ApiMember(DataType="Guid", Description="Guid of the object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query") object_id: Optional[str] = None """ Guid of the object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key. """ # @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="query") rms_table_ctx_id: Optional[str] = None """ Guid of the RmsTableCtx within Eros. This is used if the alternate key is provided to identify the object to update. """ # @ApiMember(DataType="bool", Description="Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement.", Name="IgnoreValidation", ParameterType="query") ignore_validation: bool = False """ Validation ensures that this object has a value in alternateKey or ObjectId, ignoring validation skips this requirement. """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class SubscriptionLinkContact: # @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="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query") contact_alternate_key: Optional[str] = None """ The unique key that represents the contact on the external system. """ # @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. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query") role_alternate_key: Optional[str] = None """ The unique key that represents the role type on the external system. Note: Use of this is not currently implemented """ @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 DimensionValueModel: dimension_value_id: Optional[str] = None dimension_id: Optional[str] = None name: Optional[str] = None description: Optional[str] = None short_name: Optional[str] = None traffic_light_id: Optional[str] = None traffic_light_colour: Optional[str] = None object_connection_id: Optional[str] = None owner_contact_id: Optional[str] = None record_status: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class SubscriptionCommonProjectModel: # @ApiMember(DataType="string", Description="A reference number used for identifying the project in the external system.", Name="Reference", ParameterType="query") reference: Optional[str] = None """ A reference number used for identifying the project in the external system. """ # @ApiMember(DataType="string", Description="A name for the project.", IsRequired=true, Name="Name", ParameterType="query") name: Optional[str] = None """ A name for the project. """ # @ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="query") description: Optional[str] = None """ A description for the project. """ # @ApiMember(DataType="List", Description="A list of ProjectContact records that link contacts (and their role in the project) to the project.", Name="ProjectContacts", ParameterType="query") project_contacts: Optional[List[SubscriptionLinkContact]] = None """ A list of ProjectContact records that link contacts (and their role in the project) to the project. """ # @ApiMember(DataType="AddressModel", Description="An address for the project.", Name="ProjectAddress", ParameterType="query") project_address: Optional[AddressModel] = None """ An address for the project. """ # @ApiMember(DataType="SubscriptionObjectModel", Description="A link to the Customer Contact Group.", Name="CustomerContactGroup", ParameterType="query") customer_contact_group: Optional[SubscriptionObjectModel] = None """ A link to the Customer Contact Group. """ # @ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="query") group_name: Optional[str] = None """ Project Group Name. """ # @ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="query") stage_name: Optional[str] = None """ Stage Name. """ # @ApiMember(DataType="Guid", Description="Guid of the Media Object representing the projects primary image.", Name="PrimaryProjectImageId", ParameterType="query") primary_project_image_id: Optional[str] = None """ Guid of the Media Object representing the projects primary image. """ # @ApiMember(DataType="string", Description="URL to the projects primary full image.", Name="PrimaryProjectPhotoUrl", ParameterType="query") primary_project_photo_url: Optional[str] = None """ URL to the projects primary full image. """ # @ApiMember(DataType="string", Description="URL to the projects primary thumbnail image.", Name="PrimaryProjectThumbnailUrl", ParameterType="query") primary_project_thumbnail_url: Optional[str] = None """ URL to the projects primary thumbnail image. """ # @ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoHeight", ParameterType="query") primary_project_photo_height: int = 0 """ Image height of the projects logo. """ # @ApiMember(DataType="int", Description="Image height of the projects logo.", Name="PrimaryProjectPhotoWidth", ParameterType="query") primary_project_photo_width: int = 0 """ Image height of the projects logo. """ # @ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="query") dynamic_content: Optional[str] = None """ Dynamically linked content. """ # @ApiMember(DataType="char", Description="If this is 'A' then a documentable ObjectConnection will be created. If this is 'D' then a documentable ObjectConnection will be removed if it exists. Any other value will be ignored.", Name="DocumentableObjectConnection", ParameterType="query") documentable_object_connection: Optional[str] = None """ If this is 'A' then a documentable ObjectConnection will be created. If this is 'D' then a documentable ObjectConnection will be removed if it exists. Any other value will be ignored. """ # @ApiMember(DataType="List", Description="Dimension values linked to the project.", Name="DimensionValues", ParameterType="query") dimension_values: Optional[List[DimensionValueModel]] = None """ Dimension values linked to the project. """ # @ApiMember(DataType="List", Description="Dimension values linked to the project.", Name="Calendars", ParameterType="query") calendars: Optional[List[str]] = None """ Dimension values linked to the project. """ # @ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="query") document_site_id: Optional[str] = None """ The Document Site ID. """ object_subscription_id: Optional[str] = None object_hash: Optional[str] = None # @Api(Description="Inserts or Updates a project details and its contact connections and addresses.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class SaveProject(ValidationErrorList, IReturn[ResponseStatus], ISubscription): """ Inserts or Updates a project details and its contact connections and addresses. """ # @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId") suite_data_source_instance_id: Optional[str] = None """ Guid representing the external systems datasource information. """ # @ApiMember(DataType="string", Description="The unique key that represents the project on the external system.", IsRequired=true, Name="AlternateKey") alternate_key: Optional[str] = None """ The unique key that represents the project on the external system. """ # @ApiMember(DataType="Guid", Description="Guid of the project object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="query") object_id: Optional[str] = None """ Guid of the project object within Eros. If ObjectId is known, the external system may pass this instead of the alternate key. """ # @ApiMember(DataType="bool", Description="If set to true, the object will be updated/refreshed. If false, the hash representation of the Project model and its data will be compared with the current Project to determine if there are any changes to save.", Name="IgnoreHash") ignore_hash: bool = False """ If set to true, the object will be updated/refreshed. If false, the hash representation of the Project model and its data will be compared with the current Project to determine if there are any changes to save. """ ignore_validation: bool = False # @ApiMember(DataType="SubscriptionCommonProjectModel", Description="Object containing all details of the project to be inserted or updated.", IsRequired=true, Name="Project", ParameterType="query") project: Optional[SubscriptionCommonProjectModel] = None """ Object containing all details of the project to be inserted or updated. """ licensee_id: Optional[str] = None session_id: Optional[str] = None