@craftercms/studio-ui/services/groups.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import PaginationOptions from '../models/PaginationOptions';
import { PagedArray } from '../models/PagedArray';
import { Observable } from 'rxjs';
import Group from '../models/Group';
import User from '../models/User';
export declare function fetchAll(
  options?: Partial<PaginationOptions> & {
    keyword?: string;
  }
): Observable<PagedArray<Group>>;
export declare function fetchUsersFromGroup(id: number, options?: PaginationOptions): Observable<PagedArray<User>>;
export declare function create(group: Partial<Group>): Observable<Group>;
export declare function update(group: Partial<Group>): Observable<Group>;
export declare function trash(groupId: number): Observable<true>;
export declare function addUserToGroup(groupId: number, username: string): Observable<User>;
export declare function addUsersToGroup(groupId: number, ids: number[]): Observable<User[]>;
export declare function addUsersToGroup(groupId: number, usernames: string[]): Observable<User[]>;
export declare function deleteUserFromGroup(groupId: number, username: string): Observable<true>;
export declare function deleteUserFromGroup(groupId: number, userId: number): Observable<true>;
export declare function deleteUsersFromGroup(groupId: number, userIds: number[]): Observable<true>;
export declare function deleteUsersFromGroup(groupId: number, usernames: string[]): Observable<true>;