@atlaskit/teams-client 4.0.0

package/report.api.md

@@ -0,0 +1,1210 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/teams-client"
+
+> Do not edit this file. This report is auto-generated using
+> [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { captureException } from '@sentry/browser';
+import type { captureMessage } from '@sentry/browser';
+import type { init } from '@sentry/browser';
+import type { Integrations } from '@sentry/browser';
+import type { Scope } from '@sentry/browser';
+
+// @public (undocumented)
+type AccessMode = 'DIRECT_ACCESS' | 'REQUEST_ACCESS';
+
+// @public (undocumented)
+type AccessRequestBulk = {
+	resources: Resource[];
+	note?: string;
+	accessMode?: AccessMode;
+	source?: string;
+};
+
+// @public (undocumented)
+type AccessRequestBulkSimplified = Omit<AccessRequestBulk, 'resources'> & {
+	productAris: ProductARI[];
+};
+
+// @public (undocumented)
+type AccessRequestCapability =
+	| 'ACCESS_EXISTS'
+	| 'ACCESS_GRANTED'
+	| 'APPROVED_REQUEST_EXISTS'
+	| 'DENIED_REQUEST_EXISTS'
+	| 'DIRECT_ACCESS'
+	| 'ERROR'
+	| 'FORBIDDEN'
+	| 'PENDING_REQUEST_CREATED'
+	| 'PENDING_REQUEST_EXISTS'
+	| 'REQUEST_ACCESS'
+	| 'VERIFICATION_REQUIRED';
+
+// @public (undocumented)
+type AccessRequestCapabilityWithRole = {
+	accessMode: AccessRequestCapability;
+	role: Role;
+};
+
+// @public (undocumented)
+type AccessResourceResponse = {
+	ari: ProductARI;
+	result: AccessRequestCapability;
+	resultsV2: {
+		[K in ProductARI]: AccessRequestCapabilityWithRole[];
+	};
+	errorReason?: ErrorResponse;
+};
+
+// @public (undocumented)
+type AccessResourcesResponse = AccessResourceResponse[];
+
+// @public @deprecated (undocumented)
+interface AddMembershipReponse {
+	// (undocumented)
+	errors: {
+		accountId: string;
+		code: string;
+		message: string;
+	}[];
+	// (undocumented)
+	members: Member[];
+}
+
+// @public (undocumented)
+type AGGPageInfo = {
+	endCursor: null | string;
+	hasNextPage: boolean;
+};
+
+// @public (undocumented)
+type AGGPageInfoVariables = {
+	first: number;
+	after?: string;
+};
+
+// @public (undocumented)
+export const AllTeamActions: readonly [
+	'ADD_MEMBER_TO_TEAM',
+	'JOIN_TEAM',
+	'REQUEST_TO_JOIN',
+	'CANCEL_JOIN_REQUEST',
+	'APPROVE_JOIN_REQUEST',
+	'REJECT_JOIN_REQUEST',
+	'REMOVE_MEMBER_FROM_TEAM',
+	'CANCEL_INVITE',
+	'LEAVE_TEAM',
+	'EDIT_TEAM_NAME',
+	'EDIT_DESCRIPTION',
+	'EDIT_PROFILE_HEADER',
+	'EDIT_TEAM_LINK',
+	'DELETE_TEAM',
+];
+
+// @public
+export interface AllTeamsQuery {
+	// (undocumented)
+	cursor?: string;
+	// (undocumented)
+	limit?: number;
+	// (undocumented)
+	memberAccountIds?: string[];
+	// @deprecated (undocumented)
+	orgId: string;
+	// (undocumented)
+	searchQuery?: string;
+	// (undocumented)
+	useDefaultSort?: boolean;
+}
+
+// @public
+interface AllTeamsResponse {
+	// (undocumented)
+	cursor: string;
+	// (undocumented)
+	error?: Error;
+	// (undocumented)
+	teams: TeamWithMemberships[];
+}
+
+// @public (undocumented)
+class AtlasClient extends BaseGraphQlClient {
+	constructor(baseUrl: string, config: ClientConfig);
+	queryTeamHealthMonitors(teamId: string): Promise<TeamHealthMonitor[]>;
+	// (undocumented)
+	setBaseUrl(baseUrl: string): void;
+}
+
+// @public (undocumented)
+const atlasClient: AtlasClient;
+
+// @public
+type AwaitedReturn<T extends (...args: any) => any> = Awaited<ReturnType<T>>;
+
+// @public (undocumented)
+class BaseClient {
+	constructor(config: ClientConfig);
+	// (undocumented)
+	getCloudId(localValue?: string): string;
+	// (undocumented)
+	getContext(): ClientContext;
+	// (undocumented)
+	getOrgId(localValue?: string): string;
+	// (undocumented)
+	logException: (
+		ex: Error | unknown,
+		name: string,
+		context?: NestedContext & {
+			tags?: Record<string, string>;
+		},
+	) => void;
+	// (undocumented)
+	setContext(context: ClientContextProps): void;
+}
+
+// @public (undocumented)
+class BaseGraphQlClient extends BaseClient {
+	constructor(serviceUrl: string, config: ClientConfig);
+	// (undocumented)
+	makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(
+		body: Body_2<Variables>,
+		options?: Options,
+	): Promise<ResultResponse<Key, Data>>;
+	// (undocumented)
+	setServiceUrl(serviceUrl: string): void;
+}
+
+// @public (undocumented)
+type Body_2<Variables> = {
+	query: string;
+	variables?: Variables;
+};
+
+// @public (undocumented)
+const BROWSE_USER_SETTINGS_KEY = 'internal.browse-users-allowed';
+
+// @public (undocumented)
+type Capability = 'DIRECT_ACCESS' | 'REQUEST_ACCESS';
+
+// @public (undocumented)
+type ClientConfig = {
+	logException: LogExceptionFN;
+};
+
+// @public (undocumented)
+type ClientContext = {
+	cloudId: string;
+	orgId?: string;
+};
+
+// @public (undocumented)
+type ClientContextProps = {
+	cloudId?: null | string;
+	orgId?: string;
+};
+
+// @public
+interface CloudUser {
+	// (undocumented)
+	avatarUrl: string;
+	// (undocumented)
+	fullName: string;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	title?: string;
+}
+
+// @public (undocumented)
+class CommonError extends Error {
+	constructor(message?: string);
+	// (undocumented)
+	message: string;
+	// (undocumented)
+	name: string;
+	// (undocumented)
+	stack: string;
+}
+
+// @public (undocumented)
+type Context = any & {
+	tags?: SentryTags;
+	packageName?: string;
+	packageVersion?: string;
+};
+
+// @public (undocumented)
+const _default: MutabilityClient;
+
+// @public
+const _default_2: PermsClient;
+
+// @public (undocumented)
+const _default_3: PublicApiClient;
+
+// @public (undocumented)
+const _default_4: InvitationsClient;
+
+// @public (undocumented)
+const defaultLegionClient: LegionClient;
+
+// @public @deprecated (undocumented)
+type DeprecatedTeamState = 'DISBANDED';
+
+// @public @deprecated (undocumented)
+type DeprecratedMembershipState = 'INVITED';
+
+// @public (undocumented)
+class DirectoryClient extends BaseGraphQlClient {
+	constructor(baseUrl: string, config: ClientConfig);
+	// (undocumented)
+	queryFeatureFlags(cloudId: string | undefined, flags: string[]): Promise<Record<string, boolean>>;
+	// (undocumented)
+	querySettings(
+		cloudId?: string,
+		product?: string,
+	): Promise<{
+		[BROWSE_USER_SETTINGS_KEY]: boolean;
+	}>;
+	// @deprecated
+	queryTeamMemberships(teamId: string, membershipStatus?: string[]): Promise<TeamMembership[]>;
+	queryUser(
+		userId: string,
+		cloudId?: string,
+	): Promise<{
+		CloudUser: CloudUser;
+	}>;
+	// (undocumented)
+	setBaseUrl(baseUrl: string): void;
+}
+
+// @public (undocumented)
+const directoryClient: DirectoryClient;
+
+// @public (undocumented)
+type ErrorResponse = {
+	message: string;
+	responseStatus: StatusCode;
+};
+
+// @public (undocumented)
+interface FetchOptions {
+	// (undocumented)
+	body?: any;
+	// (undocumented)
+	headers?: {
+		[key: string]: string;
+	};
+	// (undocumented)
+	ignoreResponse?: boolean;
+	// (undocumented)
+	method?: string;
+	// (undocumented)
+	shouldLogError?: (e: HttpError) => boolean;
+}
+
+// @public (undocumented)
+export function hasPermission(
+	action: TeamAction,
+	settings: TeamMembershipSettings,
+	permission: TeamPermission | undefined,
+	isPeopleBrowseEnabled: boolean,
+	currentUserMembership: TeamMembership | undefined,
+): boolean;
+
+// @public (undocumented)
+export class HttpError extends CommonError {
+	constructor({ message, status, traceId }: HttpErrorArguments);
+	// (undocumented)
+	status: number;
+	// (undocumented)
+	traceId?: string;
+}
+
+// @public (undocumented)
+interface HttpErrorArguments {
+	// (undocumented)
+	message: string;
+	// (undocumented)
+	status: number;
+	// (undocumented)
+	traceId?: string;
+}
+
+// @public (undocumented)
+export function initialiseSentry(client: SentryClient, options: SentryInstallConfig): Promise<void>;
+
+// @public (undocumented)
+class InvitationsClient extends RestClient {
+	constructor(serviceUrl: string, config: ClientConfig);
+	// (undocumented)
+	getProductRecommendations(
+		supportedProducts?: Product[],
+		capabilities?: Capability[],
+	): Promise<RecommendationsResponse>;
+	// (undocumented)
+	joinOrRequestDefaultAccessToProductsBulk(
+		simplifiedRequest: AccessRequestBulkSimplified,
+	): Promise<AccessResourcesResponse>;
+}
+
+// @public (undocumented)
+interface InvitedUser {
+	// (undocumented)
+	email: null | string;
+	// (undocumented)
+	id: null | string;
+}
+
+// @public (undocumented)
+export function isInvited(member?: TeamMembership): member is TeamMembership & boolean;
+
+// @public (undocumented)
+export const isMember: (member?: TeamMembership) => boolean;
+
+// @public (undocumented)
+export const isNonMember: (member?: TeamMembership) => boolean;
+
+// @public (undocumented)
+export const isRequestingJoin: (member?: TeamMembership) => boolean;
+
+// @public (undocumented)
+export function isTeamMembershipWithUser(
+	membership: TeamMembership,
+): membership is Required<TeamMembership>;
+
+// @public (undocumented)
+interface LegionClient {
+	// (undocumented)
+	acceptJoinRequest(teamId: string, memberId: string): Promise<TeamMembership>;
+	// (undocumented)
+	acceptTeamInvitation(teamId: string): Promise<TeamMembership>;
+	// (undocumented)
+	cancelJoinRequest(teamId: string): Promise<void>;
+	// (undocumented)
+	createTeam(
+		displayName: string,
+		originQuery: OriginQuery,
+		members?: string[],
+		membershipSettings?: TeamMembershipSettings,
+	): Promise<Team>;
+	// (undocumented)
+	createTeamLink(teamId: string, link: NewTeamLink): Promise<TeamLink>;
+	// (undocumented)
+	declineJoinRequest(teamId: string, memberId: string): Promise<void>;
+	// (undocumented)
+	declineTeamInvitation(teamId: string): Promise<void>;
+	// (undocumented)
+	deleteTeam(teamId: string): Promise<void>;
+	// (undocumented)
+	deleteTeamLink(teamId: string, linkId: string): Promise<void>;
+	// (undocumented)
+	deleteTeamMembership(teamId: string, memberId: string): Promise<TeamMembership>;
+	// (undocumented)
+	getAllTeams(allTeamsQuery: AllTeamsQuery): Promise<AllTeamsResponse>;
+	// (undocumented)
+	getMyTeamMembership(teamId: string): Promise<TeamMembership>;
+	// (undocumented)
+	getTeamById(teamId: string): Promise<TeamWithImageUrls>;
+	// (undocumented)
+	getTeamLinksByTeamId(teamId: string): Promise<{
+		entities: TeamLink[];
+	}>;
+	// (undocumented)
+	inviteUsersToTeam(
+		teamId: string,
+		users: InvitedUser[],
+		originQuery: OriginQuery,
+	): Promise<TeamMembership[]>;
+	// (undocumented)
+	isSingleFullMemberTeam(teamId: string): Promise<boolean>;
+	// (undocumented)
+	reorderTeamLink(teamId: string, linkId: string, newPosition: number): Promise<LinkOrder>;
+	// (undocumented)
+	revokeTeamInvite(teamId: string, memberId: string): Promise<TeamMembership>;
+	// (undocumented)
+	selfJoinTeam(teamId: string, originQuery: OriginQuery): Promise<TeamMembership>;
+	// (undocumented)
+	updateTeamById(teamId: string, data: Partial<Team>): Promise<TeamWithImageUrls>;
+	// (undocumented)
+	updateTeamLink(teamId: string, linkId: string, newLink: NewTeamLink): Promise<TeamLink>;
+}
+
+// @public
+class LegionClient extends RestClient implements LegionClient {
+	constructor(serviceUrlRoot: string);
+	// (undocumented)
+	mapLegionTeamLinkResponseV3ToTeamLink(legionLinkResponseV3: LegionLinkResponseV3): TeamLink;
+	// (undocumented)
+	mapLegionTeamLinkResponseV4ToTeamLink(legionLinkResponseV4: LegionLinkResponseV4): TeamLink;
+	// (undocumented)
+	mapLegionTeamLinksResponseV3ToTeamLinkResponse(
+		response: LegionPaginatedResponse<LegionLinkResponseV3>,
+	): {
+		entities: TeamLink[];
+	};
+	// (undocumented)
+	mapLegionTeamLinksResponseV4ToTeamLinkResponse(
+		response: LegionPaginatedResponse<LegionLinkResponseV4>,
+	): {
+		entities: TeamLink[];
+	};
+	// (undocumented)
+	setRootUrl(url: string): void;
+	// (undocumented)
+	trimTeamARI(teamId?: string): string;
+}
+
+// @public (undocumented)
+interface LegionLinkResponseV3 {
+	// (undocumented)
+	contentTitle: string;
+	// (undocumented)
+	creationTime?: string;
+	// (undocumented)
+	description: string;
+	// (undocumented)
+	linkId: string;
+	// (undocumented)
+	linkUri: string;
+	// (undocumented)
+	teamId?: string;
+}
+
+// @public (undocumented)
+interface LegionLinkResponseV4 {
+	// (undocumented)
+	contentTitle: string;
+	// (undocumented)
+	description: string;
+	// (undocumented)
+	linkId: string;
+	// (undocumented)
+	linkUri: string;
+	// (undocumented)
+	teamId?: string;
+}
+
+// @public (undocumented)
+interface LegionPaginatedResponse<T> {
+	// (undocumented)
+	cursor: string;
+	// (undocumented)
+	entities: T[];
+}
+
+// @public
+const LINK_FIELDS: {
+	CONTENT_TITLE: 'contentTitle';
+	DESCRIPTION: 'description';
+	LINK_URI: 'linkUri';
+};
+
+// @public
+type LinkOrder = {
+	teamId: string;
+	linkOrder: string[];
+};
+
+// @public (undocumented)
+export function logException(ex: Error | unknown, name: string, context?: Context): Promise<void>;
+
+// @public (undocumented)
+type LogExceptionFN = (
+	ex: Error | unknown,
+	name: string,
+	context?: NestedContext & {
+		tags?: Record<string, string>;
+	},
+) => void;
+
+// @public (undocumented)
+export function logInfoMessage(message: string, context?: Context): void;
+
+// @public @deprecated (undocumented)
+interface Member {
+	// (undocumented)
+	accountId: string;
+}
+
+// @public (undocumented)
+type MembershipRole = 'ADMIN' | 'REGULAR';
+
+// @public (undocumented)
+type MembershipState = 'ALUMNI' | 'FULL_MEMBER' | 'REQUESTING_TO_JOIN' | DeprecratedMembershipState;
+
+// @public (undocumented)
+class MutabilityClient extends RestClient {
+	constructor(config?: {});
+	// (undocumented)
+	getProfileWithMutability(userId: string): Promise<MutabilityConstraint[]>;
+}
+
+// @public (undocumented)
+interface MutabilityConstraint {
+	// (undocumented)
+	field: string;
+	// (undocumented)
+	reason: Reason;
+}
+
+// @public (undocumented)
+type NestedContext = {
+	[key: string]: NestedContext | boolean | number | string;
+};
+
+// @public
+type NewTeamLink = Omit<TeamLink, 'linkId'>;
+
+// @public (undocumented)
+interface Options {
+	// (undocumented)
+	errorPolicy?: 'all' | 'ignore' | 'none';
+	// (undocumented)
+	operationName?: string;
+}
+
+// @public (undocumented)
+export interface OriginQuery {
+	// @deprecated (undocumented)
+	cloudId?: string;
+	// (undocumented)
+	product?: null | string;
+}
+
+// @public (undocumented)
+class PermsClient extends RestClient {
+	// (undocumented)
+	getIsSiteAdmin(cloudId?: string): Promise<boolean>;
+}
+
+// @public
+type Product =
+	| 'avocado'
+	| 'avp'
+	| 'beacon'
+	| 'compass'
+	| 'confluence'
+	| 'jira'
+	| 'jira-core'
+	| 'jira-incident-manager'
+	| 'jira-product-discovery'
+	| 'jira-servicedesk'
+	| 'jira-software'
+	| 'mercury'
+	| 'opsgenie'
+	| 'statuspage'
+	| 'townsquare';
+
+// @public (undocumented)
+type ProductARI = string;
+
+// @public (undocumented)
+interface PublicApiClient {
+	// (undocumented)
+	addUsersToTeam(teamId: string, members: Member[]): Promise<AddMembershipReponse>;
+	// (undocumented)
+	removeTeamMemberships(teamId: string, members: Member[]): Promise<RemoveMembershipReponse>;
+}
+
+// @public (undocumented)
+class PublicApiClient extends RestClient implements PublicApiClient {
+	constructor(serviceUrlRoot: string);
+	// (undocumented)
+	getTeamDetails(teamId: string): Promise<PublicApiTeamResponse>;
+	// (undocumented)
+	getTeamMembers(
+		teamId: string,
+		first?: number,
+		after?: string,
+	): Promise<PublicApiTeamResponseWithMembers>;
+}
+
+// @public (undocumented)
+interface PublicApiMembership {
+	// (undocumented)
+	accountId?: string;
+}
+
+// @public (undocumented)
+interface PublicApiTeamResponse {
+	// (undocumented)
+	description?: string;
+	// (undocumented)
+	displayName?: string;
+	// (undocumented)
+	organizationId?: string;
+	// (undocumented)
+	teamId?: string;
+	// (undocumented)
+	teamType?: 'MEMBER_INVITE' | 'OPEN';
+	// (undocumented)
+	userPermissions?: PublicApiUserPermissions;
+}
+
+// @public (undocumented)
+interface PublicApiTeamResponseWithMembers {
+	// (undocumented)
+	description?: string;
+	// (undocumented)
+	displayName?: string;
+	members?: PublicApiMembership[];
+	// (undocumented)
+	organizationId?: string;
+	// (undocumented)
+	teamId?: string;
+	// (undocumented)
+	teamType?: 'MEMBER_INVITE' | 'OPEN';
+	// (undocumented)
+	userPermissions?: PublicApiUserPermissions;
+}
+
+// @public (undocumented)
+interface PublicApiUserPermissions {
+	// (undocumented)
+	ADD_MEMBERS?: boolean;
+	// (undocumented)
+	DELETE_TEAM?: boolean;
+	// (undocumented)
+	REMOVE_MEMBERS?: boolean;
+	// (undocumented)
+	UPDATE_TEAM?: boolean;
+}
+
+// @public (undocumented)
+type Reason = 'ext.dir.google' | 'ext.dir.scim' | 'managed';
+
+// @public (undocumented)
+type Recommendation = {
+	resourceId: ProductARI;
+	userAccessLevel: UserAccessLevel;
+	mode?: RecommendationMode;
+	roleAri: RoleARI;
+	url: string;
+	displayName?: string;
+	avatarUrl?: string;
+};
+
+// @public (undocumented)
+type RecommendationMode = 'DOMAIN' | 'OPEN';
+
+// @public (undocumented)
+type RecommendationsResponse = {
+	capability: {
+		[K in Capability]: Recommendation[];
+	};
+};
+
+// @public @deprecated (undocumented)
+interface RemoveMembershipReponse {
+	// (undocumented)
+	errors: {
+		accountId: string;
+		code: string;
+		message: string;
+	}[];
+}
+
+// @public (undocumented)
+type Resource = {
+	ari: ProductARI;
+	continueUrl?: string;
+	role: Role;
+};
+
+// @public (undocumented)
+class RestClient extends BaseClient {
+	constructor({ serviceUrl, config }: { serviceUrl: string; config?: ClientConfig });
+	// (undocumented)
+	deleteResource<T>(path: string, options?: FetchOptions): Promise<T>;
+	// (undocumented)
+	getResource<T>(path: string, fetchOptions?: Omit<FetchOptions, 'body' | 'method'>): Promise<T>;
+	// (undocumented)
+	makeRequest<T>(path: string, additionalFetchOptions?: FetchOptions): Promise<T>;
+	// (undocumented)
+	patchResource<T>(path: string, data?: Record<string, unknown>): Promise<T>;
+	// (undocumented)
+	postResource<T>(
+		path: string,
+		data?: Record<string, unknown>,
+		fetchOptions?: FetchOptions,
+	): Promise<T>;
+	// (undocumented)
+	postResourceRaw<T>(path: string, data?: string, fetchOptions?: FetchOptions): Promise<T>;
+	preventInfiniteRedirectLoop: (response: Response) => void;
+	// (undocumented)
+	putResource<T>(
+		path: string,
+		data?: Record<string, unknown>,
+		additionalFetchOptions?: FetchOptions,
+	): Promise<T>;
+	// (undocumented)
+	serviceUrl: string;
+	// (undocumented)
+	setServiceUrl(serviceUrl: string): void;
+}
+
+// @public (undocumented)
+type ResultResponse<Key extends string, Data> = {
+	[name in Key]: Data;
+};
+
+// @public (undocumented)
+type ResultWithPageInfo<T> = {
+	edges: T[];
+	pageInfo: AGGPageInfo;
+};
+
+// @public (undocumented)
+type Role =
+	| 'org/admin'
+	| 'product/external-collaborator-writer'
+	| 'product/helpseeker'
+	| 'product/member';
+
+// @public (undocumented)
+type RoleARI = string;
+
+// @public (undocumented)
+type ScopeMode = 'ORG_SCOPE_MODE' | 'SITE_SCOPE_MODE';
+
+// @public (undocumented)
+export interface SentryClient {
+	// (undocumented)
+	captureException: typeof captureException;
+	// (undocumented)
+	captureMessage: typeof captureMessage;
+	// (undocumented)
+	init: typeof init;
+	// (undocumented)
+	Integrations: typeof Integrations;
+	// (undocumented)
+	withScope(callback: (scope: Scope) => void): void;
+}
+
+// @public (undocumented)
+interface SentryInstallConfig {
+	// (undocumented)
+	attachStacktrace?: boolean;
+	// (undocumented)
+	dsn?: string;
+	// (undocumented)
+	env?: string;
+	// (undocumented)
+	initialScope?: {
+		tags?: SentryTags;
+	};
+	// (undocumented)
+	noGlobals?: boolean;
+	// @deprecated (undocumented)
+	tags?: SentryTags;
+	// (undocumented)
+	version?: string;
+}
+
+// @public (undocumented)
+interface SentryTags {
+	// (undocumented)
+	[key: string]: string;
+}
+
+// @public (undocumented)
+export const sortMembersByType: (
+	members: TeamMembership[],
+	currentAccountId?: string,
+) => TeamMembership[];
+
+// @public (undocumented)
+type StatusCode = string;
+
+// @public
+interface Team {
+	// @deprecated (undocumented)
+	creatorDomain?: string;
+	// (undocumented)
+	creatorId?: string;
+	// (undocumented)
+	description: string;
+	// @deprecated (undocumented)
+	discoverable?: TeamDiscoverability;
+	// (undocumented)
+	displayName: string;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	memberIds?: string[];
+	// (undocumented)
+	membership?: {
+		members?: TeamMembership[];
+		errors?: string[];
+	};
+	// (undocumented)
+	membershipSettings: TeamMembershipSettings;
+	// (undocumented)
+	organizationId?: string;
+	// @deprecated (undocumented)
+	orgId?: string;
+	// (undocumented)
+	permission?: TeamPermission;
+	// @deprecated (undocumented)
+	restriction: TeamRestriction;
+	// (undocumented)
+	scopeMode?: ScopeMode;
+	// (undocumented)
+	state: TeamState;
+}
+
+// @public (undocumented)
+const TEAM_ARI_PREFIX: 'ari:cloud:identity::team/';
+
+// @public (undocumented)
+export type TeamAction = (typeof AllTeamActions)[number];
+
+// @public (undocumented)
+type TeamARI = `${typeof TEAM_ARI_PREFIX}${string}`;
+
+// @public (undocumented)
+interface TeamAvatarImage {
+	// (undocumented)
+	largeAvatarImageUrl: string;
+	// (undocumented)
+	largeHeaderImageUrl: string;
+	// (undocumented)
+	smallAvatarImageUrl: string;
+	// (undocumented)
+	smallHeaderImageUrl: string;
+}
+
+// @public (undocumented)
+type TeamDiscoverability = 'DISCOVERABLE';
+
+// @public (undocumented)
+interface TeamHealthMonitor {
+	// (undocumented)
+	date: string;
+	// (undocumented)
+	greenCount?: number;
+	// (undocumented)
+	redCount?: number;
+	// (undocumented)
+	uuid: string;
+	// (undocumented)
+	yellowCount?: number;
+}
+
+// @public (undocumented)
+interface TeamLink {
+	// (undocumented)
+	[LINK_FIELDS.CONTENT_TITLE]: string;
+	// @deprecated (undocumented)
+	creationTime?: string;
+	// (undocumented)
+	[LINK_FIELDS.DESCRIPTION]: string;
+	// (undocumented)
+	linkId: string;
+	// (undocumented)
+	[LINK_FIELDS.LINK_URI]: string;
+	// (undocumented)
+	teamId?: string;
+}
+
+// @public (undocumented)
+type TeamMember = Pick<TeamsClientUser, 'avatarUrl' | 'fullName' | 'id' | 'status'>;
+
+// @public (undocumented)
+interface TeamMembership {
+	// (undocumented)
+	membershipId: {
+		teamId: string;
+		memberId: string;
+	};
+	// (undocumented)
+	role: MembershipRole;
+	// (undocumented)
+	state: MembershipState;
+	// (undocumented)
+	user?: TeamsClientUser;
+}
+
+// @public (undocumented)
+type TeamMembershipSettings = 'MEMBER_INVITE' | 'OPEN';
+
+// @public (undocumented)
+type TeamPermission = 'FULL_READ' | 'FULL_WRITE' | 'NONE';
+
+// @public (undocumented)
+type TeamRestriction = 'NO_RESTRICTION' | 'ORG_MEMBERS';
+
+// @public
+export class TeamsClient {
+	constructor(context?: ClientContextProps);
+	acceptJoinRequest(
+		...args: Parameters<typeof defaultLegionClient.acceptJoinRequest>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.acceptJoinRequest>>;
+	// @deprecated (undocumented)
+	acceptTeamInvitation(
+		...args: Parameters<typeof defaultLegionClient.acceptTeamInvitation>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.acceptTeamInvitation>>;
+	addUsersToTeam(
+		...args: Parameters<typeof _default_3.addUsersToTeam>
+	): Promise<AwaitedReturn<typeof _default_3.addUsersToTeam>>;
+	cancelJoinRequest(teamId: string): Promise<void>;
+	createTeam(
+		...args: Parameters<typeof defaultLegionClient.createTeam>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.createTeam>>;
+	createTeamLink(
+		...args: Parameters<typeof defaultLegionClient.createTeamLink>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.createTeamLink>>;
+	declineJoinRequest(
+		...args: Parameters<typeof defaultLegionClient.declineJoinRequest>
+	): Promise<void>;
+	// @deprecated (undocumented)
+	declineTeamInvitation(
+		...args: Parameters<typeof defaultLegionClient.declineTeamInvitation>
+	): Promise<void>;
+	deleteTeam(teamId: string): Promise<void>;
+	deleteTeamLink(...args: Parameters<typeof defaultLegionClient.deleteTeamLink>): Promise<void>;
+	// @deprecated (undocumented)
+	deleteTeamMembership(
+		...args: Parameters<typeof defaultLegionClient.deleteTeamMembership>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.deleteTeamMembership>>;
+	getAllTeams(
+		...args: Parameters<typeof defaultLegionClient.getAllTeams>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.getAllTeams>>;
+	getIsSiteAdmin(
+		...args: Parameters<typeof _default_2.getIsSiteAdmin>
+	): Promise<AwaitedReturn<typeof _default_2.getIsSiteAdmin>>;
+	getMyTeamMembership(
+		...args: Parameters<typeof defaultLegionClient.getMyTeamMembership>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.getMyTeamMembership>>;
+	getProfileWithMutability(
+		...args: Parameters<typeof _default.getProfileWithMutability>
+	): Promise<AwaitedReturn<typeof _default.getProfileWithMutability>>;
+	// (undocumented)
+	getRecommendedProducts(
+		...args: Parameters<typeof _default_4.getProductRecommendations>
+	): Promise<AwaitedReturn<typeof _default_4.getProductRecommendations>>;
+	// (undocumented)
+	getTeamById(teamId: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
+	getTeamLinksByTeamId(
+		teamId: string,
+	): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamLinksByTeamId>>;
+	// @deprecated (undocumented)
+	inviteUsersToTeam(
+		...args: Parameters<typeof defaultLegionClient.inviteUsersToTeam>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.inviteUsersToTeam>>;
+	// @deprecated (undocumented)
+	isSingleFullMemberTeam(teamId: string): Promise<boolean>;
+	// (undocumented)
+	joinOrRequestDefaultAccessToProductsBulk(
+		...args: Parameters<typeof _default_4.joinOrRequestDefaultAccessToProductsBulk>
+	): Promise<AwaitedReturn<typeof _default_4.joinOrRequestDefaultAccessToProductsBulk>>;
+	queryFeatureFlags(
+		...args: Parameters<typeof directoryClient.queryFeatureFlags>
+	): Promise<AwaitedReturn<typeof directoryClient.queryFeatureFlags>>;
+	querySettings(
+		...args: Parameters<typeof directoryClient.querySettings>
+	): Promise<AwaitedReturn<typeof directoryClient.querySettings>>;
+	queryTeamHealthMonitors(
+		...args: Parameters<typeof atlasClient.queryTeamHealthMonitors>
+	): Promise<AwaitedReturn<typeof atlasClient.queryTeamHealthMonitors>>;
+	queryTeamMemberships(
+		teamId: string,
+		membershipState?: MembershipState[],
+		pageInfo?: AGGPageInfoVariables,
+	): Promise<ResultWithPageInfo<TeamMembership>>;
+	queryUser(
+		...args: Parameters<typeof directoryClient.queryUser>
+	): Promise<AwaitedReturn<typeof directoryClient.queryUser>>;
+	removeTeamMemberships(
+		...args: Parameters<typeof _default_3.removeTeamMemberships>
+	): Promise<AwaitedReturn<typeof _default_3.removeTeamMemberships>>;
+	reorderTeamLink(
+		...args: Parameters<typeof defaultLegionClient.reorderTeamLink>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.reorderTeamLink>>;
+	// @deprecated (undocumented)
+	revokeTeamInvite(
+		...args: Parameters<typeof defaultLegionClient.revokeTeamInvite>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.revokeTeamInvite>>;
+	selfJoinTeam(
+		...args: Parameters<typeof defaultLegionClient.selfJoinTeam>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.selfJoinTeam>>;
+	setBaseUrl(baseUrl: string): void;
+	setContext(context: ClientContextProps): void;
+	// @deprecated (undocumented)
+	setDirectoryBaseUrl(baseUrl: string): void;
+	// (undocumented)
+	setLegionRootUrl(url: string): void;
+	// (undocumented)
+	trimTeamARI(teamId?: string): string;
+	updateTeamById(
+		...args: Parameters<typeof defaultLegionClient.updateTeamById>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.updateTeamById>>;
+	updateTeamLink(
+		...args: Parameters<typeof defaultLegionClient.updateTeamLink>
+	): Promise<AwaitedReturn<typeof defaultLegionClient.updateTeamLink>>;
+}
+
+// @public (undocumented)
+export const teamsClient: TeamsClient;
+
+// @public (undocumented)
+interface TeamsClientUser {
+	// (undocumented)
+	avatarUrl?: string;
+	// (undocumented)
+	companyName?: string;
+	// (undocumented)
+	department?: string;
+	// (undocumented)
+	email?: string;
+	// (undocumented)
+	fullName: string;
+	// (undocumented)
+	headerImageUrl?: string;
+	// (undocumented)
+	id: string;
+	// (undocumented)
+	isBot?: boolean;
+	// (undocumented)
+	isCurrentUser?: boolean;
+	// (undocumented)
+	isNotMentionable?: boolean;
+	// (undocumented)
+	locale?: string;
+	// (undocumented)
+	localTime?: string;
+	// (undocumented)
+	location?: string;
+	// (undocumented)
+	nickname?: string;
+	// (undocumented)
+	phoneNumber?: string;
+	// (undocumented)
+	position?: string;
+	// (undocumented)
+	preferredLanguage?: string;
+	// (undocumented)
+	privacy?: UserPrivacy;
+	// (undocumented)
+	status?: UserStatus;
+	// (undocumented)
+	statusModifiedDate?: number;
+	timezone?: string;
+	// (undocumented)
+	title?: string;
+}
+
+// @public (undocumented)
+type TeamState = 'ACTIVE' | 'PURGED' | DeprecatedTeamState;
+
+// @public
+interface TeamWithImageUrls extends Team, TeamAvatarImage {}
+
+// @public (undocumented)
+interface TeamWithMemberships extends TeamWithImageUrls {
+	// (undocumented)
+	includesYou: boolean;
+	// (undocumented)
+	memberCount: number;
+	// (undocumented)
+	members: TeamMember[];
+}
+
+// @public (undocumented)
+export const toTeamARI: (teamId: string) => TeamARI;
+
+// @public (undocumented)
+export const toTeamId: (ari: TeamARI | string) => string;
+
+// @public (undocumented)
+export const toUserARI: (userId: string) => UserARI;
+
+// @public (undocumented)
+export const toUserId: (ari: UserARI | string) => string;
+
+// @public (undocumented)
+const USER_ARI_PREFIX: 'ari:cloud:identity::user/';
+
+// @public (undocumented)
+type UserAccessLevel = 'EXTERNAL' | 'INTERNAL' | 'INTERNAL_INACTIVE';
+
+// @public (undocumented)
+type UserARI = `${typeof USER_ARI_PREFIX}${string}`;
+
+// @public (undocumented)
+interface UserInfo {
+	// (undocumented)
+	avatarUrl: string;
+	// (undocumented)
+	email: string;
+	// (undocumented)
+	fullName: string;
+	// (undocumented)
+	locale: string;
+	// (undocumented)
+	title: string;
+	// (undocumented)
+	userId: string;
+}
+
+// @public (undocumented)
+export class UserInfoProvider {
+	// (undocumented)
+	get(fetchOp?: typeof fetch): Promise<UserInfo>;
+}
+
+// @public (undocumented)
+export const userInfoProvider: UserInfoProvider;
+
+// @public (undocumented)
+interface UserPrivacy {
+	// (undocumented)
+	domain: string;
+	// (undocumented)
+	isBlacklistedDomain: boolean;
+	// (undocumented)
+	level: UserPrivacyLevel;
+}
+
+// @public (undocumented)
+type UserPrivacyLevel = 'domain' | 'private' | 'public';
+
+// @public (undocumented)
+type UserStatus = 'active' | 'closed' | 'inactive';
+
+// @public (undocumented)
+export const useTeamsClientSetup: (
+	stargateRoot?: string,
+	cloudId?: null | string,
+	orgId?: string,
+) => void;
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{
+	"react": "^16.8.0"
+}
+```
+
+<!--SECTION END: Peer Dependencies-->