/* Options:
Date: 2026-04-04 10:21:28
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: RegisterNewUser.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Registers a new user with the platform as a 'Perspective Platform - Platform Member'
*/
// @Route("/register")
// @Api(Description="Registers a new user with the platform as a 'Perspective Platform - Platform Member'")
public class RegisterNewUser : IReturn, Codable
{
    public typealias Return = ResponseStatus

    /**
    * Details of the contacts primary/default user profile.
    */
    // @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="EmailAddress", ParameterType="query")
    public var emailAddress:String?

    /**
    * Details of the contacts primary/default user profile.
    */
    // @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="Password", ParameterType="query")
    public var password:String?

    /**
    * Details of the contacts primary/default user profile.
    */
    // @ApiMember(DataType="string", Description="Details of the contacts primary/default user profile.", IsRequired=true, Name="FirstName", ParameterType="query")
    public var firstName:String?

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

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

    /**
    * The users industry they work in and what they do (Profession/Trade/Industry).
    */
    // @ApiMember(DataType="string", Description="The users industry they work in and what they do (Profession/Trade/Industry).", IsRequired=true, Name="EmploymentIndustry", ParameterType="query")
    public var employmentIndustry:String?

    /**
    * The users company/trading name and any major businesses they contract to (Working/Subcontracting for).
    */
    // @ApiMember(DataType="string", Description="The users company/trading name and any major businesses they contract to (Working/Subcontracting for).", IsRequired=true, Name="EmploymentRole", ParameterType="query")
    public var employmentRole:String?

    /**
    * The users areas or geographic regions they work in (Work Areas/Suburbs).
    */
    // @ApiMember(DataType="string", Description="The users areas or geographic regions they work in (Work Areas/Suburbs).", IsRequired=true, Name="EmploymentGeographicArea", ParameterType="query")
    public var employmentGeographicArea:String?

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

    /**
    * The users business profile information (if they have a business).
    */
    // @ApiMember(DataType="SaveUserProfile", Description="The users business profile information (if they have a business).", Name="BusinessProfile", ParameterType="query")
    public var businessProfile:SaveUserProfile?

    required public init(){}
}

/**
* 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(){}
}