(* Options:
Date: 2026-04-04 01:03:59
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: GetContactGroups.*
//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 UserProfileSummaryModel() = 
        ///<summary>
        ///User Profile Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="User Profile Id", Name="UserProfileId")>]
        member val UserProfileId:Guid = new Guid() with get,set

        ///<summary>
        ///User linked to the profile
        ///</summary>
        [<ApiMember(DataType="Guid", Description="User linked to the profile", Name="UserId")>]
        member val UserId:Guid = new Guid() with get,set

        ///<summary>
        ///Contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///User linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="User linked to the profile", Name="UserName")>]
        member val UserName:String = null with get,set

        ///<summary>
        ///User Profile Name
        ///</summary>
        [<ApiMember(DataType="string", Description="User Profile Name", Name="ProfileName")>]
        member val ProfileName:String = null with get,set

        ///<summary>
        ///Full name of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")>]
        member val ContactFullName:String = null with get,set

        ///<summary>
        ///Email Address of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")>]
        member val EmailAddress:String = null with get,set

        ///<summary>
        ///Email signature of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Email signature of the contact linked to the profile", Name="EmailSignature")>]
        member val EmailSignature:String = null with get,set

        ///<summary>
        ///Mobile number of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Mobile number of the contact linked to the profile", Name="MobileNumber")>]
        member val MobileNumber:String = null with get,set

        ///<summary>
        ///Phone number of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Phone number of the contact linked to the profile", Name="PhoneNumber")>]
        member val PhoneNumber:String = null with get,set

        ///<summary>
        ///Type of contact (person, organisation etc.) linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")>]
        member val ContactTypeId:Guid = new Guid() with get,set

        ///<summary>
        ///Type of contact (person, organisation etc.) linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeName")>]
        member val ContactTypeName:String = null with get,set

        ///<summary>
        ///First name of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="First name of the contact linked to the profile", Name="FirstName")>]
        member val FirstName:String = null with get,set

        ///<summary>
        ///Surname of the contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Surname of the contact linked to the profile", Name="Surname")>]
        member val Surname:String = null with get,set

        ///<summary>
        ///Title of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Title of contact linked to the profile", Name="Title")>]
        member val Title:String = null with get,set

        ///<summary>
        ///Legal name of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Legal name of contact linked to the profile", Name="LegalName")>]
        member val LegalName:String = null with get,set

        ///<summary>
        ///Trading name of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Trading name of contact linked to the profile", Name="TradingName")>]
        member val TradingName:String = null with get,set

        ///<summary>
        ///Australian Business Number
        ///</summary>
        [<ApiMember(DataType="string", Description="Australian Business Number", Name="Abn", ParameterType="query")>]
        member val Abn:String = null with get,set

        ///<summary>
        ///Australian Company Number
        ///</summary>
        [<ApiMember(DataType="string", Description="Australian Company Number", Name="Acn", ParameterType="query")>]
        member val Acn:String = null with get,set

        ///<summary>
        ///Australian Registered Body Number
        ///</summary>
        [<ApiMember(DataType="string", Description="Australian Registered Body Number", Name="Arbn", ParameterType="query")>]
        member val Arbn:String = null with get,set

        ///<summary>
        ///Indicates if the Contact is registered for GST.
        ///</summary>
        [<ApiMember(DataType="bool", Description="Indicates if the Contact is registered for GST.", Name="GstRegistered", ParameterType="query")>]
        member val GstRegistered:Boolean = new Boolean() with get,set

        ///<summary>
        ///True if english is a secondary language for the contact.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if english is a secondary language for the contact.", Name="ESL", ParameterType="query")>]
        member val ESL:Boolean = new Boolean() with get,set

        ///<summary>
        ///Language that is the primary language for the contact.
        ///</summary>
        [<ApiMember(DataType="string", Description="Language that is the primary language for the contact.", Name="Language", ParameterType="query")>]
        member val Language:String = null with get,set

        ///<summary>
        ///True if an interpreter is required.
        ///</summary>
        [<ApiMember(DataType="bool", Description="True if an interpreter is required.", Name="InterpreterRequired", ParameterType="query")>]
        member val InterpreterRequired:Boolean = new Boolean() with get,set

        ///<summary>
        ///Licensee specific notes about the contact.
        ///</summary>
        [<ApiMember(DataType="string", Description="Licensee specific notes about the contact.", Name="LicenseeNotes", ParameterType="query")>]
        member val LicenseeNotes:String = null with get,set

        ///<summary>
        ///Profile photo of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")>]
        member val ProfilePhotoUrl:String = null with get,set

        ///<summary>
        ///Thumbnail photo of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")>]
        member val ProfilePhotoThumbnailUrl:String = null with get,set

        ///<summary>
        ///Profile photo id of contact linked to the profile
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Profile photo id of contact linked to the profile", Name="ProfileImageId")>]
        member val ProfileImageId:Guid = new Guid() with get,set

        ///<summary>
        ///Profile description
        ///</summary>
        [<ApiMember(DataType="string", Description="Profile description", Name="Description")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Employment Industry
        ///</summary>
        [<ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")>]
        member val EmploymentIndustry:String = null with get,set

        ///<summary>
        ///Employment Role
        ///</summary>
        [<ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")>]
        member val EmploymentRole:String = null with get,set

        ///<summary>
        ///Areas of Work
        ///</summary>
        [<ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")>]
        member val EmploymentGeographicArea:String = null with get,set

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

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

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

        ///<summary>
        ///Is this an active contact? Or an inactive contact (deleted account)?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is this an active contact? Or an inactive contact (deleted account)?", Name="IsActiveContact")>]
        member val IsActiveContact:Boolean = new Boolean() with get,set

    type SortOrder =
        | Ascending = 0
        | Descending = 1

    [<AllowNullLiteral>]
    type PagedModel() = 
        ///<summary>
        ///Page Number to retrieve
        ///</summary>
        [<ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")>]
        member val PageNumber:Int32 = new Int32() with get,set

        ///<summary>
        ///Number of records to retrieve
        ///</summary>
        [<ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")>]
        member val PageSize:Int32 = new Int32() with get,set

        ///<summary>
        ///Index of field to sort results by
        ///</summary>
        [<ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")>]
        member val SortIndex:Int32 = new Int32() with get,set

        ///<summary>
        ///Sort Order - Ascending or Descending
        ///</summary>
        [<ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")>]
        member val SortOrder:SortOrder = new SortOrder() with get,set

    [<AllowNullLiteral>]
    type RoleModel() = 
        ///<summary>
        ///Role Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")>]
        member val RoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Role Name
        ///</summary>
        [<ApiMember(DataType="string", Description="Role Name", Name="RoleName")>]
        member val RoleName:String = null with get,set

        ///<summary>
        ///Is the role a licensee role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")>]
        member val IsLicenseeRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is manage contacts role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")>]
        member val IsManageContacts:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a Platform role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")>]
        member val IsPlatformRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a services role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")>]
        member val IsServiceRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a customer role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")>]
        member val IsCustomerRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role a functional role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")>]
        member val IsFunctionalRole:Boolean = new Boolean() with get,set

        ///<summary>
        ///Is the role an auto-accept role?
        ///</summary>
        [<ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")>]
        member val IsRequestAutoAccepted:Boolean = new Boolean() with get,set

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")>]
        member val SuiteId:Guid = new Guid() with get,set

        ///<summary>
        ///Suite that the role belongs to
        ///</summary>
        [<ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")>]
        member val SuiteName:String = null with get,set

        ///<summary>
        ///'A' (Active) or 'I' (Inactive)
        ///</summary>
        [<ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<summary>
        ///Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")>]
        member val ObjectConnectionId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type ContactGroupConnectionModel() = 
        inherit UserProfileSummaryModel()
        ///<summary>
        ///Contact Group Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")>]
        member val ContactGroupId:Guid = new Guid() with get,set

        ///<summary>
        ///Connection id of the contact in the group
        ///</summary>
        [<ApiMember(DataType="string", Description="Connection id of the contact in the group", Name="ContactGroupConnectionId")>]
        member val ContactGroupConnectionId:Guid = new Guid() with get,set

        ///<summary>
        ///The Id of the Role this contact is connected to the group with.
        ///</summary>
        [<ApiMember(DataType="string", Description="The Id of the Role this contact is connected to the group with.", Name="ConnectionRoleId")>]
        member val ConnectionRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Order of contacts within a group, the primary contact will have an index of 1.
        ///</summary>
        [<ApiMember(DataType="int", Description="Order of contacts within a group, the primary contact will have an index of 1.", Name="Index")>]
        member val Index:Int32 = new Int32() with get,set

        ///<summary>
        ///List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.
        ///</summary>
        [<ApiMember(DataType="string", Description="List of roles that the contact in the contact group has across appliances for e.g. Platform Customer, Nexus customer etc.", Name="ContactRoles")>]
        member val ContactRoles:ResizeArray<RoleModel> = null with get,set

    [<AllowNullLiteral>]
    type CustomerProjectModel() = 
        member val ProjectId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val ProjectAddress:String = null with get,set
        member val ManagerContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ManagerContactName:String = null with get,set
        member val ManagerProfilePhotoUrl:String = null with get,set
        member val ManagerProfilePhotoThumbnailUrl:String = null with get,set
        member val SupervisorContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val SupervisorContactName:String = null with get,set
        member val SupervisorProfilePhotoUrl:String = null with get,set
        member val SupervisorProfilePhotoThumbnailUrl:String = null with get,set
        member val CustomerServiceContactId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val CustomerServiceContactName:String = null with get,set
        member val CustomerServiceProfilePhotoUrl:String = null with get,set
        member val CustomerServiceProfilePhotoThumbnail:String = null with get,set

    [<AllowNullLiteral>]
    type ContactGroupModel() = 
        ///<summary>
        ///Contact Group Id
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Contact Group Id", Name="ContactGroupId")>]
        member val ContactGroupId:Guid = new Guid() with get,set

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

        ///<summary>
        ///Contact Group Reference
        ///</summary>
        [<ApiMember(DataType="string", Description="Contact Group Reference", Name="Reference")>]
        member val Reference:String = null with get,set

        ///<summary>
        ///Group Role Id for e.g. Customer
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Group Role Id for e.g. Customer", Name="GroupRoleId")>]
        member val GroupRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Primary contact in the group
        ///</summary>
        [<ApiMember(DataType="string", Description="Primary contact in the group", Name="PrimaryContactName")>]
        member val PrimaryContactName:String = null with get,set

        ///<summary>
        ///Contact Id of the primary contact in the group
        ///</summary>
        [<ApiMember(DataType="Guid", Description="Contact Id of the primary contact in the group", Name="PrimaryContactId")>]
        member val PrimaryContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Profile photo url of the primary contact in the group
        ///</summary>
        [<ApiMember(DataType="string", Description="Profile photo url of the primary contact in the group", Name="PrimaryContactPhotoUrl")>]
        member val PrimaryContactPhotoUrl:String = null with get,set

        ///<summary>
        ///Profile photo thumbnail url of the primary contact in the group
        ///</summary>
        [<ApiMember(DataType="string", Description="Profile photo thumbnail url of the primary contact in the group", Name="PrimaryContactThumbnailUrl")>]
        member val PrimaryContactThumbnailUrl:String = null with get,set

        ///<summary>
        ///Number of contacts in the group
        ///</summary>
        [<ApiMember(DataType="int", Description="Number of contacts in the group", Name="NumberOfContacts")>]
        member val NumberOfContacts:Int32 = new Int32() with get,set

        ///<summary>
        ///Record Status of contact group
        ///</summary>
        [<ApiMember(DataType="string", Description="Record Status of contact group", Name="RecordStatus")>]
        member val RecordStatus:String = null with get,set

        ///<summary>
        ///Details of contact in the contact group
        ///</summary>
        [<ApiMember(DataType="List", Description="Details of contact in the contact group", Name="Contacts")>]
        member val Contacts:ResizeArray<ContactGroupConnectionModel> = null with get,set

        ///<summary>
        ///Details of projects for the contact group
        ///</summary>
        [<ApiMember(DataType="List", Description="Details of projects for the contact group", Name="Projects")>]
        member val Projects:ResizeArray<CustomerProjectModel> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ResizeArray<ResponseError> = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = null with get,set

    [<ApiResponse(Description="Get contact groups for current licensee")>]
    [<AllowNullLiteral>]
    type GetContactGroupsResponse() = 
        member val ContactGroups:ResizeArray<ContactGroupModel> = null with get,set
        ///<summary>
        ///Count of total groups.
        ///</summary>
        [<ApiMember(DataType="int", Description="Count of total groups.", Name="TotalGroups")>]
        member val TotalGroups:Int32 = new Int32() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get customers for current licensee
    ///</summary>
    [<Route("/contactgroups")>]
    [<Route("/contactgroups/{ContactId}")>]
    [<Api(Description="Get customers for current licensee")>]
    [<AllowNullLiteral>]
    type GetContactGroups() = 
        inherit PagedModel()
        interface IReturn<GetContactGroupsResponse>
        ///<summary>
        ///Get contactGroups for the specified contact
        ///</summary>
        [<ApiMember(Description="Get contactGroups for the specified contact", Name="ContactId")>]
        member val ContactId:Guid = new Guid() with get,set

        ///<summary>
        ///Specific search text to search for i.e. Contact Name, Employment Details etc.
        ///</summary>
        [<ApiMember(DataType="string", Description="Specific search text to search for i.e. Contact Name, Employment Details etc.", Name="SearchText")>]
        member val SearchText:String = null with get,set

        ///<summary>
        ///Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.
        ///</summary>
        [<ApiMember(Description="Set the Contact Group Role Id to only retrieve groups of that type. If ContactId is not set this is mandatory.", Name="ContactGroupRoleId")>]
        member val ContactGroupRoleId:Guid = new Guid() with get,set

        ///<summary>
        ///Include active contact groups
        ///</summary>
        [<ApiMember(Description="Include active contact groups", Name="IncludeActive")>]
        member val IncludeActive:Boolean = new Boolean() with get,set

        ///<summary>
        ///Include archived contact groups
        ///</summary>
        [<ApiMember(Description="Include archived contact groups", Name="IncludeArchived")>]
        member val IncludeArchived:Boolean = new Boolean() with get,set