import { APIResource } from "../../core/resource.js"; import * as BusinessPartnersAPI from "../business-partners.js"; import * as ExclusionMembersAPI from "./exclusion-members.js"; import { ExclusionMemberListParams, ExclusionMemberUpdateParams, ExclusionMemberUpdateResponse, ExclusionMembers } from "./exclusion-members.js"; import * as InclusionMembersAPI from "./inclusion-members.js"; import { InclusionMemberListParams, InclusionMemberUpdateParams, InclusionMemberUpdateResponse, InclusionMembers } from "./inclusion-members.js"; import * as MembersAPI from "./members.js"; import { MemberListParams, Members } from "./members.js"; import { APIPromise } from "../../core/api-promise.js"; import { PageCursorURL, PagePromise } from "../../core/pagination.js"; import { RequestOptions } from "../../internal/request-options.js"; /** * Supergroups used by the company */ export declare class Supergroups extends APIResource { members: MembersAPI.Members; inclusionMembers: InclusionMembersAPI.InclusionMembers; exclusionMembers: ExclusionMembersAPI.ExclusionMembers; /** * Retrieve supergroups matching the input parameters. * * - Requires: `API Tier 1` * - Filterable fields: `app_owner_id`, `group_type` * - Sortable fields: `id`, `created_at`, `updated_at` */ list(query?: SupergroupListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a specific supergroup. */ retrieve(id: string, options?: RequestOptions): APIPromise; } export type SupergroupsPageCursorURL = PageCursorURL; export interface Supergroup { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Whether the group allows non employees */ allow_non_employees?: boolean; /** * The id of the group's app owner. */ app_owner_id?: string; /** * Whether the group can override role states */ can_override_role_states?: boolean; /** * Whether the group is the cumulatively exhaustive default */ cumulatively_exhaustive_default?: boolean; /** * The group's description. */ description?: string; /** * The group's display name. */ display_name?: string; /** * The group type */ group_type?: string; /** * Whether to ignore provisioning group matching when determining group membership */ ignore_prov_group_matching?: boolean; /** * Whether the group include terminated roles */ include_terminated?: boolean; /** * Whether the group is invisible */ is_invisible?: boolean; /** * The group's mutually exclusive key */ mutually_exclusive_key?: string; /** * The group's name. */ name?: string; /** * The group's parent. */ parent?: string; /** * The group's priority when calculating mutual exclusivity */ priority?: number; /** * Whether the group is read only. */ read_only?: boolean; /** * The sub group type */ sub_group_type?: string; } /** * Meta information for the response. */ export interface SupergroupRetrieveResponse extends BusinessPartnersAPI.Meta, Supergroup { } export interface SupergroupListParams { filter?: string; order_by?: string; } export declare namespace Supergroups { export { type Supergroup as Supergroup, type SupergroupRetrieveResponse as SupergroupRetrieveResponse, type SupergroupsPageCursorURL as SupergroupsPageCursorURL, type SupergroupListParams as SupergroupListParams, }; export { Members as Members, type MemberListParams as MemberListParams }; export { InclusionMembers as InclusionMembers, type InclusionMemberUpdateResponse as InclusionMemberUpdateResponse, type InclusionMemberListParams as InclusionMemberListParams, type InclusionMemberUpdateParams as InclusionMemberUpdateParams, }; export { ExclusionMembers as ExclusionMembers, type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse, type ExclusionMemberListParams as ExclusionMemberListParams, type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams, }; } //# sourceMappingURL=supergroups.d.ts.map