(* Options:
Date: 2026-04-03 23:29:53
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//GlobalNamespace: 
//MakeDataContractsExtensible: False
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//ExportValueTypes: False
IncludeTypes: GetUserProfiles.*
//ExcludeTypes: 
//InitializeCollections: False
//AddNamespaces: 
*)

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserRoleModel() = 
        ///<summary>
        ///The Contact Role Id, that links the Contact to their role.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")>]
        member val ContactRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The Role Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The role name.
        ///</summary>
        [<ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///The URL of the role's image icon.
        ///</summary>
        [<ApiMember(DataType="string", Description="The URL of the role's image icon.", Name="RolePrimaryImageURL", ParameterType="query")>]
        member val RolePrimaryImageURL:String = null with get,set

        ///<summary>
        ///The URL of the role's thumbnail image icon.
        ///</summary>
        [<ApiMember(DataType="string", Description="The URL of the role's thumbnail image icon.", Name="RolePrimaryImageThumbnailURL", ParameterType="query")>]
        member val RolePrimaryImageThumbnailURL:String = null with get,set

        ///<summary>
        ///The Guid of the role's media file containing the image icon details.
        ///</summary>
        [<ApiMember(DataType="string", Description="The Guid of the role's media file containing the image icon details.", Name="RolePrimaryImageId", ParameterType="query")>]
        member val RolePrimaryImageId:Guid = new Guid() with get,set

        ///<summary>
        ///The date the contact started having this role.
        ///</summary>
        [<ApiMember(DataType="DateTime", Description="The date the contact started having this role.", Name="StartDate", ParameterType="query")>]
        member val StartDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///The date the contact will end having this role.
        ///</summary>
        [<ApiMember(DataType="DateTime?", Description="The date the contact will end having this role.", Name="EndDate", ParameterType="query")>]
        member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type UserContactConnectionModel() = 
        ///<summary>
        ///The Contact Role Id, that links the Contact to their role.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")>]
        member val ContactRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The role name.
        ///</summary>
        [<ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")>]
        member val ContactRoleName:String = null with get,set

        ///<summary>
        ///The list item role Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")>]
        member val ContactListItemRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The URL of the contact role's image icon.
        ///</summary>
        [<ApiMember(DataType="string", Description="The URL of the contact role's image icon.", Name="ContactRolePrimaryImageURL", ParameterType="query")>]
        member val ContactRolePrimaryImageURL:String = null with get,set

        ///<summary>
        ///The URL of the contact role's thumbnail image icon.
        ///</summary>
        [<ApiMember(DataType="string", Description="The URL of the contact role's thumbnail image icon.", Name="ContactRolePrimaryImageThumbnailURL", ParameterType="query")>]
        member val ContactRolePrimaryImageThumbnailURL:String = null with get,set

        ///<summary>
        ///The Guid of the contact role's media file containing the image icon details.
        ///</summary>
        [<ApiMember(DataType="string", Description="The Guid of the contact role's media file containing the image icon details.", Name="ContactRolePrimaryImageId", ParameterType="query")>]
        member val ContactRolePrimaryImageId:Guid = new Guid() with get,set

        ///<summary>
        ///The connected contacts Id. (licensee)
        ///</summary>
        [<ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")>]
        member val ConnectionContactId:Guid = new Guid() with get,set

        ///<summary>
        ///The connected contacts Full Name.
        ///</summary>
        [<ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")>]
        member val ConnectionContactName:String = null with get,set

        ///<summary>
        ///The connected contacts role.
        ///</summary>
        [<ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")>]
        member val ConnectionContactRoleName:String = null with get,set

        ///<summary>
        ///The connected contacts role Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")>]
        member val ConnectionContactRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The connected contacts list item role Id.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")>]
        member val ConnectionContactListItemRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///The Contacts Type.
        ///</summary>
        [<ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")>]
        member val ContactTypeName:String = null with get,set

        ///<summary>
        ///The URL to the Connected Contacts Photo.
        ///</summary>
        [<ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")>]
        member val ConnectionContactPhotoURL:String = null with get,set

        ///<summary>
        ///.
        ///</summary>
        [<ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")>]
        member val IsContactLicenseeRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///If the connection is as a licensee this is true.
        ///</summary>
        [<ApiMember(DataType="bool", Description="If the connection is as a licensee this is true.", Name="IsConnectionLicenseeRole", ParameterType="query")>]
        member val IsConnectionLicenseeRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///The status of the connection with the contact.
        ///</summary>
        [<ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")>]
        member val ConnectionStatusName:String = null with get,set

        ///<summary>
        ///The status Id of the connection with the contact.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The status Id of the connection with the contact.", Name="ConnectionStatusId", ParameterType="query")>]
        member val ConnectionStatusId:Guid = new Guid() with get,set

        ///<summary>
        ///The ContactRoleConnectionId of an active connection with the contact.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The ContactRoleConnectionId of an active connection with the contact.", Name="ConnectionId", ParameterType="query")>]
        member val ConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///The ContactRoleConnectionRequest of a pending connection with the contact.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The ContactRoleConnectionRequest of a pending connection with the contact.", Name="ConnectionRequestId", ParameterType="query")>]
        member val ConnectionRequestId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type ContactEmailAddress() = 
        ///<summary>
        ///The Contact Id of the contact.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///The Contact Full Name
        ///</summary>
        [<ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query")>]
        member val ContactName:String = null with get,set

        ///<summary>
        ///The Contact Email Address.
        ///</summary>
        [<ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")>]
        member val EmailAddress:String = null with get,set

        ///<summary>
        ///The Contact Photo URL
        ///</summary>
        [<ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")>]
        member val ContactPhotoURL:String = null with get,set

    [<AllowNullLiteral>]
    type UserProfileModel() = 
        inherit UserProfileSummaryModel()
        ///<summary>
        ///Contact Date of Birth (when person type)
        ///</summary>
        [<ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query")>]
        member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Contact marital status (when person type)
        ///</summary>
        [<ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query")>]
        member val MaritalStatusName:String = null with get,set

        ///<summary>
        ///Contact gender (when person type)
        ///</summary>
        [<ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query")>]
        member val GenderName:String = null with get,set

        ///<summary>
        ///The Gender Guid of the contact.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query")>]
        member val GenderId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///All contact details of the contact
        ///</summary>
        [<ApiMember(DataType="List<ContactDetailModel>", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query")>]
        member val ContactDetails:ResizeArray<ContactDetailModel> = null with get,set

        ///<summary>
        ///Primary Street Address
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ")>]
        member val PrimaryStreetAddress:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Postal Address
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ")>]
        member val PrimaryPostalAddress:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Registered Address
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ")>]
        member val PrimaryRegisteredAddress:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Email Address
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ")>]
        member val PrimaryEmail:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Mobile Number
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile")>]
        member val PrimaryMobile:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Non-Mobile Number
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone")>]
        member val PrimaryPhone:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Fax Number
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax")>]
        member val PrimaryFax:ContactDetailModel = null with get,set

        ///<summary>
        ///Primary Web Address
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb")>]
        member val PrimaryWeb:ContactDetailModel = null with get,set

        ///<summary>
        ///Social Media Twitter
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter")>]
        member val SocialMediaTwitter:ContactDetailModel = null with get,set

        ///<summary>
        ///Social Media Facebook
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook")>]
        member val SocialMediaFacebook:ContactDetailModel = null with get,set

        ///<summary>
        ///Social Media Instagram
        ///</summary>
        [<ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram")>]
        member val SocialMediaInstagram:ContactDetailModel = null with get,set

        ///<summary>
        ///Have all connections to the contact been removed?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")>]
        member val IsRemovedContact:Boolean = new Boolean() with get,set

        ///<summary>
        ///True if this is the users default profile.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query")>]
        member val IsDefault:Boolean = new Boolean() with get,set

        ///<summary>
        ///True if the users email on this profile can be edited.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if the users email on this profile can be edited.", Name="IsEmailEditable", ParameterType="query")>]
        member val IsEmailEditable:Boolean = new Boolean() with get,set

        ///<summary>
        ///Primary image Content sent as a file stream contents (if not attached to the request)
        ///</summary>
        [<ApiMember(DataType="string", Description="Primary image Content sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContent")>]
        member val PrimaryImageContent:String = null with get,set

        ///<summary>
        ///Primary image Content type sent as a file stream contents (if not attached to the request)
        ///</summary>
        [<ApiMember(DataType="string", Description="Primary image Content type sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContentType")>]
        member val PrimaryImageContentType:String = null with get,set

        ///<summary>
        ///Primary image file name
        ///</summary>
        [<ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName")>]
        member val PrimaryImageFileName:String = null with get,set

    [<AllowNullLiteral>]
    type UserProfileWithRolesModel() = 
        inherit UserProfileModel()
        ///<summary>
        ///A list of roles assigned to the user.
        ///</summary>
        [<ApiMember(DataType="List<UserRoleModel>", Description="A list of roles assigned to the user.", Name="Roles", ParameterType="query")>]
        member val Roles:ResizeArray<UserRoleModel> = null with get,set

        ///<summary>
        ///A list of contact connections assigned to the user.
        ///</summary>
        [<ApiMember(DataType="List<UserContactConnectionModel>", Description="A list of contact connections assigned to the user.", Name="ContactConnections", ParameterType="query")>]
        member val ContactConnections:ResizeArray<UserContactConnectionModel> = null with get,set

        ///<summary>
        ///A list of connected contacts and their email addresses.
        ///</summary>
        [<ApiMember(DataType="List<ContactEmailAddressBook>", Description="A list of connected contacts and their email addresses.", Name="EmailAddressBook", ParameterType="query")>]
        member val EmailAddressBook:ResizeArray<ContactEmailAddress> = null with get,set

    [<AllowNullLiteral>]
    type UserProfilesWithRolesModel() = 
        ///<summary>
        ///A list of profiles for the user.
        ///</summary>
        [<ApiMember(DataType="List<UserProfileWithRolesModel>", Description="A list of profiles for the user.", Name="Profiles")>]
        member val Profiles:ResizeArray<UserProfileWithRolesModel> = null with get,set

    ///<summary>
    ///Returns a Users profile information.
    ///</summary>
    [<Route("/profiles")>]
    [<Api(Description="Returns a Users profile information.")>]
    [<AllowNullLiteral>]
    type GetUserProfiles() = 
        interface IReturn<UserProfilesWithRolesModel>
        ///<summary>
        ///The user's Guid.  If the value passed is empty, UserName must be entered.
        ///</summary>
        [<ApiMember(DataType="Guid?", Description="The user's Guid.  If the value passed is empty, UserName must be entered.", Name="UserId", ParameterType="query")>]
        member val UserId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Unique Email address of the user.  If the value passed is empty, UserId must be entered.
        ///</summary>
        [<ApiMember(DataType="string", Description="Unique Email address of the user.  If the value passed is empty, UserId must be entered.", Name="UserName", ParameterType="query")>]
        member val UserName:String = null with get,set

        ///<summary>
        ///Flag to exclude contact details from organisation profiles.
        ///</summary>
        [<ApiMember(DataType="bool", Description="Flag to exclude contact details from organisation profiles.", Name="ExcludeContactDetails", ParameterType="query")>]
        member val ExcludeContactDetails:Boolean = new Boolean() with get,set