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

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: GetContactRoleGroups.*
//ExcludeTypes: 
//DefaultImports: 
*/


export interface IReturn<T>
{
    createResponse(): T;
}

export enum SortOrder
{
    Ascending = 'Ascending',
    Descending = 'Descending',
}

export class PagedModel
{
    /** @description Page Number to retrieve */
    // @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
    public PageNumber: number;

    /** @description Number of records to retrieve */
    // @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
    public PageSize: number;

    /** @description Index of field to sort results by */
    // @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
    public SortIndex: number;

    /** @description Sort Order - Ascending or Descending */
    // @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
    public SortOrder: SortOrder;

    public constructor(init?: Partial<PagedModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupRolesModel
{
    /** @description Role Id */
    // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
    public RoleId: string;

    /** @description Role Name */
    // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
    public RoleName: string;

    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
    public RoleGroupName: string;

    /** @description Role Group Role Id */
    // @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
    public RoleGroupRoleId: string;

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    public constructor(init?: Partial<RoleGroupRolesModel>) { (Object as any).assign(this, init); }
}

export class RoleGroupModel
{
    /** @description Role Group Id */
    // @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
    public RoleGroupId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
    public Name: string;

    /** @description Owner Contact Id */
    // @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
    public OwnerContactId: string;

    /** @description Number of Roles */
    // @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
    public NumberOfRoles: number;

    /** @description Roles belonging to the Role Group */
    // @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
    public Roles: RoleGroupRolesModel[];

    /** @description 'A' (Active), 'I' (Inactive) */
    // @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
    public RecordStatus: string;

    /** @description True if Licensee-owned, allowing editing, deleting, archiving */
    // @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
    public AllowEdit: boolean;

    public constructor(init?: Partial<RoleGroupModel>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public ErrorCode: string;

    // @DataMember(Order=2)
    public Message: string;

    // @DataMember(Order=3)
    public StackTrace: string;

    // @DataMember(Order=4)
    public Errors: ResponseError[];

    // @DataMember(Order=5)
    public Meta: { [index:string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="List of role groups")
export class GetContactRoleGroupsResponse
{
    public RoleGroups: RoleGroupModel[];
    public TotalRoleGroups: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetContactRoleGroupsResponse>) { (Object as any).assign(this, init); }
}

/** @description Get role groups for the given criteria */
// @Route("/contactrolegroups/{LicenseeId}")
// @Api(Description="Get role groups for the given criteria")
export class GetContactRoleGroups extends PagedModel implements IReturn<GetContactRoleGroupsResponse>
{
    /** @description Get contact role groups for the specified licensee */
    // @ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
    public LicenseeId: string;

    /** @description Role Group Name */
    // @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
    public Name: string;

    /** @description Active/Archived filter */
    // @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
    public RecordStatus: string;

    public constructor(init?: Partial<GetContactRoleGroups>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'GetContactRoleGroups'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new GetContactRoleGroupsResponse(); }
}