/* Options:
Date: 2026-04-04 06:46:06
SwiftVersion: 6.0
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
//MakePropertiesOptional: True
IncludeTypes: SaveUserProfile.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Updates a Users Profile information'
*/
// @Api(Description="Updates a Users Profile information'")
public class SaveUserProfile : IReturn, Codable
{
    public typealias Return = ResponseStatus

    /**
    * The users profile Guid.
    */
    // @ApiMember(DataType="Guid", Description="The users profile Guid.", IsRequired=true, Name="UserProfileId", ParameterType="query")
    public var userProfileId:String?

    /**
    * The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.
    */
    // @ApiMember(DataType="Guid", Description="The users Guid. This is used for validation to ensure the user in the session is only changing his own user information.", IsRequired=true, Name="UserId", ParameterType="query")
    public var userId:String?

    /**
    * The users contact Guid.
    */
    // @ApiMember(DataType="Guid", Description="The users contact Guid.", IsRequired=true, Name="ContactId", ParameterType="query")
    public var contactId:String?

    /**
    * The users profile name.
    */
    // @ApiMember(DataType="string", Description="The users profile name.", IsRequired=true, Name="ProfileName", ParameterType="query")
    public var profileName:String?

    /**
    * The users (contact) title.
    */
    // @ApiMember(DataType="string", Description="The users (contact) title.", Name="Title", ParameterType="query")
    public var title:String?

    /**
    * The users (contact) first name(s).
    */
    // @ApiMember(DataType="string", Description="The users (contact) first name(s).", IsRequired=true, Name="FirstName", ParameterType="query")
    public var firstName:String?

    /**
    * The users (contact) surname.
    */
    // @ApiMember(DataType="string", Description="The users (contact) surname.", IsRequired=true, Name="Surname", ParameterType="query")
    public var surname:String?

    /**
    * The contact profile description.
    */
    // @ApiMember(DataType="string", Description="The contact profile description.", Name="Description", ParameterType="query")
    public var Description:String?

    /**
    * The contacts profession/trade/industry details.
    */
    // @ApiMember(DataType="string", Description="The contacts profession/trade/industry details.", Name="EmploymentIndustry", ParameterType="query")
    public var employmentIndustry:String?

    /**
    * The contact details of who they work/subcontract for.
    */
    // @ApiMember(DataType="string", Description="The contact details of who they work/subcontract for.", Name="EmploymentRole", ParameterType="query")
    public var employmentRole:String?

    /**
    * The contacts work area/suburbs.
    */
    // @ApiMember(DataType="string", Description="The contacts work area/suburbs.", Name="EmploymentGeographicArea", ParameterType="query")
    public var employmentGeographicArea:String?

    /**
    * The contacts timezone.
    */
    // @ApiMember(DataType="Guid", Description="The contacts timezone.", Name="Timezone", ParameterType="query")
    public var timezone:String?

    /**
    * A list of the contact details for the contact. Note: an email must always be set for a business.
    */
    // @ApiMember(DataType="List<ContactDetailModel>", Description="A list of the contact details for the contact. Note: an email must always be set for a business.", IsRequired=true, Name="ContactDetails", ParameterType="query")
    public var contactDetails:[ContactDetailModel] = []

    /**
    * Type of contact (person, organisation etc.) linked to the profile
    */
    // @ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactType")
    public var contactType:String?

    /**
    * Legal name of contact linked to the profile
    */
    // @ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")
    public var legalName:String?

    /**
    * Trading name of contact linked to the profile
    */
    // @ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")
    public var tradingName:String?

    /**
    * Abn of contact linked to the profile
    */
    // @ApiMember(DataType="string", Description="Abn of contact linked to the profile", Name="Abn")
    public var abn:String?

    /**
    * Acn of contact linked to the profile
    */
    // @ApiMember(DataType="string", Description="Acn of contact linked to the profile", Name="Acn")
    public var acn:String?

    /**
    * Arbn of contact linked to the profile
    */
    // @ApiMember(DataType="string", Description="Arbn of contact linked to the profile", Name="Arbn")
    public var arbn:String?

    /**
    * Indicates if the Contact is registered for GST.
    */
    // @ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")
    public var gstRegistered:Bool?

