""" Options:
Date: 2026-02-04 04:50:42
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:
    # @ApiMember(DataType="Guid", Description="Validation/Error message details", Name="Message", ParameterType="body")
    message: Optional[str] = None
    """
    Validation/Error message details
    """


    # @ApiMember(DataType="Guid", Description="Summary/label of validation/error", Name="Key", ParameterType="body")
    key: Optional[str] = None
    """
    Summary/label of validation/error
    """


    # @ApiMember(DataType="Guid", Description="Key/code representing validation/error", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    Key/code representing validation/error
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ValidationErrorList:
    # @ApiMember(DataType="List<RuleValidationResult>", Description="List of any validation/errors occuring during a method call", Name="ValidationErrors", ParameterType="body")
    validation_errors: Optional[List[RuleValidationResult]] = None
    """
    List of any validation/errors occuring during a method call
    """


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="body")
    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.", Name="AlternateKey", ParameterType="body")
    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 PSTPF.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="body")
    object_id: Optional[str] = None
    """
    Guid of the object within PSTPF.  If ObjectId is known, the external system may pass this instead of the alternate key.
    """


    # @ApiMember(DataType="Guid", Description="Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.", Name="RmsTableCtxId", ParameterType="body")
    rms_table_ctx_id: Optional[str] = None
    """
    Guid of the RmsTableCtx within PSTPF.  This is used if the alternate key is provided to identify the object to update.
    """


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


    # @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", Name="ContactAlternateKey", ParameterType="body")
    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 PSTPF.", Name="RoleId", ParameterType="body")
    role_id: Optional[str] = None
    """
    Guid of the Role List Item object within PSTPF.
    """


    # @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="body")
    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(Description="The latitude of an address - geographic coordinates specifying the north-south position of a point on the Earth's surface.", 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(Description="The longitude of an address - geographic coordinates specifying the east-west position of a point on the Earth's surface.", 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(Description="The altitude of an address - the altitude above sea level.\"", ParameterType="query")
    altitude: Optional[float] = None
    """
    The altitude of an address - the altitude above sea level."
    """


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


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


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


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


    # @ApiMember(Description="Speed your altitude is ascending/descending at.", 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="body")
    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.", Name="Latitude", ParameterType="body")
    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.", Name="Longitude", ParameterType="body")
    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="body")
    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="body")
    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="body")
    suburb_name: Optional[str] = None
    """
    The suburb name.
    """


    # @ApiMember(DataType="string", Description="The shortened State Name e.g Vic for Victoria.", Name="StateShortName", ParameterType="body")
    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="body")
    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="body")
    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="body")
    country_name: Optional[str] = None
    """
    the name of the country the address is within.
    """


    # @ApiMember(Description="ISO Country Code.", ParameterType="query")
    iso_country_code: Optional[str] = None
    """
    ISO Country Code.
    """


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


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


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


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


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


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


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


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


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


    # @ApiMember(DataType="string", Description="Notes about the address.", Name="Notes")
    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="body")
    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="body")
    location_coordinates: Optional[LocationCoordinatesModel] = None
    """
    Location Coordinates for the address.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DimensionValueModel:
    # @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
    dimension_value_id: Optional[str] = None
    """
    Id of the dimension value.
    """


    # @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
    dimension_id: Optional[str] = None
    """
    Dimension Id this value is for.
    """


    # @ApiMember(Description="Name of the dimension value.", ParameterType="body")
    name: Optional[str] = None
    """
    Name of the dimension value.
    """


    # @ApiMember(Description="Description of the dimension value.", ParameterType="body")
    description: Optional[str] = None
    """
    Description of the dimension value.
    """


    # @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
    short_name: Optional[str] = None
    """
    Short Name for the dimension value.
    """


    # @ApiMember(Description="Id of the colour associated.", ParameterType="body")
    traffic_light_id: Optional[str] = None
    """
    Id of the colour associated.
    """


    # @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
    traffic_light_colour: Optional[str] = None
    """
    Colour associated with the dimension value.
    """


    # @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
    object_connection_id: Optional[str] = None
    """
    Id that links this dimension value to an object.
    """


    # @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
    owner_contact_id: Optional[str] = None
    """
    Owner Id of the dimension value.
    """


    # @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
    record_status: Optional[str] = None
    """
    Record status of the dimension value.
    """


@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="body")
    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="body")
    name: Optional[str] = None
    """
    A name for the project.
    """


    # @ApiMember(DataType="string", Description="A description for the project.", IsRequired=true, Name="Description", ParameterType="body")
    description: Optional[str] = None
    """
    A description for the project.
    """


    # @ApiMember(DataType="List<SubscriptionLinkContact>", Description="A list of ProjectContact records that link contacts (and their role in the project) to the project.", Name="ProjectContacts", ParameterType="body")
    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="body")
    project_address: Optional[AddressModel] = None
    """
    An address for the project.
    """


    # @ApiMember(DataType="SubscriptionObjectModel", Description="A link to the Customer Contact Group.", Name="CustomerContactGroup", ParameterType="body")
    customer_contact_group: Optional[SubscriptionObjectModel] = None
    """
    A link to the Customer Contact Group.
    """


    # @ApiMember(DataType="string", Description="Project Group Name.", Name="GroupName", ParameterType="body")
    group_name: Optional[str] = None
    """
    Project Group Name.
    """


    # @ApiMember(DataType="string", Description="Stage Name.", Name="StageName", ParameterType="body")
    stage_name: Optional[str] = None
    """
    Stage Name.
    """


    # @ApiMember(Description="Guid of the Media Object representing the projects primary image.", 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="body")
    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="body")
    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="body")
    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="body")
    primary_project_photo_width: int = 0
    """
    Image height of the projects logo.
    """


    # @ApiMember(DataType="string", Description="Dynamically linked content.", Name="DynamicContent", ParameterType="body")
    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="body")
    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<DimensionValueModel>", Description="Dimension values linked to the project.", Name="DimensionValues", ParameterType="body")
    dimension_values: Optional[List[DimensionValueModel]] = None
    """
    Dimension values linked to the project.
    """


    # @ApiMember(DataType="List<Guid>", Description="Dimension values linked to the project.", Name="Calendars", ParameterType="body")
    calendars: Optional[List[str]] = None
    """
    Dimension values linked to the project.
    """


    # @ApiMember(DataType="Guid", Description="The Document Site ID.", Name="DocumentSiteId", ParameterType="body")
    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", ParameterType="body")
    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", ParameterType="body")
    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 PSTPF.  If ObjectId is known, the external system may pass this instead of the alternate key.", Name="ObjectId", ParameterType="body")
    object_id: Optional[str] = None
    """
    Guid of the project object within PSTPF.  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.
    """


    # @ApiMember(DataType="SubscriptionCommonProjectModel", Description="Object containing all details of the project to be inserted or updated.", IsRequired=true, Name="Project", ParameterType="body")
    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