@itwin/insights-client/lib/cjs/grouping-and-mapping/interfaces/IGroupsClient.d.ts

Insights client for the iTwin platform

import { AccessToken } from "@itwin/core-bentley";
import { Group, GroupCreate, GroupList, GroupMinimal, GroupMinimalList, GroupUpdate } from "./Groups";
import { EntityListIterator } from "../../common/iterators/EntityListIterator";
import { PreferReturn } from "../../common/Common";
export interface IGroupsClient {
    /**
      * Creates a Group for a Mapping.
      * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
      * @param {string} mappingId The Mapping Id.
      * @param {GroupCreate} group Request body.
      * @memberof GroupsClient
      * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/create-group/
      */
    createGroup(accessToken: AccessToken, mappingId: string, group: GroupCreate): Promise<Group>;
    /**
     * Deletes a Group for a Mapping.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param {string} groupId The Group Id.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/delete-group/
     */
    deleteGroup(accessToken: AccessToken, mappingId: string, groupId: string): Promise<Response>;
    /**
     * Updates a Group for a Mapping.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param {string} groupId The Group Id.
     * @param {GroupUpdate} group Request body.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/update-group/
     */
    updateGroup(accessToken: AccessToken, mappingId: string, groupId: string, group: GroupUpdate): Promise<Group>;
    /**
     * Gets a Group for a Mapping.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param {string} groupId The Group Id.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/get-group/
     */
    getGroup(accessToken: AccessToken, mappingId: string, groupId: string): Promise<Group>;
    /**
     * Gets all Groups for a Mapping. This method returns the full list of minimal groups.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param preferReturn Specifies the level of detail of the returned group information. Defaults to minimal information if not provided.
     * @param top Optional max items to be sent in response.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/get-groups/
     */
    getGroups(accessToken: AccessToken, mappingId: string, preferReturn?: PreferReturn.Minimal, top?: number): Promise<GroupMinimalList>;
    /**
       * Gets all Groups for a Mapping. This method returns the full list of Groups representations.
       * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
       * @param mappingId mappingId The Mapping Id.
       * @param preferReturn Specifies the level of detail of the returned group information. Defaults to minimal information if not provided.
       * @param top Optional max items to be sent in response.
       * @memberof GroupsClient
       * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/get-groups/
       */
    getGroups(accessToken: AccessToken, mappingId: string, preferReturn: PreferReturn.Representation, top?: number): Promise<GroupList>;
    /**
     * Gets an async paged iterator of minimal Groups for a Mapping.
     * This method returns an iterator which loads pages of groups as it is being iterated over.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param {number} top Optional max items to be sent in response.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/get-groups/
     */
    getGroupsIterator(accessToken: AccessToken, mappingId: string, preferReturn?: PreferReturn.Minimal, top?: number): EntityListIterator<GroupMinimal>;
    /**
     * Gets an async paged iterator of Groups representations for a Mapping.
     * This method returns an iterator which loads pages of groups as it is being iterated over.
     * @param {AccessToken} accessToken OAuth access token with scope `itwin-platform`.
     * @param {string} mappingId The Mapping Id.
     * @param {number} top Optional max items to be sent in response.
     * @memberof GroupsClient
     * @link https://developer.bentley.com/apis/grouping-and-mapping/operations/get-groups/
     */
    getGroupsIterator(accessToken: AccessToken, mappingId: string, preferReturn: PreferReturn.Representation, top?: number): EntityListIterator<Group>;
}
//# sourceMappingURL=IGroupsClient.d.ts.map