    /**
    * The Gender Guid of the contact.
    */
    // @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")
    public var genderId: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 ContactDetailModel : Codable
{
    /**
    * Contact Method Id
    */
    // @ApiMember(DataType="Guid", Description="Contact Method Id", Name="ContactMethodId", ParameterType="query")
    public var contactMethodId:String?

    /**
    * Contact Method Name
    */
    // @ApiMember(DataType="string", Description="Contact Method Name", Name="ContactMethodName", ParameterType="query")
    public var contactMethodName:String?

    /**
    * Contact Address Details
    */
    // @ApiMember(DataType="ContactAddressModel", Description="Contact Address Details", Name="ContactAddress", ParameterType="query")
    public var contactAddress:ContactAddressModel?

    /**
    * Contact Phone Details
    */
    // @ApiMember(DataType="PhoneModel", Description="Contact Phone Details", Name="ContactPhone", ParameterType="query")
    public var contactPhone:PhoneModel?

    /**
    * Country id
    */
    // @ApiMember(DataType="Guid", Description="Country id", Name="CountryId", ParameterType="query")
    public var countryId:String?

    /**
    * Contact Details
    */
    // @ApiMember(DataType="string", Description="Contact Details", Name="ContactDetails", ParameterType="query")
    public var contactDetails:String?

    /**
    * Notes
    */
    // @ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")
    public var notes:String?

    /**
    * Contact Details Code
    */
    // @ApiMember(DataType="string", Description="Contact Details Code", Name="ContactDetailsCode", ParameterType="query")
    public var contactDetailsCode:String?

    /**
    * Order of Contact Method Id
    */
    // @ApiMember(DataType="int", Description="Order of Contact Method Id", Name="OrderContactMethod", ParameterType="query")
    public var orderContactMethod:Int?

    /**
    * Contact Method Id
    */
    // @ApiMember(DataType="bool", Description="Contact Method Id", Name="IsPrimaryContactMethod", ParameterType="query")
    public var isPrimaryContactMethod:Bool?

    /**
    * Is contact details an address
    */
    // @ApiMember(DataType="bool", Description="Is contact details an address", Name="IsAddress", ParameterType="query")
    public var isAddress:Bool?

    /**
    * Contact Contact Detail Id
    */
    // @ApiMember(DataType="Guid", Description="Contact Contact Detail Id", Name="ContactContactDetailId", ParameterType="query")
    public var contactContactDetailId:String?

    /**
    * Contact Id
    */
    // @ApiMember(DataType="Guid", Description="Contact Id", Name="ContactId", ParameterType="query")
    public var contactId:String?

    /**
    * Contact Details Id
    */
    // @ApiMember(DataType="Guid", Description="Contact Details Id", Name="ContactDetailId", ParameterType="query")
    public var contactDetailId:String?

    /**
    * Is contact details a primary location
    */
    // @ApiMember(DataType="bool", Description="Is contact details a primary location", Name="IsPrimaryLocation", ParameterType="query")
    public var isPrimaryLocation:Bool?

    /**
    * Is contact details a registered location
    */
    // @ApiMember(DataType="bool", Description="Is contact details a registered location", Name="IsRegisteredLocation", ParameterType="query")
    public var isRegisteredLocation:Bool?

    /**
    * Is contact details a postal address
    */
    // @ApiMember(DataType="bool", Description="Is contact details a postal address", Name="IsPostal", ParameterType="query")
    public var isPostal:Bool?

    /**
    * Is contact details a phone number
    */
    // @ApiMember(DataType="bool", Description="Is contact details a phone number", Name="IsPhone", ParameterType="query")
    public var isPhone:Bool?

    /**
    * Email Signature Id
    */
    // @ApiMember(DataType="Guid", Description="Email Signature Id", Name="EmailSignatureId", ParameterType="query")
    public var emailSignatureId:String?

    /**
    * Email Signature HTML
    */
    // @ApiMember(DataType="string", Description="Email Signature HTML", Name="EmailSignatureHTML", ParameterType="query")
    public var emailSignatureHTML:String?

    /**
    * Email Signature Text
    */
    // @ApiMember(DataType="string", Description="Email Signature Text", Name="EmailSignatureText", ParameterType="query")
    public var emailSignatureText:String?

    /**
    * API Key from Framework
    */
    // @ApiMember(DataType="string", Description="API Key from Framework", Name="ApiFrameworkAlternateKey", ParameterType="query")
    public var apiFrameworkAlternateKey:String?

    required public init(){}
}