@umbraco/playwright-testhelpers/dist/lib/helpers/UserGroupApiHelper.d.ts

Test helpers for making playwright tests for Umbraco solutions

import { ApiHelpers } from "./ApiHelpers";
export declare class UserGroupApiHelper {
    api: ApiHelpers;
    constructor(api: ApiHelpers);
    ensureNameNotExists(name: string): Promise<import("playwright-core").APIResponse | null>;
    doesExist(id: string): Promise<boolean>;
    create(userGroupData: any): Promise<string | undefined>;
    getByName(name: string): Promise<any>;
    get(id: string): Promise<any>;
    getAll(): Promise<any>;
    update(id: string, userGroup: any): Promise<string>;
    doesNameExist(name: string): Promise<boolean>;
    doesUserGroupContainLanguage(userGroupName: string, languageName: string): Promise<any>;
    doesUserGroupContainAccessToAllLanguages(userGroupName: string): Promise<any>;
    doesUserGroupContainDocumentRootAccess(userGroupName: string): Promise<any>;
    doesUserGroupContainMediaRootAccess(userGroupName: string): Promise<any>;
    delete(id: string): Promise<import("playwright-core").APIResponse>;
    createEmptyUserGroup(name: string): Promise<string | undefined>;
    createSimpleUserGroupWithContentSection(name: string): Promise<string | undefined>;
    createSimpleUserGroupWithMediaSection(name: string): Promise<string | undefined>;
    createUserGroupWithDocumentAccess(name: string): Promise<string | undefined>;
    createUserGroupWithDocumentStartNode(name: string, startNodeId: string): Promise<string | undefined>;
    createUserGroupWithMediaStartNode(name: string, startNodeId: string): Promise<string | undefined>;
    createUserGroupWithLanguage(name: string, languageName: string): Promise<string | undefined>;
    createUserGroupWithLanguageAndContentSection(name: string, languageName: string): Promise<string | undefined>;
    createUserGroupWithMemberSection(name: string): Promise<string | undefined>;
    createUserGroupWithPermissionsForSpecificDocumentWithRead(name: string, documentId: string): Promise<string | undefined>;
    createUserGroupWithReadPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCreateDocumentBlueprintPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithDeleteDocumentPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCreateDocumentPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithNotificationsPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithPublishPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithSetPermissionsPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithUnpublishPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithUpdatePermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithDuplicatePermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithMoveToPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithSortChildrenPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCultureAndHostnamesPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithPublicAccessPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithRollbackPermission(name: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithDeletePermissionAndCreatePermission(name: string, deleteEnabled?: boolean, createEnabled?: boolean): Promise<string | undefined>;
    doesUserGroupContainContentStartNodeId(userGroupName: string, documentStartNodeId: string): Promise<any>;
    doesUserGroupContainMediaStartNodeId(userGroupName: string, mediaStartNodeId: string): Promise<any>;
    doesUserGroupContainGranularPermissionsForDocument(userGroupName: string, documentId: string, granularPermissions: string[]): Promise<boolean>;
    doesUserGroupHaveFallbackPermissions(userGroupName: string, permissions: string[]): Promise<boolean>;
    convertApiPermissionsToUiPermissions(apiPermissions: string[]): Promise<any[]>;
    convertApiSectionsToUiSections(apiSections: string[]): Promise<any[]>;
    doesUserGroupHaveSections(userGroupName: string, sections: string[]): Promise<boolean>;
    createUserGroupWithReadPermissionAndReadPropertyValuePermission(name: string, readEnabled?: boolean, readPropertyValueEnabled?: boolean): Promise<string | undefined>;
    createUserGroupWithUpdatePermissionAndWritePropertyValuePermission(name: string, updateEnabled?: boolean, writePropertyValueEnabled?: boolean, readPropertyValueEnabled?: boolean): Promise<string | undefined>;
    createUserGroupWithPermissionsForSpecificDocumentAndTwoPropertyValues(name: string, documentId: string, documentTypeId: string, firstPropertyValueName: string, readFirstPropertyValueEnabled: boolean | undefined, writeFirstPropertyValueEnabled: boolean | undefined, secondPropertyValueName: string, readSecondPropertyValueEnabled?: boolean, writeSecondPropertyValueEnabled?: boolean): Promise<string | undefined>;
    createUserGroupWithReadPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCreateDocumentBlueprintPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithDeletePermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCreatePermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithNotificationsPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithPublishPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithSetPermissionsPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithUnpublishPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithUpdatePermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithDuplicatePermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithMoveToPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithSortChildrenPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCultureAndHostnamesPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithPublicAccessPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithRollbackPermissionForSpecificDocument(name: string, documentId: string, enabled?: boolean): Promise<string | undefined>;
    createUserGroupWithCreateAndUpdateDocumentPermission(name: string, enabled?: boolean): Promise<string | undefined>;
}