@atlaskit/teams-client 5.3.0 → 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/dist/cjs/common/utils/ufo/index.js +2 -2
- package/dist/cjs/index.js +19 -12
- package/dist/cjs/services/base-client/index.js +2 -2
- package/dist/cjs/services/constants.js +2 -1
- package/dist/cjs/services/sentry/utils/get-sentry-config.js +1 -1
- package/dist/cjs/services/teams-in-slack-client/TeamsInSlackClient.js +4 -1
- package/dist/cjs/services/use-query-light/useQueryLight.js +3 -3
- package/dist/es2019/common/utils/ufo/index.js +2 -2
- package/dist/es2019/index.js +10 -3
- package/dist/es2019/services/base-client/index.js +1 -1
- package/dist/es2019/services/constants.js +2 -1
- package/dist/es2019/services/sentry/utils/get-sentry-config.js +1 -1
- package/dist/es2019/services/teams-in-slack-client/TeamsInSlackClient.js +4 -1
- package/dist/es2019/services/use-query-light/useQueryLight.js +1 -1
- package/dist/esm/common/utils/ufo/index.js +2 -2
- package/dist/esm/index.js +10 -3
- package/dist/esm/services/base-client/index.js +1 -1
- package/dist/esm/services/constants.js +2 -1
- package/dist/esm/services/sentry/utils/get-sentry-config.js +1 -1
- package/dist/esm/services/teams-in-slack-client/TeamsInSlackClient.js +4 -1
- package/dist/esm/services/use-query-light/useQueryLight.js +1 -1
- package/dist/types/common/utils/is-invited.d.ts +1 -1
- package/dist/types/common/utils/is-member.d.ts +1 -1
- package/dist/types/common/utils/is-non-member.d.ts +1 -1
- package/dist/types/common/utils/is-requesting-join.d.ts +1 -1
- package/dist/types/common/utils/sort-teams.d.ts +1 -1
- package/dist/types/index.d.ts +13 -5
- package/dist/types/mocks/fixed-team-memberships.d.ts +1 -1
- package/dist/types/mocks/random-returned-new-team-data.d.ts +1 -1
- package/dist/types/mocks/random-team-membership.d.ts +1 -1
- package/dist/types/mocks/random-team-memberships.d.ts +1 -1
- package/dist/types/mocks/responses.d.ts +1 -1
- package/dist/types/mocks/team-link.d.ts +1 -1
- package/dist/types/mocks/with-faker.d.ts +3 -1
- package/dist/types/services/agg-client/index.d.ts +2 -1
- package/dist/types/services/agg-client/utils/queries/team-membership-query.d.ts +1 -1
- package/dist/types/services/constants.d.ts +1 -1
- package/dist/types/services/directory-client/index.d.ts +1 -1
- package/dist/types/services/identity-client/IdentityClient.d.ts +1 -1
- package/dist/types/services/legion-client/index.d.ts +4 -2
- package/dist/types/services/main.d.ts +4 -2
- package/dist/types/types/config.d.ts +1 -0
- package/package.json +9 -39
- package/report.api.md +0 -1210
package/report.api.md
DELETED
|
@@ -1,1210 +0,0 @@
|
|
|
1
|
-
<!-- API Report Version: 2.3 -->
|
|
2
|
-
|
|
3
|
-
## API Report File for "@atlaskit/teams-client"
|
|
4
|
-
|
|
5
|
-
> Do not edit this file. This report is auto-generated using
|
|
6
|
-
> [API Extractor](https://api-extractor.com/).
|
|
7
|
-
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
8
|
-
|
|
9
|
-
### Table of contents
|
|
10
|
-
|
|
11
|
-
- [Main Entry Types](#main-entry-types)
|
|
12
|
-
- [Peer Dependencies](#peer-dependencies)
|
|
13
|
-
|
|
14
|
-
### Main Entry Types
|
|
15
|
-
|
|
16
|
-
<!--SECTION START: Main Entry Types-->
|
|
17
|
-
|
|
18
|
-
```ts
|
|
19
|
-
import type { captureException } from '@sentry/browser';
|
|
20
|
-
import type { captureMessage } from '@sentry/browser';
|
|
21
|
-
import type { init } from '@sentry/browser';
|
|
22
|
-
import type { Integrations } from '@sentry/browser';
|
|
23
|
-
import type { Scope } from '@sentry/browser';
|
|
24
|
-
|
|
25
|
-
// @public (undocumented)
|
|
26
|
-
type AccessMode = 'DIRECT_ACCESS' | 'REQUEST_ACCESS';
|
|
27
|
-
|
|
28
|
-
// @public (undocumented)
|
|
29
|
-
type AccessRequestBulk = {
|
|
30
|
-
resources: Resource[];
|
|
31
|
-
note?: string;
|
|
32
|
-
accessMode?: AccessMode;
|
|
33
|
-
source?: string;
|
|
34
|
-
};
|
|
35
|
-
|
|
36
|
-
// @public (undocumented)
|
|
37
|
-
type AccessRequestBulkSimplified = Omit<AccessRequestBulk, 'resources'> & {
|
|
38
|
-
productAris: ProductARI[];
|
|
39
|
-
};
|
|
40
|
-
|
|
41
|
-
// @public (undocumented)
|
|
42
|
-
type AccessRequestCapability =
|
|
43
|
-
| 'ACCESS_EXISTS'
|
|
44
|
-
| 'ACCESS_GRANTED'
|
|
45
|
-
| 'APPROVED_REQUEST_EXISTS'
|
|
46
|
-
| 'DENIED_REQUEST_EXISTS'
|
|
47
|
-
| 'DIRECT_ACCESS'
|
|
48
|
-
| 'ERROR'
|
|
49
|
-
| 'FORBIDDEN'
|
|
50
|
-
| 'PENDING_REQUEST_CREATED'
|
|
51
|
-
| 'PENDING_REQUEST_EXISTS'
|
|
52
|
-
| 'REQUEST_ACCESS'
|
|
53
|
-
| 'VERIFICATION_REQUIRED';
|
|
54
|
-
|
|
55
|
-
// @public (undocumented)
|
|
56
|
-
type AccessRequestCapabilityWithRole = {
|
|
57
|
-
accessMode: AccessRequestCapability;
|
|
58
|
-
role: Role;
|
|
59
|
-
};
|
|
60
|
-
|
|
61
|
-
// @public (undocumented)
|
|
62
|
-
type AccessResourceResponse = {
|
|
63
|
-
ari: ProductARI;
|
|
64
|
-
result: AccessRequestCapability;
|
|
65
|
-
resultsV2: {
|
|
66
|
-
[K in ProductARI]: AccessRequestCapabilityWithRole[];
|
|
67
|
-
};
|
|
68
|
-
errorReason?: ErrorResponse;
|
|
69
|
-
};
|
|
70
|
-
|
|
71
|
-
// @public (undocumented)
|
|
72
|
-
type AccessResourcesResponse = AccessResourceResponse[];
|
|
73
|
-
|
|
74
|
-
// @public @deprecated (undocumented)
|
|
75
|
-
interface AddMembershipReponse {
|
|
76
|
-
// (undocumented)
|
|
77
|
-
errors: {
|
|
78
|
-
accountId: string;
|
|
79
|
-
code: string;
|
|
80
|
-
message: string;
|
|
81
|
-
}[];
|
|
82
|
-
// (undocumented)
|
|
83
|
-
members: Member[];
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
// @public (undocumented)
|
|
87
|
-
type AGGPageInfo = {
|
|
88
|
-
endCursor: null | string;
|
|
89
|
-
hasNextPage: boolean;
|
|
90
|
-
};
|
|
91
|
-
|
|
92
|
-
// @public (undocumented)
|
|
93
|
-
type AGGPageInfoVariables = {
|
|
94
|
-
first: number;
|
|
95
|
-
after?: string;
|
|
96
|
-
};
|
|
97
|
-
|
|
98
|
-
// @public (undocumented)
|
|
99
|
-
export const AllTeamActions: readonly [
|
|
100
|
-
'ADD_MEMBER_TO_TEAM',
|
|
101
|
-
'JOIN_TEAM',
|
|
102
|
-
'REQUEST_TO_JOIN',
|
|
103
|
-
'CANCEL_JOIN_REQUEST',
|
|
104
|
-
'APPROVE_JOIN_REQUEST',
|
|
105
|
-
'REJECT_JOIN_REQUEST',
|
|
106
|
-
'REMOVE_MEMBER_FROM_TEAM',
|
|
107
|
-
'CANCEL_INVITE',
|
|
108
|
-
'LEAVE_TEAM',
|
|
109
|
-
'EDIT_TEAM_NAME',
|
|
110
|
-
'EDIT_DESCRIPTION',
|
|
111
|
-
'EDIT_PROFILE_HEADER',
|
|
112
|
-
'EDIT_TEAM_LINK',
|
|
113
|
-
'DELETE_TEAM',
|
|
114
|
-
];
|
|
115
|
-
|
|
116
|
-
// @public
|
|
117
|
-
export interface AllTeamsQuery {
|
|
118
|
-
// (undocumented)
|
|
119
|
-
cursor?: string;
|
|
120
|
-
// (undocumented)
|
|
121
|
-
limit?: number;
|
|
122
|
-
// (undocumented)
|
|
123
|
-
memberAccountIds?: string[];
|
|
124
|
-
// @deprecated (undocumented)
|
|
125
|
-
orgId: string;
|
|
126
|
-
// (undocumented)
|
|
127
|
-
searchQuery?: string;
|
|
128
|
-
// (undocumented)
|
|
129
|
-
useDefaultSort?: boolean;
|
|
130
|
-
}
|
|
131
|
-
|
|
132
|
-
// @public
|
|
133
|
-
interface AllTeamsResponse {
|
|
134
|
-
// (undocumented)
|
|
135
|
-
cursor: string;
|
|
136
|
-
// (undocumented)
|
|
137
|
-
error?: Error;
|
|
138
|
-
// (undocumented)
|
|
139
|
-
teams: TeamWithMemberships[];
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
// @public (undocumented)
|
|
143
|
-
class AtlasClient extends BaseGraphQlClient {
|
|
144
|
-
constructor(baseUrl: string, config: ClientConfig);
|
|
145
|
-
queryTeamHealthMonitors(teamId: string): Promise<TeamHealthMonitor[]>;
|
|
146
|
-
// (undocumented)
|
|
147
|
-
setBaseUrl(baseUrl: string): void;
|
|
148
|
-
}
|
|
149
|
-
|
|
150
|
-
// @public (undocumented)
|
|
151
|
-
const atlasClient: AtlasClient;
|
|
152
|
-
|
|
153
|
-
// @public
|
|
154
|
-
type AwaitedReturn<T extends (...args: any) => any> = Awaited<ReturnType<T>>;
|
|
155
|
-
|
|
156
|
-
// @public (undocumented)
|
|
157
|
-
class BaseClient {
|
|
158
|
-
constructor(config: ClientConfig);
|
|
159
|
-
// (undocumented)
|
|
160
|
-
getCloudId(localValue?: string): string;
|
|
161
|
-
// (undocumented)
|
|
162
|
-
getContext(): ClientContext;
|
|
163
|
-
// (undocumented)
|
|
164
|
-
getOrgId(localValue?: string): string;
|
|
165
|
-
// (undocumented)
|
|
166
|
-
logException: (
|
|
167
|
-
ex: Error | unknown,
|
|
168
|
-
name: string,
|
|
169
|
-
context?: NestedContext & {
|
|
170
|
-
tags?: Record<string, string>;
|
|
171
|
-
},
|
|
172
|
-
) => void;
|
|
173
|
-
// (undocumented)
|
|
174
|
-
setContext(context: ClientContextProps): void;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
|
-
// @public (undocumented)
|
|
178
|
-
class BaseGraphQlClient extends BaseClient {
|
|
179
|
-
constructor(serviceUrl: string, config: ClientConfig);
|
|
180
|
-
// (undocumented)
|
|
181
|
-
makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(
|
|
182
|
-
body: Body_2<Variables>,
|
|
183
|
-
options?: Options,
|
|
184
|
-
): Promise<ResultResponse<Key, Data>>;
|
|
185
|
-
// (undocumented)
|
|
186
|
-
setServiceUrl(serviceUrl: string): void;
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
// @public (undocumented)
|
|
190
|
-
type Body_2<Variables> = {
|
|
191
|
-
query: string;
|
|
192
|
-
variables?: Variables;
|
|
193
|
-
};
|
|
194
|
-
|
|
195
|
-
// @public (undocumented)
|
|
196
|
-
const BROWSE_USER_SETTINGS_KEY = 'internal.browse-users-allowed';
|
|
197
|
-
|
|
198
|
-
// @public (undocumented)
|
|
199
|
-
type Capability = 'DIRECT_ACCESS' | 'REQUEST_ACCESS';
|
|
200
|
-
|
|
201
|
-
// @public (undocumented)
|
|
202
|
-
type ClientConfig = {
|
|
203
|
-
logException: LogExceptionFN;
|
|
204
|
-
};
|
|
205
|
-
|
|
206
|
-
// @public (undocumented)
|
|
207
|
-
type ClientContext = {
|
|
208
|
-
cloudId: string;
|
|
209
|
-
orgId?: string;
|
|
210
|
-
};
|
|
211
|
-
|
|
212
|
-
// @public (undocumented)
|
|
213
|
-
type ClientContextProps = {
|
|
214
|
-
cloudId?: null | string;
|
|
215
|
-
orgId?: string;
|
|
216
|
-
};
|
|
217
|
-
|
|
218
|
-
// @public
|
|
219
|
-
interface CloudUser {
|
|
220
|
-
// (undocumented)
|
|
221
|
-
avatarUrl: string;
|
|
222
|
-
// (undocumented)
|
|
223
|
-
fullName: string;
|
|
224
|
-
// (undocumented)
|
|
225
|
-
id: string;
|
|
226
|
-
// (undocumented)
|
|
227
|
-
title?: string;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
// @public (undocumented)
|
|
231
|
-
class CommonError extends Error {
|
|
232
|
-
constructor(message?: string);
|
|
233
|
-
// (undocumented)
|
|
234
|
-
message: string;
|
|
235
|
-
// (undocumented)
|
|
236
|
-
name: string;
|
|
237
|
-
// (undocumented)
|
|
238
|
-
stack: string;
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
// @public (undocumented)
|
|
242
|
-
type Context = any & {
|
|
243
|
-
tags?: SentryTags;
|
|
244
|
-
packageName?: string;
|
|
245
|
-
packageVersion?: string;
|
|
246
|
-
};
|
|
247
|
-
|
|
248
|
-
// @public (undocumented)
|
|
249
|
-
const _default: MutabilityClient;
|
|
250
|
-
|
|
251
|
-
// @public
|
|
252
|
-
const _default_2: PermsClient;
|
|
253
|
-
|
|
254
|
-
// @public (undocumented)
|
|
255
|
-
const _default_3: PublicApiClient;
|
|
256
|
-
|
|
257
|
-
// @public (undocumented)
|
|
258
|
-
const _default_4: InvitationsClient;
|
|
259
|
-
|
|
260
|
-
// @public (undocumented)
|
|
261
|
-
const defaultLegionClient: LegionClient;
|
|
262
|
-
|
|
263
|
-
// @public @deprecated (undocumented)
|
|
264
|
-
type DeprecatedTeamState = 'DISBANDED';
|
|
265
|
-
|
|
266
|
-
// @public @deprecated (undocumented)
|
|
267
|
-
type DeprecratedMembershipState = 'INVITED';
|
|
268
|
-
|
|
269
|
-
// @public (undocumented)
|
|
270
|
-
class DirectoryClient extends BaseGraphQlClient {
|
|
271
|
-
constructor(baseUrl: string, config: ClientConfig);
|
|
272
|
-
// (undocumented)
|
|
273
|
-
queryFeatureFlags(cloudId: string | undefined, flags: string[]): Promise<Record<string, boolean>>;
|
|
274
|
-
// (undocumented)
|
|
275
|
-
querySettings(
|
|
276
|
-
cloudId?: string,
|
|
277
|
-
product?: string,
|
|
278
|
-
): Promise<{
|
|
279
|
-
[BROWSE_USER_SETTINGS_KEY]: boolean;
|
|
280
|
-
}>;
|
|
281
|
-
// @deprecated
|
|
282
|
-
queryTeamMemberships(teamId: string, membershipStatus?: string[]): Promise<TeamMembership[]>;
|
|
283
|
-
queryUser(
|
|
284
|
-
userId: string,
|
|
285
|
-
cloudId?: string,
|
|
286
|
-
): Promise<{
|
|
287
|
-
CloudUser: CloudUser;
|
|
288
|
-
}>;
|
|
289
|
-
// (undocumented)
|
|
290
|
-
setBaseUrl(baseUrl: string): void;
|
|
291
|
-
}
|
|
292
|
-
|
|
293
|
-
// @public (undocumented)
|
|
294
|
-
const directoryClient: DirectoryClient;
|
|
295
|
-
|
|
296
|
-
// @public (undocumented)
|
|
297
|
-
type ErrorResponse = {
|
|
298
|
-
message: string;
|
|
299
|
-
responseStatus: StatusCode;
|
|
300
|
-
};
|
|
301
|
-
|
|
302
|
-
// @public (undocumented)
|
|
303
|
-
interface FetchOptions {
|
|
304
|
-
// (undocumented)
|
|
305
|
-
body?: any;
|
|
306
|
-
// (undocumented)
|
|
307
|
-
headers?: {
|
|
308
|
-
[key: string]: string;
|
|
309
|
-
};
|
|
310
|
-
// (undocumented)
|
|
311
|
-
ignoreResponse?: boolean;
|
|
312
|
-
// (undocumented)
|
|
313
|
-
method?: string;
|
|
314
|
-
// (undocumented)
|
|
315
|
-
shouldLogError?: (e: HttpError) => boolean;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
// @public (undocumented)
|
|
319
|
-
export function hasPermission(
|
|
320
|
-
action: TeamAction,
|
|
321
|
-
settings: TeamMembershipSettings,
|
|
322
|
-
permission: TeamPermission | undefined,
|
|
323
|
-
isPeopleBrowseEnabled: boolean,
|
|
324
|
-
currentUserMembership: TeamMembership | undefined,
|
|
325
|
-
): boolean;
|
|
326
|
-
|
|
327
|
-
// @public (undocumented)
|
|
328
|
-
export class HttpError extends CommonError {
|
|
329
|
-
constructor({ message, status, traceId }: HttpErrorArguments);
|
|
330
|
-
// (undocumented)
|
|
331
|
-
status: number;
|
|
332
|
-
// (undocumented)
|
|
333
|
-
traceId?: string;
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
// @public (undocumented)
|
|
337
|
-
interface HttpErrorArguments {
|
|
338
|
-
// (undocumented)
|
|
339
|
-
message: string;
|
|
340
|
-
// (undocumented)
|
|
341
|
-
status: number;
|
|
342
|
-
// (undocumented)
|
|
343
|
-
traceId?: string;
|
|
344
|
-
}
|
|
345
|
-
|
|
346
|
-
// @public (undocumented)
|
|
347
|
-
export function initialiseSentry(client: SentryClient, options: SentryInstallConfig): Promise<void>;
|
|
348
|
-
|
|
349
|
-
// @public (undocumented)
|
|
350
|
-
class InvitationsClient extends RestClient {
|
|
351
|
-
constructor(serviceUrl: string, config: ClientConfig);
|
|
352
|
-
// (undocumented)
|
|
353
|
-
getProductRecommendations(
|
|
354
|
-
supportedProducts?: Product[],
|
|
355
|
-
capabilities?: Capability[],
|
|
356
|
-
): Promise<RecommendationsResponse>;
|
|
357
|
-
// (undocumented)
|
|
358
|
-
joinOrRequestDefaultAccessToProductsBulk(
|
|
359
|
-
simplifiedRequest: AccessRequestBulkSimplified,
|
|
360
|
-
): Promise<AccessResourcesResponse>;
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
// @public (undocumented)
|
|
364
|
-
interface InvitedUser {
|
|
365
|
-
// (undocumented)
|
|
366
|
-
email: null | string;
|
|
367
|
-
// (undocumented)
|
|
368
|
-
id: null | string;
|
|
369
|
-
}
|
|
370
|
-
|
|
371
|
-
// @public (undocumented)
|
|
372
|
-
export function isInvited(member?: TeamMembership): member is TeamMembership & boolean;
|
|
373
|
-
|
|
374
|
-
// @public (undocumented)
|
|
375
|
-
export const isMember: (member?: TeamMembership) => boolean;
|
|
376
|
-
|
|
377
|
-
// @public (undocumented)
|
|
378
|
-
export const isNonMember: (member?: TeamMembership) => boolean;
|
|
379
|
-
|
|
380
|
-
// @public (undocumented)
|
|
381
|
-
export const isRequestingJoin: (member?: TeamMembership) => boolean;
|
|
382
|
-
|
|
383
|
-
// @public (undocumented)
|
|
384
|
-
export function isTeamMembershipWithUser(
|
|
385
|
-
membership: TeamMembership,
|
|
386
|
-
): membership is Required<TeamMembership>;
|
|
387
|
-
|
|
388
|
-
// @public (undocumented)
|
|
389
|
-
interface LegionClient {
|
|
390
|
-
// (undocumented)
|
|
391
|
-
acceptJoinRequest(teamId: string, memberId: string): Promise<TeamMembership>;
|
|
392
|
-
// (undocumented)
|
|
393
|
-
acceptTeamInvitation(teamId: string): Promise<TeamMembership>;
|
|
394
|
-
// (undocumented)
|
|
395
|
-
cancelJoinRequest(teamId: string): Promise<void>;
|
|
396
|
-
// (undocumented)
|
|
397
|
-
createTeam(
|
|
398
|
-
displayName: string,
|
|
399
|
-
originQuery: OriginQuery,
|
|
400
|
-
members?: string[],
|
|
401
|
-
membershipSettings?: TeamMembershipSettings,
|
|
402
|
-
): Promise<Team>;
|
|
403
|
-
// (undocumented)
|
|
404
|
-
createTeamLink(teamId: string, link: NewTeamLink): Promise<TeamLink>;
|
|
405
|
-
// (undocumented)
|
|
406
|
-
declineJoinRequest(teamId: string, memberId: string): Promise<void>;
|
|
407
|
-
// (undocumented)
|
|
408
|
-
declineTeamInvitation(teamId: string): Promise<void>;
|
|
409
|
-
// (undocumented)
|
|
410
|
-
deleteTeam(teamId: string): Promise<void>;
|
|
411
|
-
// (undocumented)
|
|
412
|
-
deleteTeamLink(teamId: string, linkId: string): Promise<void>;
|
|
413
|
-
// (undocumented)
|
|
414
|
-
deleteTeamMembership(teamId: string, memberId: string): Promise<TeamMembership>;
|
|
415
|
-
// (undocumented)
|
|
416
|
-
getAllTeams(allTeamsQuery: AllTeamsQuery): Promise<AllTeamsResponse>;
|
|
417
|
-
// (undocumented)
|
|
418
|
-
getMyTeamMembership(teamId: string): Promise<TeamMembership>;
|
|
419
|
-
// (undocumented)
|
|
420
|
-
getTeamById(teamId: string): Promise<TeamWithImageUrls>;
|
|
421
|
-
// (undocumented)
|
|
422
|
-
getTeamLinksByTeamId(teamId: string): Promise<{
|
|
423
|
-
entities: TeamLink[];
|
|
424
|
-
}>;
|
|
425
|
-
// (undocumented)
|
|
426
|
-
inviteUsersToTeam(
|
|
427
|
-
teamId: string,
|
|
428
|
-
users: InvitedUser[],
|
|
429
|
-
originQuery: OriginQuery,
|
|
430
|
-
): Promise<TeamMembership[]>;
|
|
431
|
-
// (undocumented)
|
|
432
|
-
isSingleFullMemberTeam(teamId: string): Promise<boolean>;
|
|
433
|
-
// (undocumented)
|
|
434
|
-
reorderTeamLink(teamId: string, linkId: string, newPosition: number): Promise<LinkOrder>;
|
|
435
|
-
// (undocumented)
|
|
436
|
-
revokeTeamInvite(teamId: string, memberId: string): Promise<TeamMembership>;
|
|
437
|
-
// (undocumented)
|
|
438
|
-
selfJoinTeam(teamId: string, originQuery: OriginQuery): Promise<TeamMembership>;
|
|
439
|
-
// (undocumented)
|
|
440
|
-
updateTeamById(teamId: string, data: Partial<Team>): Promise<TeamWithImageUrls>;
|
|
441
|
-
// (undocumented)
|
|
442
|
-
updateTeamLink(teamId: string, linkId: string, newLink: NewTeamLink): Promise<TeamLink>;
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
// @public
|
|
446
|
-
class LegionClient extends RestClient implements LegionClient {
|
|
447
|
-
constructor(serviceUrlRoot: string);
|
|
448
|
-
// (undocumented)
|
|
449
|
-
mapLegionTeamLinkResponseV3ToTeamLink(legionLinkResponseV3: LegionLinkResponseV3): TeamLink;
|
|
450
|
-
// (undocumented)
|
|
451
|
-
mapLegionTeamLinkResponseV4ToTeamLink(legionLinkResponseV4: LegionLinkResponseV4): TeamLink;
|
|
452
|
-
// (undocumented)
|
|
453
|
-
mapLegionTeamLinksResponseV3ToTeamLinkResponse(
|
|
454
|
-
response: LegionPaginatedResponse<LegionLinkResponseV3>,
|
|
455
|
-
): {
|
|
456
|
-
entities: TeamLink[];
|
|
457
|
-
};
|
|
458
|
-
// (undocumented)
|
|
459
|
-
mapLegionTeamLinksResponseV4ToTeamLinkResponse(
|
|
460
|
-
response: LegionPaginatedResponse<LegionLinkResponseV4>,
|
|
461
|
-
): {
|
|
462
|
-
entities: TeamLink[];
|
|
463
|
-
};
|
|
464
|
-
// (undocumented)
|
|
465
|
-
setRootUrl(url: string): void;
|
|
466
|
-
// (undocumented)
|
|
467
|
-
trimTeamARI(teamId?: string): string;
|
|
468
|
-
}
|
|
469
|
-
|
|
470
|
-
// @public (undocumented)
|
|
471
|
-
interface LegionLinkResponseV3 {
|
|
472
|
-
// (undocumented)
|
|
473
|
-
contentTitle: string;
|
|
474
|
-
// (undocumented)
|
|
475
|
-
creationTime?: string;
|
|
476
|
-
// (undocumented)
|
|
477
|
-
description: string;
|
|
478
|
-
// (undocumented)
|
|
479
|
-
linkId: string;
|
|
480
|
-
// (undocumented)
|
|
481
|
-
linkUri: string;
|
|
482
|
-
// (undocumented)
|
|
483
|
-
teamId?: string;
|
|
484
|
-
}
|
|
485
|
-
|
|
486
|
-
// @public (undocumented)
|
|
487
|
-
interface LegionLinkResponseV4 {
|
|
488
|
-
// (undocumented)
|
|
489
|
-
contentTitle: string;
|
|
490
|
-
// (undocumented)
|
|
491
|
-
description: string;
|
|
492
|
-
// (undocumented)
|
|
493
|
-
linkId: string;
|
|
494
|
-
// (undocumented)
|
|
495
|
-
linkUri: string;
|
|
496
|
-
// (undocumented)
|
|
497
|
-
teamId?: string;
|
|
498
|
-
}
|
|
499
|
-
|
|
500
|
-
// @public (undocumented)
|
|
501
|
-
interface LegionPaginatedResponse<T> {
|
|
502
|
-
// (undocumented)
|
|
503
|
-
cursor: string;
|
|
504
|
-
// (undocumented)
|
|
505
|
-
entities: T[];
|
|
506
|
-
}
|
|
507
|
-
|
|
508
|
-
// @public
|
|
509
|
-
const LINK_FIELDS: {
|
|
510
|
-
CONTENT_TITLE: 'contentTitle';
|
|
511
|
-
DESCRIPTION: 'description';
|
|
512
|
-
LINK_URI: 'linkUri';
|
|
513
|
-
};
|
|
514
|
-
|
|
515
|
-
// @public
|
|
516
|
-
type LinkOrder = {
|
|
517
|
-
teamId: string;
|
|
518
|
-
linkOrder: string[];
|
|
519
|
-
};
|
|
520
|
-
|
|
521
|
-
// @public (undocumented)
|
|
522
|
-
export function logException(ex: Error | unknown, name: string, context?: Context): Promise<void>;
|
|
523
|
-
|
|
524
|
-
// @public (undocumented)
|
|
525
|
-
type LogExceptionFN = (
|
|
526
|
-
ex: Error | unknown,
|
|
527
|
-
name: string,
|
|
528
|
-
context?: NestedContext & {
|
|
529
|
-
tags?: Record<string, string>;
|
|
530
|
-
},
|
|
531
|
-
) => void;
|
|
532
|
-
|
|
533
|
-
// @public (undocumented)
|
|
534
|
-
export function logInfoMessage(message: string, context?: Context): void;
|
|
535
|
-
|
|
536
|
-
// @public @deprecated (undocumented)
|
|
537
|
-
interface Member {
|
|
538
|
-
// (undocumented)
|
|
539
|
-
accountId: string;
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
// @public (undocumented)
|
|
543
|
-
type MembershipRole = 'ADMIN' | 'REGULAR';
|
|
544
|
-
|
|
545
|
-
// @public (undocumented)
|
|
546
|
-
type MembershipState = 'ALUMNI' | 'FULL_MEMBER' | 'REQUESTING_TO_JOIN' | DeprecratedMembershipState;
|
|
547
|
-
|
|
548
|
-
// @public (undocumented)
|
|
549
|
-
class MutabilityClient extends RestClient {
|
|
550
|
-
constructor(config?: {});
|
|
551
|
-
// (undocumented)
|
|
552
|
-
getProfileWithMutability(userId: string): Promise<MutabilityConstraint[]>;
|
|
553
|
-
}
|
|
554
|
-
|
|
555
|
-
// @public (undocumented)
|
|
556
|
-
interface MutabilityConstraint {
|
|
557
|
-
// (undocumented)
|
|
558
|
-
field: string;
|
|
559
|
-
// (undocumented)
|
|
560
|
-
reason: Reason;
|
|
561
|
-
}
|
|
562
|
-
|
|
563
|
-
// @public (undocumented)
|
|
564
|
-
type NestedContext = {
|
|
565
|
-
[key: string]: NestedContext | boolean | number | string;
|
|
566
|
-
};
|
|
567
|
-
|
|
568
|
-
// @public
|
|
569
|
-
type NewTeamLink = Omit<TeamLink, 'linkId'>;
|
|
570
|
-
|
|
571
|
-
// @public (undocumented)
|
|
572
|
-
interface Options {
|
|
573
|
-
// (undocumented)
|
|
574
|
-
errorPolicy?: 'all' | 'ignore' | 'none';
|
|
575
|
-
// (undocumented)
|
|
576
|
-
operationName?: string;
|
|
577
|
-
}
|
|
578
|
-
|
|
579
|
-
// @public (undocumented)
|
|
580
|
-
export interface OriginQuery {
|
|
581
|
-
// @deprecated (undocumented)
|
|
582
|
-
cloudId?: string;
|
|
583
|
-
// (undocumented)
|
|
584
|
-
product?: null | string;
|
|
585
|
-
}
|
|
586
|
-
|
|
587
|
-
// @public (undocumented)
|
|
588
|
-
class PermsClient extends RestClient {
|
|
589
|
-
// (undocumented)
|
|
590
|
-
getIsSiteAdmin(cloudId?: string): Promise<boolean>;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
// @public
|
|
594
|
-
type Product =
|
|
595
|
-
| 'avocado'
|
|
596
|
-
| 'avp'
|
|
597
|
-
| 'beacon'
|
|
598
|
-
| 'compass'
|
|
599
|
-
| 'confluence'
|
|
600
|
-
| 'jira'
|
|
601
|
-
| 'jira-core'
|
|
602
|
-
| 'jira-incident-manager'
|
|
603
|
-
| 'jira-product-discovery'
|
|
604
|
-
| 'jira-servicedesk'
|
|
605
|
-
| 'jira-software'
|
|
606
|
-
| 'mercury'
|
|
607
|
-
| 'opsgenie'
|
|
608
|
-
| 'statuspage'
|
|
609
|
-
| 'townsquare';
|
|
610
|
-
|
|
611
|
-
// @public (undocumented)
|
|
612
|
-
type ProductARI = string;
|
|
613
|
-
|
|
614
|
-
// @public (undocumented)
|
|
615
|
-
interface PublicApiClient {
|
|
616
|
-
// (undocumented)
|
|
617
|
-
addUsersToTeam(teamId: string, members: Member[]): Promise<AddMembershipReponse>;
|
|
618
|
-
// (undocumented)
|
|
619
|
-
removeTeamMemberships(teamId: string, members: Member[]): Promise<RemoveMembershipReponse>;
|
|
620
|
-
}
|
|
621
|
-
|
|
622
|
-
// @public (undocumented)
|
|
623
|
-
class PublicApiClient extends RestClient implements PublicApiClient {
|
|
624
|
-
constructor(serviceUrlRoot: string);
|
|
625
|
-
// (undocumented)
|
|
626
|
-
getTeamDetails(teamId: string): Promise<PublicApiTeamResponse>;
|
|
627
|
-
// (undocumented)
|
|
628
|
-
getTeamMembers(
|
|
629
|
-
teamId: string,
|
|
630
|
-
first?: number,
|
|
631
|
-
after?: string,
|
|
632
|
-
): Promise<PublicApiTeamResponseWithMembers>;
|
|
633
|
-
}
|
|
634
|
-
|
|
635
|
-
// @public (undocumented)
|
|
636
|
-
interface PublicApiMembership {
|
|
637
|
-
// (undocumented)
|
|
638
|
-
accountId?: string;
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
// @public (undocumented)
|
|
642
|
-
interface PublicApiTeamResponse {
|
|
643
|
-
// (undocumented)
|
|
644
|
-
description?: string;
|
|
645
|
-
// (undocumented)
|
|
646
|
-
displayName?: string;
|
|
647
|
-
// (undocumented)
|
|
648
|
-
organizationId?: string;
|
|
649
|
-
// (undocumented)
|
|
650
|
-
teamId?: string;
|
|
651
|
-
// (undocumented)
|
|
652
|
-
teamType?: 'MEMBER_INVITE' | 'OPEN';
|
|
653
|
-
// (undocumented)
|
|
654
|
-
userPermissions?: PublicApiUserPermissions;
|
|
655
|
-
}
|
|
656
|
-
|
|
657
|
-
// @public (undocumented)
|
|
658
|
-
interface PublicApiTeamResponseWithMembers {
|
|
659
|
-
// (undocumented)
|
|
660
|
-
description?: string;
|
|
661
|
-
// (undocumented)
|
|
662
|
-
displayName?: string;
|
|
663
|
-
members?: PublicApiMembership[];
|
|
664
|
-
// (undocumented)
|
|
665
|
-
organizationId?: string;
|
|
666
|
-
// (undocumented)
|
|
667
|
-
teamId?: string;
|
|
668
|
-
// (undocumented)
|
|
669
|
-
teamType?: 'MEMBER_INVITE' | 'OPEN';
|
|
670
|
-
// (undocumented)
|
|
671
|
-
userPermissions?: PublicApiUserPermissions;
|
|
672
|
-
}
|
|
673
|
-
|
|
674
|
-
// @public (undocumented)
|
|
675
|
-
interface PublicApiUserPermissions {
|
|
676
|
-
// (undocumented)
|
|
677
|
-
ADD_MEMBERS?: boolean;
|
|
678
|
-
// (undocumented)
|
|
679
|
-
DELETE_TEAM?: boolean;
|
|
680
|
-
// (undocumented)
|
|
681
|
-
REMOVE_MEMBERS?: boolean;
|
|
682
|
-
// (undocumented)
|
|
683
|
-
UPDATE_TEAM?: boolean;
|
|
684
|
-
}
|
|
685
|
-
|
|
686
|
-
// @public (undocumented)
|
|
687
|
-
type Reason = 'ext.dir.google' | 'ext.dir.scim' | 'managed';
|
|
688
|
-
|
|
689
|
-
// @public (undocumented)
|
|
690
|
-
type Recommendation = {
|
|
691
|
-
resourceId: ProductARI;
|
|
692
|
-
userAccessLevel: UserAccessLevel;
|
|
693
|
-
mode?: RecommendationMode;
|
|
694
|
-
roleAri: RoleARI;
|
|
695
|
-
url: string;
|
|
696
|
-
displayName?: string;
|
|
697
|
-
avatarUrl?: string;
|
|
698
|
-
};
|
|
699
|
-
|
|
700
|
-
// @public (undocumented)
|
|
701
|
-
type RecommendationMode = 'DOMAIN' | 'OPEN';
|
|
702
|
-
|
|
703
|
-
// @public (undocumented)
|
|
704
|
-
type RecommendationsResponse = {
|
|
705
|
-
capability: {
|
|
706
|
-
[K in Capability]: Recommendation[];
|
|
707
|
-
};
|
|
708
|
-
};
|
|
709
|
-
|
|
710
|
-
// @public @deprecated (undocumented)
|
|
711
|
-
interface RemoveMembershipReponse {
|
|
712
|
-
// (undocumented)
|
|
713
|
-
errors: {
|
|
714
|
-
accountId: string;
|
|
715
|
-
code: string;
|
|
716
|
-
message: string;
|
|
717
|
-
}[];
|
|
718
|
-
}
|
|
719
|
-
|
|
720
|
-
// @public (undocumented)
|
|
721
|
-
type Resource = {
|
|
722
|
-
ari: ProductARI;
|
|
723
|
-
continueUrl?: string;
|
|
724
|
-
role: Role;
|
|
725
|
-
};
|
|
726
|
-
|
|
727
|
-
// @public (undocumented)
|
|
728
|
-
class RestClient extends BaseClient {
|
|
729
|
-
constructor({ serviceUrl, config }: { serviceUrl: string; config?: ClientConfig });
|
|
730
|
-
// (undocumented)
|
|
731
|
-
deleteResource<T>(path: string, options?: FetchOptions): Promise<T>;
|
|
732
|
-
// (undocumented)
|
|
733
|
-
getResource<T>(path: string, fetchOptions?: Omit<FetchOptions, 'body' | 'method'>): Promise<T>;
|
|
734
|
-
// (undocumented)
|
|
735
|
-
makeRequest<T>(path: string, additionalFetchOptions?: FetchOptions): Promise<T>;
|
|
736
|
-
// (undocumented)
|
|
737
|
-
patchResource<T>(path: string, data?: Record<string, unknown>): Promise<T>;
|
|
738
|
-
// (undocumented)
|
|
739
|
-
postResource<T>(
|
|
740
|
-
path: string,
|
|
741
|
-
data?: Record<string, unknown>,
|
|
742
|
-
fetchOptions?: FetchOptions,
|
|
743
|
-
): Promise<T>;
|
|
744
|
-
// (undocumented)
|
|
745
|
-
postResourceRaw<T>(path: string, data?: string, fetchOptions?: FetchOptions): Promise<T>;
|
|
746
|
-
preventInfiniteRedirectLoop: (response: Response) => void;
|
|
747
|
-
// (undocumented)
|
|
748
|
-
putResource<T>(
|
|
749
|
-
path: string,
|
|
750
|
-
data?: Record<string, unknown>,
|
|
751
|
-
additionalFetchOptions?: FetchOptions,
|
|
752
|
-
): Promise<T>;
|
|
753
|
-
// (undocumented)
|
|
754
|
-
serviceUrl: string;
|
|
755
|
-
// (undocumented)
|
|
756
|
-
setServiceUrl(serviceUrl: string): void;
|
|
757
|
-
}
|
|
758
|
-
|
|
759
|
-
// @public (undocumented)
|
|
760
|
-
type ResultResponse<Key extends string, Data> = {
|
|
761
|
-
[name in Key]: Data;
|
|
762
|
-
};
|
|
763
|
-
|
|
764
|
-
// @public (undocumented)
|
|
765
|
-
type ResultWithPageInfo<T> = {
|
|
766
|
-
edges: T[];
|
|
767
|
-
pageInfo: AGGPageInfo;
|
|
768
|
-
};
|
|
769
|
-
|
|
770
|
-
// @public (undocumented)
|
|
771
|
-
type Role =
|
|
772
|
-
| 'org/admin'
|
|
773
|
-
| 'product/external-collaborator-writer'
|
|
774
|
-
| 'product/helpseeker'
|
|
775
|
-
| 'product/member';
|
|
776
|
-
|
|
777
|
-
// @public (undocumented)
|
|
778
|
-
type RoleARI = string;
|
|
779
|
-
|
|
780
|
-
// @public (undocumented)
|
|
781
|
-
type ScopeMode = 'ORG_SCOPE_MODE' | 'SITE_SCOPE_MODE';
|
|
782
|
-
|
|
783
|
-
// @public (undocumented)
|
|
784
|
-
export interface SentryClient {
|
|
785
|
-
// (undocumented)
|
|
786
|
-
captureException: typeof captureException;
|
|
787
|
-
// (undocumented)
|
|
788
|
-
captureMessage: typeof captureMessage;
|
|
789
|
-
// (undocumented)
|
|
790
|
-
init: typeof init;
|
|
791
|
-
// (undocumented)
|
|
792
|
-
Integrations: typeof Integrations;
|
|
793
|
-
// (undocumented)
|
|
794
|
-
withScope(callback: (scope: Scope) => void): void;
|
|
795
|
-
}
|
|
796
|
-
|
|
797
|
-
// @public (undocumented)
|
|
798
|
-
interface SentryInstallConfig {
|
|
799
|
-
// (undocumented)
|
|
800
|
-
attachStacktrace?: boolean;
|
|
801
|
-
// (undocumented)
|
|
802
|
-
dsn?: string;
|
|
803
|
-
// (undocumented)
|
|
804
|
-
env?: string;
|
|
805
|
-
// (undocumented)
|
|
806
|
-
initialScope?: {
|
|
807
|
-
tags?: SentryTags;
|
|
808
|
-
};
|
|
809
|
-
// (undocumented)
|
|
810
|
-
noGlobals?: boolean;
|
|
811
|
-
// @deprecated (undocumented)
|
|
812
|
-
tags?: SentryTags;
|
|
813
|
-
// (undocumented)
|
|
814
|
-
version?: string;
|
|
815
|
-
}
|
|
816
|
-
|
|
817
|
-
// @public (undocumented)
|
|
818
|
-
interface SentryTags {
|
|
819
|
-
// (undocumented)
|
|
820
|
-
[key: string]: string;
|
|
821
|
-
}
|
|
822
|
-
|
|
823
|
-
// @public (undocumented)
|
|
824
|
-
export const sortMembersByType: (
|
|
825
|
-
members: TeamMembership[],
|
|
826
|
-
currentAccountId?: string,
|
|
827
|
-
) => TeamMembership[];
|
|
828
|
-
|
|
829
|
-
// @public (undocumented)
|
|
830
|
-
type StatusCode = string;
|
|
831
|
-
|
|
832
|
-
// @public
|
|
833
|
-
interface Team {
|
|
834
|
-
// @deprecated (undocumented)
|
|
835
|
-
creatorDomain?: string;
|
|
836
|
-
// (undocumented)
|
|
837
|
-
creatorId?: string;
|
|
838
|
-
// (undocumented)
|
|
839
|
-
description: string;
|
|
840
|
-
// @deprecated (undocumented)
|
|
841
|
-
discoverable?: TeamDiscoverability;
|
|
842
|
-
// (undocumented)
|
|
843
|
-
displayName: string;
|
|
844
|
-
// (undocumented)
|
|
845
|
-
id: string;
|
|
846
|
-
// (undocumented)
|
|
847
|
-
memberIds?: string[];
|
|
848
|
-
// (undocumented)
|
|
849
|
-
membership?: {
|
|
850
|
-
members?: TeamMembership[];
|
|
851
|
-
errors?: string[];
|
|
852
|
-
};
|
|
853
|
-
// (undocumented)
|
|
854
|
-
membershipSettings: TeamMembershipSettings;
|
|
855
|
-
// (undocumented)
|
|
856
|
-
organizationId?: string;
|
|
857
|
-
// @deprecated (undocumented)
|
|
858
|
-
orgId?: string;
|
|
859
|
-
// (undocumented)
|
|
860
|
-
permission?: TeamPermission;
|
|
861
|
-
// @deprecated (undocumented)
|
|
862
|
-
restriction: TeamRestriction;
|
|
863
|
-
// (undocumented)
|
|
864
|
-
scopeMode?: ScopeMode;
|
|
865
|
-
// (undocumented)
|
|
866
|
-
state: TeamState;
|
|
867
|
-
}
|
|
868
|
-
|
|
869
|
-
// @public (undocumented)
|
|
870
|
-
const TEAM_ARI_PREFIX: 'ari:cloud:identity::team/';
|
|
871
|
-
|
|
872
|
-
// @public (undocumented)
|
|
873
|
-
export type TeamAction = (typeof AllTeamActions)[number];
|
|
874
|
-
|
|
875
|
-
// @public (undocumented)
|
|
876
|
-
type TeamARI = `${typeof TEAM_ARI_PREFIX}${string}`;
|
|
877
|
-
|
|
878
|
-
// @public (undocumented)
|
|
879
|
-
interface TeamAvatarImage {
|
|
880
|
-
// (undocumented)
|
|
881
|
-
largeAvatarImageUrl: string;
|
|
882
|
-
// (undocumented)
|
|
883
|
-
largeHeaderImageUrl: string;
|
|
884
|
-
// (undocumented)
|
|
885
|
-
smallAvatarImageUrl: string;
|
|
886
|
-
// (undocumented)
|
|
887
|
-
smallHeaderImageUrl: string;
|
|
888
|
-
}
|
|
889
|
-
|
|
890
|
-
// @public (undocumented)
|
|
891
|
-
type TeamDiscoverability = 'DISCOVERABLE';
|
|
892
|
-
|
|
893
|
-
// @public (undocumented)
|
|
894
|
-
interface TeamHealthMonitor {
|
|
895
|
-
// (undocumented)
|
|
896
|
-
date: string;
|
|
897
|
-
// (undocumented)
|
|
898
|
-
greenCount?: number;
|
|
899
|
-
// (undocumented)
|
|
900
|
-
redCount?: number;
|
|
901
|
-
// (undocumented)
|
|
902
|
-
uuid: string;
|
|
903
|
-
// (undocumented)
|
|
904
|
-
yellowCount?: number;
|
|
905
|
-
}
|
|
906
|
-
|
|
907
|
-
// @public (undocumented)
|
|
908
|
-
interface TeamLink {
|
|
909
|
-
// (undocumented)
|
|
910
|
-
[LINK_FIELDS.CONTENT_TITLE]: string;
|
|
911
|
-
// @deprecated (undocumented)
|
|
912
|
-
creationTime?: string;
|
|
913
|
-
// (undocumented)
|
|
914
|
-
[LINK_FIELDS.DESCRIPTION]: string;
|
|
915
|
-
// (undocumented)
|
|
916
|
-
linkId: string;
|
|
917
|
-
// (undocumented)
|
|
918
|
-
[LINK_FIELDS.LINK_URI]: string;
|
|
919
|
-
// (undocumented)
|
|
920
|
-
teamId?: string;
|
|
921
|
-
}
|
|
922
|
-
|
|
923
|
-
// @public (undocumented)
|
|
924
|
-
type TeamMember = Pick<TeamsClientUser, 'avatarUrl' | 'fullName' | 'id' | 'status'>;
|
|
925
|
-
|
|
926
|
-
// @public (undocumented)
|
|
927
|
-
interface TeamMembership {
|
|
928
|
-
// (undocumented)
|
|
929
|
-
membershipId: {
|
|
930
|
-
teamId: string;
|
|
931
|
-
memberId: string;
|
|
932
|
-
};
|
|
933
|
-
// (undocumented)
|
|
934
|
-
role: MembershipRole;
|
|
935
|
-
// (undocumented)
|
|
936
|
-
state: MembershipState;
|
|
937
|
-
// (undocumented)
|
|
938
|
-
user?: TeamsClientUser;
|
|
939
|
-
}
|
|
940
|
-
|
|
941
|
-
// @public (undocumented)
|
|
942
|
-
type TeamMembershipSettings = 'MEMBER_INVITE' | 'OPEN';
|
|
943
|
-
|
|
944
|
-
// @public (undocumented)
|
|
945
|
-
type TeamPermission = 'FULL_READ' | 'FULL_WRITE' | 'NONE';
|
|
946
|
-
|
|
947
|
-
// @public (undocumented)
|
|
948
|
-
type TeamRestriction = 'NO_RESTRICTION' | 'ORG_MEMBERS';
|
|
949
|
-
|
|
950
|
-
// @public
|
|
951
|
-
export class TeamsClient {
|
|
952
|
-
constructor(context?: ClientContextProps);
|
|
953
|
-
acceptJoinRequest(
|
|
954
|
-
...args: Parameters<typeof defaultLegionClient.acceptJoinRequest>
|
|
955
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.acceptJoinRequest>>;
|
|
956
|
-
// @deprecated (undocumented)
|
|
957
|
-
acceptTeamInvitation(
|
|
958
|
-
...args: Parameters<typeof defaultLegionClient.acceptTeamInvitation>
|
|
959
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.acceptTeamInvitation>>;
|
|
960
|
-
addUsersToTeam(
|
|
961
|
-
...args: Parameters<typeof _default_3.addUsersToTeam>
|
|
962
|
-
): Promise<AwaitedReturn<typeof _default_3.addUsersToTeam>>;
|
|
963
|
-
cancelJoinRequest(teamId: string): Promise<void>;
|
|
964
|
-
createTeam(
|
|
965
|
-
...args: Parameters<typeof defaultLegionClient.createTeam>
|
|
966
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.createTeam>>;
|
|
967
|
-
createTeamLink(
|
|
968
|
-
...args: Parameters<typeof defaultLegionClient.createTeamLink>
|
|
969
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.createTeamLink>>;
|
|
970
|
-
declineJoinRequest(
|
|
971
|
-
...args: Parameters<typeof defaultLegionClient.declineJoinRequest>
|
|
972
|
-
): Promise<void>;
|
|
973
|
-
// @deprecated (undocumented)
|
|
974
|
-
declineTeamInvitation(
|
|
975
|
-
...args: Parameters<typeof defaultLegionClient.declineTeamInvitation>
|
|
976
|
-
): Promise<void>;
|
|
977
|
-
deleteTeam(teamId: string): Promise<void>;
|
|
978
|
-
deleteTeamLink(...args: Parameters<typeof defaultLegionClient.deleteTeamLink>): Promise<void>;
|
|
979
|
-
// @deprecated (undocumented)
|
|
980
|
-
deleteTeamMembership(
|
|
981
|
-
...args: Parameters<typeof defaultLegionClient.deleteTeamMembership>
|
|
982
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.deleteTeamMembership>>;
|
|
983
|
-
getAllTeams(
|
|
984
|
-
...args: Parameters<typeof defaultLegionClient.getAllTeams>
|
|
985
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.getAllTeams>>;
|
|
986
|
-
getIsSiteAdmin(
|
|
987
|
-
...args: Parameters<typeof _default_2.getIsSiteAdmin>
|
|
988
|
-
): Promise<AwaitedReturn<typeof _default_2.getIsSiteAdmin>>;
|
|
989
|
-
getMyTeamMembership(
|
|
990
|
-
...args: Parameters<typeof defaultLegionClient.getMyTeamMembership>
|
|
991
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.getMyTeamMembership>>;
|
|
992
|
-
getProfileWithMutability(
|
|
993
|
-
...args: Parameters<typeof _default.getProfileWithMutability>
|
|
994
|
-
): Promise<AwaitedReturn<typeof _default.getProfileWithMutability>>;
|
|
995
|
-
// (undocumented)
|
|
996
|
-
getRecommendedProducts(
|
|
997
|
-
...args: Parameters<typeof _default_4.getProductRecommendations>
|
|
998
|
-
): Promise<AwaitedReturn<typeof _default_4.getProductRecommendations>>;
|
|
999
|
-
// (undocumented)
|
|
1000
|
-
getTeamById(teamId: string): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamById>>;
|
|
1001
|
-
getTeamLinksByTeamId(
|
|
1002
|
-
teamId: string,
|
|
1003
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.getTeamLinksByTeamId>>;
|
|
1004
|
-
// @deprecated (undocumented)
|
|
1005
|
-
inviteUsersToTeam(
|
|
1006
|
-
...args: Parameters<typeof defaultLegionClient.inviteUsersToTeam>
|
|
1007
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.inviteUsersToTeam>>;
|
|
1008
|
-
// @deprecated (undocumented)
|
|
1009
|
-
isSingleFullMemberTeam(teamId: string): Promise<boolean>;
|
|
1010
|
-
// (undocumented)
|
|
1011
|
-
joinOrRequestDefaultAccessToProductsBulk(
|
|
1012
|
-
...args: Parameters<typeof _default_4.joinOrRequestDefaultAccessToProductsBulk>
|
|
1013
|
-
): Promise<AwaitedReturn<typeof _default_4.joinOrRequestDefaultAccessToProductsBulk>>;
|
|
1014
|
-
queryFeatureFlags(
|
|
1015
|
-
...args: Parameters<typeof directoryClient.queryFeatureFlags>
|
|
1016
|
-
): Promise<AwaitedReturn<typeof directoryClient.queryFeatureFlags>>;
|
|
1017
|
-
querySettings(
|
|
1018
|
-
...args: Parameters<typeof directoryClient.querySettings>
|
|
1019
|
-
): Promise<AwaitedReturn<typeof directoryClient.querySettings>>;
|
|
1020
|
-
queryTeamHealthMonitors(
|
|
1021
|
-
...args: Parameters<typeof atlasClient.queryTeamHealthMonitors>
|
|
1022
|
-
): Promise<AwaitedReturn<typeof atlasClient.queryTeamHealthMonitors>>;
|
|
1023
|
-
queryTeamMemberships(
|
|
1024
|
-
teamId: string,
|
|
1025
|
-
membershipState?: MembershipState[],
|
|
1026
|
-
pageInfo?: AGGPageInfoVariables,
|
|
1027
|
-
): Promise<ResultWithPageInfo<TeamMembership>>;
|
|
1028
|
-
queryUser(
|
|
1029
|
-
...args: Parameters<typeof directoryClient.queryUser>
|
|
1030
|
-
): Promise<AwaitedReturn<typeof directoryClient.queryUser>>;
|
|
1031
|
-
removeTeamMemberships(
|
|
1032
|
-
...args: Parameters<typeof _default_3.removeTeamMemberships>
|
|
1033
|
-
): Promise<AwaitedReturn<typeof _default_3.removeTeamMemberships>>;
|
|
1034
|
-
reorderTeamLink(
|
|
1035
|
-
...args: Parameters<typeof defaultLegionClient.reorderTeamLink>
|
|
1036
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.reorderTeamLink>>;
|
|
1037
|
-
// @deprecated (undocumented)
|
|
1038
|
-
revokeTeamInvite(
|
|
1039
|
-
...args: Parameters<typeof defaultLegionClient.revokeTeamInvite>
|
|
1040
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.revokeTeamInvite>>;
|
|
1041
|
-
selfJoinTeam(
|
|
1042
|
-
...args: Parameters<typeof defaultLegionClient.selfJoinTeam>
|
|
1043
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.selfJoinTeam>>;
|
|
1044
|
-
setBaseUrl(baseUrl: string): void;
|
|
1045
|
-
setContext(context: ClientContextProps): void;
|
|
1046
|
-
// @deprecated (undocumented)
|
|
1047
|
-
setDirectoryBaseUrl(baseUrl: string): void;
|
|
1048
|
-
// (undocumented)
|
|
1049
|
-
setLegionRootUrl(url: string): void;
|
|
1050
|
-
// (undocumented)
|
|
1051
|
-
trimTeamARI(teamId?: string): string;
|
|
1052
|
-
updateTeamById(
|
|
1053
|
-
...args: Parameters<typeof defaultLegionClient.updateTeamById>
|
|
1054
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.updateTeamById>>;
|
|
1055
|
-
updateTeamLink(
|
|
1056
|
-
...args: Parameters<typeof defaultLegionClient.updateTeamLink>
|
|
1057
|
-
): Promise<AwaitedReturn<typeof defaultLegionClient.updateTeamLink>>;
|
|
1058
|
-
}
|
|
1059
|
-
|
|
1060
|
-
// @public (undocumented)
|
|
1061
|
-
export const teamsClient: TeamsClient;
|
|
1062
|
-
|
|
1063
|
-
// @public (undocumented)
|
|
1064
|
-
interface TeamsClientUser {
|
|
1065
|
-
// (undocumented)
|
|
1066
|
-
avatarUrl?: string;
|
|
1067
|
-
// (undocumented)
|
|
1068
|
-
companyName?: string;
|
|
1069
|
-
// (undocumented)
|
|
1070
|
-
department?: string;
|
|
1071
|
-
// (undocumented)
|
|
1072
|
-
email?: string;
|
|
1073
|
-
// (undocumented)
|
|
1074
|
-
fullName: string;
|
|
1075
|
-
// (undocumented)
|
|
1076
|
-
headerImageUrl?: string;
|
|
1077
|
-
// (undocumented)
|
|
1078
|
-
id: string;
|
|
1079
|
-
// (undocumented)
|
|
1080
|
-
isBot?: boolean;
|
|
1081
|
-
// (undocumented)
|
|
1082
|
-
isCurrentUser?: boolean;
|
|
1083
|
-
// (undocumented)
|
|
1084
|
-
isNotMentionable?: boolean;
|
|
1085
|
-
// (undocumented)
|
|
1086
|
-
locale?: string;
|
|
1087
|
-
// (undocumented)
|
|
1088
|
-
localTime?: string;
|
|
1089
|
-
// (undocumented)
|
|
1090
|
-
location?: string;
|
|
1091
|
-
// (undocumented)
|
|
1092
|
-
nickname?: string;
|
|
1093
|
-
// (undocumented)
|
|
1094
|
-
phoneNumber?: string;
|
|
1095
|
-
// (undocumented)
|
|
1096
|
-
position?: string;
|
|
1097
|
-
// (undocumented)
|
|
1098
|
-
preferredLanguage?: string;
|
|
1099
|
-
// (undocumented)
|
|
1100
|
-
privacy?: UserPrivacy;
|
|
1101
|
-
// (undocumented)
|
|
1102
|
-
status?: UserStatus;
|
|
1103
|
-
// (undocumented)
|
|
1104
|
-
statusModifiedDate?: number;
|
|
1105
|
-
timezone?: string;
|
|
1106
|
-
// (undocumented)
|
|
1107
|
-
title?: string;
|
|
1108
|
-
}
|
|
1109
|
-
|
|
1110
|
-
// @public (undocumented)
|
|
1111
|
-
type TeamState = 'ACTIVE' | 'PURGED' | DeprecatedTeamState;
|
|
1112
|
-
|
|
1113
|
-
// @public
|
|
1114
|
-
interface TeamWithImageUrls extends Team, TeamAvatarImage {}
|
|
1115
|
-
|
|
1116
|
-
// @public (undocumented)
|
|
1117
|
-
interface TeamWithMemberships extends TeamWithImageUrls {
|
|
1118
|
-
// (undocumented)
|
|
1119
|
-
includesYou: boolean;
|
|
1120
|
-
// (undocumented)
|
|
1121
|
-
memberCount: number;
|
|
1122
|
-
// (undocumented)
|
|
1123
|
-
members: TeamMember[];
|
|
1124
|
-
}
|
|
1125
|
-
|
|
1126
|
-
// @public (undocumented)
|
|
1127
|
-
export const toTeamARI: (teamId: string) => TeamARI;
|
|
1128
|
-
|
|
1129
|
-
// @public (undocumented)
|
|
1130
|
-
export const toTeamId: (ari: TeamARI | string) => string;
|
|
1131
|
-
|
|
1132
|
-
// @public (undocumented)
|
|
1133
|
-
export const toUserARI: (userId: string) => UserARI;
|
|
1134
|
-
|
|
1135
|
-
// @public (undocumented)
|
|
1136
|
-
export const toUserId: (ari: UserARI | string) => string;
|
|
1137
|
-
|
|
1138
|
-
// @public (undocumented)
|
|
1139
|
-
const USER_ARI_PREFIX: 'ari:cloud:identity::user/';
|
|
1140
|
-
|
|
1141
|
-
// @public (undocumented)
|
|
1142
|
-
type UserAccessLevel = 'EXTERNAL' | 'INTERNAL' | 'INTERNAL_INACTIVE';
|
|
1143
|
-
|
|
1144
|
-
// @public (undocumented)
|
|
1145
|
-
type UserARI = `${typeof USER_ARI_PREFIX}${string}`;
|
|
1146
|
-
|
|
1147
|
-
// @public (undocumented)
|
|
1148
|
-
interface UserInfo {
|
|
1149
|
-
// (undocumented)
|
|
1150
|
-
avatarUrl: string;
|
|
1151
|
-
// (undocumented)
|
|
1152
|
-
email: string;
|
|
1153
|
-
// (undocumented)
|
|
1154
|
-
fullName: string;
|
|
1155
|
-
// (undocumented)
|
|
1156
|
-
locale: string;
|
|
1157
|
-
// (undocumented)
|
|
1158
|
-
title: string;
|
|
1159
|
-
// (undocumented)
|
|
1160
|
-
userId: string;
|
|
1161
|
-
}
|
|
1162
|
-
|
|
1163
|
-
// @public (undocumented)
|
|
1164
|
-
export class UserInfoProvider {
|
|
1165
|
-
// (undocumented)
|
|
1166
|
-
get(fetchOp?: typeof fetch): Promise<UserInfo>;
|
|
1167
|
-
}
|
|
1168
|
-
|
|
1169
|
-
// @public (undocumented)
|
|
1170
|
-
export const userInfoProvider: UserInfoProvider;
|
|
1171
|
-
|
|
1172
|
-
// @public (undocumented)
|
|
1173
|
-
interface UserPrivacy {
|
|
1174
|
-
// (undocumented)
|
|
1175
|
-
domain: string;
|
|
1176
|
-
// (undocumented)
|
|
1177
|
-
isBlacklistedDomain: boolean;
|
|
1178
|
-
// (undocumented)
|
|
1179
|
-
level: UserPrivacyLevel;
|
|
1180
|
-
}
|
|
1181
|
-
|
|
1182
|
-
// @public (undocumented)
|
|
1183
|
-
type UserPrivacyLevel = 'domain' | 'private' | 'public';
|
|
1184
|
-
|
|
1185
|
-
// @public (undocumented)
|
|
1186
|
-
type UserStatus = 'active' | 'closed' | 'inactive';
|
|
1187
|
-
|
|
1188
|
-
// @public (undocumented)
|
|
1189
|
-
export const useTeamsClientSetup: (
|
|
1190
|
-
stargateRoot?: string,
|
|
1191
|
-
cloudId?: null | string,
|
|
1192
|
-
orgId?: string,
|
|
1193
|
-
) => void;
|
|
1194
|
-
|
|
1195
|
-
// (No @packageDocumentation comment for this package)
|
|
1196
|
-
```
|
|
1197
|
-
|
|
1198
|
-
<!--SECTION END: Main Entry Types-->
|
|
1199
|
-
|
|
1200
|
-
### Peer Dependencies
|
|
1201
|
-
|
|
1202
|
-
<!--SECTION START: Peer Dependencies-->
|
|
1203
|
-
|
|
1204
|
-
```json
|
|
1205
|
-
{
|
|
1206
|
-
"react": "^16.8.0"
|
|
1207
|
-
}
|
|
1208
|
-
```
|
|
1209
|
-
|
|
1210
|
-
<!--SECTION END: Peer Dependencies-->
|