@bitmovin/api-sdk/dist/account/organizations/groups/GroupsApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import TenantsApi from './tenants/TenantsApi';
import InvitationsApi from './invitations/InvitationsApi';
import PermissionsApi from './permissions/PermissionsApi';
import BitmovinResponse from '../../../models/BitmovinResponse';
import Group from '../../../models/Group';
import PaginationResponse from '../../../models/PaginationResponse';
import { GroupListQueryParams, GroupListQueryParamsBuilder } from './GroupListQueryParams';
/**
 * GroupsApi - object-oriented interface
 * @export
 * @class GroupsApi
 * @extends {BaseAPI}
 */
export default class GroupsApi extends BaseAPI {
    tenants: TenantsApi;
    invitations: InvitationsApi;
    permissions: PermissionsApi;
    constructor(configuration: Configuration);
    /**
     * @summary Add Group
     * @param {string} organizationId Id of the organization
     * @param {Group} group Tenant Group details
     * @throws {BitmovinError}
     * @memberof GroupsApi
     */
    create(organizationId: string, group?: Group): Promise<Group>;
    /**
     * @summary Delete Group
     * @param {string} organizationId Id of the organization
     * @param {string} groupId Id of the group
     * @throws {BitmovinError}
     * @memberof GroupsApi
     */
    delete(organizationId: string, groupId: string): Promise<BitmovinResponse>;
    /**
     * @summary Group Details
     * @param {string} organizationId Id of the organization
     * @param {string} groupId Id of the group.
     * @throws {BitmovinError}
     * @memberof GroupsApi
     */
    get(organizationId: string, groupId: string): Promise<Group>;
    /**
     * @summary List Groups
     * @param {string} organizationId Id of the organization
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof GroupsApi
     */
    list(organizationId: string, queryParameters?: GroupListQueryParams | ((q: GroupListQueryParamsBuilder) => GroupListQueryParamsBuilder)): Promise<PaginationResponse<Group>>;
}