@wildix/xbees-users-client 4.3.3-wms28830.1 → 4.4.0-stage.1
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/dist-cjs/Users.js +17 -7
- package/dist-cjs/auth/httpAuthSchemeProvider.js +35 -16
- package/dist-cjs/commands/ApplyAccountWorkspaceChangesCommand.js +20 -0
- package/dist-cjs/commands/{LinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +6 -6
- package/dist-cjs/commands/ConfirmIdentityChallengeCommand.js +20 -0
- package/dist-cjs/commands/{VerifyIdentityCommand.js → ListAccountEmailChangesCommand.js} +6 -6
- package/dist-cjs/commands/ResendIdentityChallengeCodeCommand.js +20 -0
- package/dist-cjs/commands/{UnlinkIdentityCommand.js → StartIdentityChallengeCommand.js} +6 -6
- package/dist-cjs/commands/index.js +6 -3
- package/dist-cjs/index.js +1 -0
- package/dist-cjs/models/enums.js +88 -5
- package/dist-cjs/models/errors.js +144 -24
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListAccountEmailChangesPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +5 -0
- package/dist-cjs/schemas/schemas_0.js +431 -151
- package/dist-es/Users.js +17 -7
- package/dist-es/auth/httpAuthSchemeProvider.js +35 -16
- package/dist-es/commands/ApplyAccountWorkspaceChangesCommand.js +16 -0
- package/dist-es/commands/{UnlinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +5 -5
- package/dist-es/commands/ConfirmIdentityChallengeCommand.js +16 -0
- package/dist-es/commands/{LinkIdentityCommand.js → ListAccountEmailChangesCommand.js} +5 -5
- package/dist-es/commands/ResendIdentityChallengeCodeCommand.js +16 -0
- package/dist-es/commands/{VerifyIdentityCommand.js → StartIdentityChallengeCommand.js} +5 -5
- package/dist-es/commands/index.js +6 -3
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +87 -4
- package/dist-es/models/errors.js +132 -20
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAccountEmailChangesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/schemas/schemas_0.js +427 -147
- package/dist-types/Users.d.ts +46 -18
- package/dist-types/UsersClient.d.ts +8 -5
- package/dist-types/commands/ApplyAccountWorkspaceChangesCommand.d.ts +193 -0
- package/dist-types/commands/ApplyIdentityRemovalCommand.d.ts +93 -0
- package/dist-types/commands/ConfirmIdentityChallengeCommand.d.ts +138 -0
- package/dist-types/commands/ListAccountEmailChangesCommand.d.ts +101 -0
- package/dist-types/commands/ListIdentitiesCommand.d.ts +4 -2
- package/dist-types/commands/QueryUserCommand.d.ts +1 -1
- package/dist-types/commands/QueryUsersCommand.d.ts +1 -1
- package/dist-types/commands/ResendIdentityChallengeCodeCommand.d.ts +96 -0
- package/dist-types/commands/StartIdentityChallengeCommand.d.ts +139 -0
- package/dist-types/commands/UpdateAccountCommand.d.ts +2 -1
- package/dist-types/commands/index.d.ts +6 -3
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +344 -8
- package/dist-types/models/errors.d.ts +158 -17
- package/dist-types/models/models_0.d.ts +659 -69
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAccountEmailChangesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/schemas/schemas_0.d.ts +40 -9
- package/package.json +5 -5
- package/dist-types/commands/LinkIdentityCommand.d.ts +0 -89
- package/dist-types/commands/UnlinkIdentityCommand.d.ts +0 -85
- package/dist-types/commands/VerifyIdentityCommand.d.ts +0 -90
package/dist-types/Users.d.ts
CHANGED
|
@@ -1,9 +1,12 @@
|
|
|
1
|
-
import type { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
1
|
+
import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
|
|
2
|
+
import { type ApplyAccountWorkspaceChangesCommandInput, type ApplyAccountWorkspaceChangesCommandOutput } from "./commands/ApplyAccountWorkspaceChangesCommand";
|
|
3
|
+
import { type ApplyIdentityRemovalCommandInput, type ApplyIdentityRemovalCommandOutput } from "./commands/ApplyIdentityRemovalCommand";
|
|
2
4
|
import { type BatchGetUsersCommandInput, type BatchGetUsersCommandOutput } from "./commands/BatchGetUsersCommand";
|
|
3
5
|
import { type BatchGetUsersEmailNotificationsSettingsCommandInput, type BatchGetUsersEmailNotificationsSettingsCommandOutput } from "./commands/BatchGetUsersEmailNotificationsSettingsCommand";
|
|
4
6
|
import { type BatchGetUsersPbxLinkDataCommandInput, type BatchGetUsersPbxLinkDataCommandOutput } from "./commands/BatchGetUsersPbxLinkDataCommand";
|
|
5
7
|
import { type BatchGetUsersPbxLinkDataV1CommandInput, type BatchGetUsersPbxLinkDataV1CommandOutput } from "./commands/BatchGetUsersPbxLinkDataV1Command";
|
|
6
8
|
import { type ChangeUserEmailCommandInput, type ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
|
|
9
|
+
import { type ConfirmIdentityChallengeCommandInput, type ConfirmIdentityChallengeCommandOutput } from "./commands/ConfirmIdentityChallengeCommand";
|
|
7
10
|
import { type CreateAnonymousSessionCommandInput, type CreateAnonymousSessionCommandOutput } from "./commands/CreateAnonymousSessionCommand";
|
|
8
11
|
import { type CreateBotApiKeyCommandInput, type CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
|
|
9
12
|
import { type CreateBotCommandInput, type CreateBotCommandOutput } from "./commands/CreateBotCommand";
|
|
@@ -21,7 +24,7 @@ import { type GetUserPbxLinkSuggestionCommandInput, type GetUserPbxLinkSuggestio
|
|
|
21
24
|
import { type GetUserPbxLinkSuggestionV1CommandInput, type GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
|
|
22
25
|
import { type IntelligenceSearchCommandInput, type IntelligenceSearchCommandOutput } from "./commands/IntelligenceSearchCommand";
|
|
23
26
|
import { type InviteCommandInput, type InviteCommandOutput } from "./commands/InviteCommand";
|
|
24
|
-
import { type
|
|
27
|
+
import { type ListAccountEmailChangesCommandInput, type ListAccountEmailChangesCommandOutput } from "./commands/ListAccountEmailChangesCommand";
|
|
25
28
|
import { type ListBotApiKeysCommandInput, type ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
|
|
26
29
|
import { type ListBotsCommandInput, type ListBotsCommandOutput } from "./commands/ListBotsCommand";
|
|
27
30
|
import { type ListIdentitiesCommandInput, type ListIdentitiesCommandOutput } from "./commands/ListIdentitiesCommand";
|
|
@@ -30,10 +33,11 @@ import { type PartialUpdateUserEmailNotificationsSettingsCommandInput, type Part
|
|
|
30
33
|
import { type QueryColleaguesCommandInput, type QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
|
|
31
34
|
import { type QueryUserCommandInput, type QueryUserCommandOutput } from "./commands/QueryUserCommand";
|
|
32
35
|
import { type QueryUsersCommandInput, type QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
|
|
36
|
+
import { type ResendIdentityChallengeCodeCommandInput, type ResendIdentityChallengeCodeCommandOutput } from "./commands/ResendIdentityChallengeCodeCommand";
|
|
33
37
|
import { type ResetUserChatHistoryCommandInput, type ResetUserChatHistoryCommandOutput } from "./commands/ResetUserChatHistoryCommand";
|
|
38
|
+
import { type StartIdentityChallengeCommandInput, type StartIdentityChallengeCommandOutput } from "./commands/StartIdentityChallengeCommand";
|
|
34
39
|
import { type ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, type ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand";
|
|
35
40
|
import { type ToggleUnreadEmailNotificationsSubscriptionCommandInput, type ToggleUnreadEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleUnreadEmailNotificationsSubscriptionCommand";
|
|
36
|
-
import { type UnlinkIdentityCommandInput, type UnlinkIdentityCommandOutput } from "./commands/UnlinkIdentityCommand";
|
|
37
41
|
import { type UnlinkWorkspaceCommandInput, type UnlinkWorkspaceCommandOutput } from "./commands/UnlinkWorkspaceCommand";
|
|
38
42
|
import { type UpdateAccountCommandInput, type UpdateAccountCommandOutput } from "./commands/UpdateAccountCommand";
|
|
39
43
|
import { type UpdateBotCallbackCommandInput, type UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
|
|
@@ -44,9 +48,20 @@ import { type UploadPictureCommandInput, type UploadPictureCommandOutput } from
|
|
|
44
48
|
import { type UploadPictureV1CommandInput, type UploadPictureV1CommandOutput } from "./commands/UploadPictureV1Command";
|
|
45
49
|
import { type VerifyBotSecretKeyCommandInput, type VerifyBotSecretKeyCommandOutput } from "./commands/VerifyBotSecretKeyCommand";
|
|
46
50
|
import { type VerifyBotSecretKeyV1CommandInput, type VerifyBotSecretKeyV1CommandOutput } from "./commands/VerifyBotSecretKeyV1Command";
|
|
47
|
-
import { type VerifyIdentityCommandInput, type VerifyIdentityCommandOutput } from "./commands/VerifyIdentityCommand";
|
|
48
51
|
import { UsersClient } from "./UsersClient";
|
|
49
52
|
export interface Users {
|
|
53
|
+
/**
|
|
54
|
+
* @see {@link ApplyAccountWorkspaceChangesCommand}
|
|
55
|
+
*/
|
|
56
|
+
applyAccountWorkspaceChanges(args: ApplyAccountWorkspaceChangesCommandInput, options?: __HttpHandlerOptions): Promise<ApplyAccountWorkspaceChangesCommandOutput>;
|
|
57
|
+
applyAccountWorkspaceChanges(args: ApplyAccountWorkspaceChangesCommandInput, cb: (err: any, data?: ApplyAccountWorkspaceChangesCommandOutput) => void): void;
|
|
58
|
+
applyAccountWorkspaceChanges(args: ApplyAccountWorkspaceChangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyAccountWorkspaceChangesCommandOutput) => void): void;
|
|
59
|
+
/**
|
|
60
|
+
* @see {@link ApplyIdentityRemovalCommand}
|
|
61
|
+
*/
|
|
62
|
+
applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, options?: __HttpHandlerOptions): Promise<ApplyIdentityRemovalCommandOutput>;
|
|
63
|
+
applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, cb: (err: any, data?: ApplyIdentityRemovalCommandOutput) => void): void;
|
|
64
|
+
applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyIdentityRemovalCommandOutput) => void): void;
|
|
50
65
|
/**
|
|
51
66
|
* @see {@link BatchGetUsersCommand}
|
|
52
67
|
*/
|
|
@@ -77,6 +92,12 @@ export interface Users {
|
|
|
77
92
|
changeUserEmail(args: ChangeUserEmailCommandInput, options?: __HttpHandlerOptions): Promise<ChangeUserEmailCommandOutput>;
|
|
78
93
|
changeUserEmail(args: ChangeUserEmailCommandInput, cb: (err: any, data?: ChangeUserEmailCommandOutput) => void): void;
|
|
79
94
|
changeUserEmail(args: ChangeUserEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeUserEmailCommandOutput) => void): void;
|
|
95
|
+
/**
|
|
96
|
+
* @see {@link ConfirmIdentityChallengeCommand}
|
|
97
|
+
*/
|
|
98
|
+
confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmIdentityChallengeCommandOutput>;
|
|
99
|
+
confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, cb: (err: any, data?: ConfirmIdentityChallengeCommandOutput) => void): void;
|
|
100
|
+
confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmIdentityChallengeCommandOutput) => void): void;
|
|
80
101
|
/**
|
|
81
102
|
* @see {@link CreateAnonymousSessionCommand}
|
|
82
103
|
*/
|
|
@@ -182,11 +203,11 @@ export interface Users {
|
|
|
182
203
|
invite(args: InviteCommandInput, cb: (err: any, data?: InviteCommandOutput) => void): void;
|
|
183
204
|
invite(args: InviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteCommandOutput) => void): void;
|
|
184
205
|
/**
|
|
185
|
-
* @see {@link
|
|
206
|
+
* @see {@link ListAccountEmailChangesCommand}
|
|
186
207
|
*/
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
208
|
+
listAccountEmailChanges(args: ListAccountEmailChangesCommandInput, options?: __HttpHandlerOptions): Promise<ListAccountEmailChangesCommandOutput>;
|
|
209
|
+
listAccountEmailChanges(args: ListAccountEmailChangesCommandInput, cb: (err: any, data?: ListAccountEmailChangesCommandOutput) => void): void;
|
|
210
|
+
listAccountEmailChanges(args: ListAccountEmailChangesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccountEmailChangesCommandOutput) => void): void;
|
|
190
211
|
/**
|
|
191
212
|
* @see {@link ListBotApiKeysCommand}
|
|
192
213
|
*/
|
|
@@ -237,12 +258,24 @@ export interface Users {
|
|
|
237
258
|
queryUsers(args: QueryUsersCommandInput, options?: __HttpHandlerOptions): Promise<QueryUsersCommandOutput>;
|
|
238
259
|
queryUsers(args: QueryUsersCommandInput, cb: (err: any, data?: QueryUsersCommandOutput) => void): void;
|
|
239
260
|
queryUsers(args: QueryUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryUsersCommandOutput) => void): void;
|
|
261
|
+
/**
|
|
262
|
+
* @see {@link ResendIdentityChallengeCodeCommand}
|
|
263
|
+
*/
|
|
264
|
+
resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, options?: __HttpHandlerOptions): Promise<ResendIdentityChallengeCodeCommandOutput>;
|
|
265
|
+
resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, cb: (err: any, data?: ResendIdentityChallengeCodeCommandOutput) => void): void;
|
|
266
|
+
resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendIdentityChallengeCodeCommandOutput) => void): void;
|
|
240
267
|
/**
|
|
241
268
|
* @see {@link ResetUserChatHistoryCommand}
|
|
242
269
|
*/
|
|
243
270
|
resetUserChatHistory(args: ResetUserChatHistoryCommandInput, options?: __HttpHandlerOptions): Promise<ResetUserChatHistoryCommandOutput>;
|
|
244
271
|
resetUserChatHistory(args: ResetUserChatHistoryCommandInput, cb: (err: any, data?: ResetUserChatHistoryCommandOutput) => void): void;
|
|
245
272
|
resetUserChatHistory(args: ResetUserChatHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserChatHistoryCommandOutput) => void): void;
|
|
273
|
+
/**
|
|
274
|
+
* @see {@link StartIdentityChallengeCommand}
|
|
275
|
+
*/
|
|
276
|
+
startIdentityChallenge(args: StartIdentityChallengeCommandInput, options?: __HttpHandlerOptions): Promise<StartIdentityChallengeCommandOutput>;
|
|
277
|
+
startIdentityChallenge(args: StartIdentityChallengeCommandInput, cb: (err: any, data?: StartIdentityChallengeCommandOutput) => void): void;
|
|
278
|
+
startIdentityChallenge(args: StartIdentityChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartIdentityChallengeCommandOutput) => void): void;
|
|
246
279
|
/**
|
|
247
280
|
* @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommand}
|
|
248
281
|
*/
|
|
@@ -255,12 +288,6 @@ export interface Users {
|
|
|
255
288
|
toggleUnreadEmailNotificationsSubscription(args: ToggleUnreadEmailNotificationsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<ToggleUnreadEmailNotificationsSubscriptionCommandOutput>;
|
|
256
289
|
toggleUnreadEmailNotificationsSubscription(args: ToggleUnreadEmailNotificationsSubscriptionCommandInput, cb: (err: any, data?: ToggleUnreadEmailNotificationsSubscriptionCommandOutput) => void): void;
|
|
257
290
|
toggleUnreadEmailNotificationsSubscription(args: ToggleUnreadEmailNotificationsSubscriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ToggleUnreadEmailNotificationsSubscriptionCommandOutput) => void): void;
|
|
258
|
-
/**
|
|
259
|
-
* @see {@link UnlinkIdentityCommand}
|
|
260
|
-
*/
|
|
261
|
-
unlinkIdentity(args: UnlinkIdentityCommandInput, options?: __HttpHandlerOptions): Promise<UnlinkIdentityCommandOutput>;
|
|
262
|
-
unlinkIdentity(args: UnlinkIdentityCommandInput, cb: (err: any, data?: UnlinkIdentityCommandOutput) => void): void;
|
|
263
|
-
unlinkIdentity(args: UnlinkIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlinkIdentityCommandOutput) => void): void;
|
|
264
291
|
/**
|
|
265
292
|
* @see {@link UnlinkWorkspaceCommand}
|
|
266
293
|
*/
|
|
@@ -322,11 +349,12 @@ export interface Users {
|
|
|
322
349
|
verifyBotSecretKeyV1(args: VerifyBotSecretKeyV1CommandInput, cb: (err: any, data?: VerifyBotSecretKeyV1CommandOutput) => void): void;
|
|
323
350
|
verifyBotSecretKeyV1(args: VerifyBotSecretKeyV1CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyBotSecretKeyV1CommandOutput) => void): void;
|
|
324
351
|
/**
|
|
325
|
-
* @see {@link
|
|
352
|
+
* @see {@link ListAccountEmailChangesCommand}
|
|
353
|
+
* @param args - command input.
|
|
354
|
+
* @param paginationConfig - optional pagination config.
|
|
355
|
+
* @returns AsyncIterable of {@link ListAccountEmailChangesCommandOutput}.
|
|
326
356
|
*/
|
|
327
|
-
|
|
328
|
-
verifyIdentity(args: VerifyIdentityCommandInput, cb: (err: any, data?: VerifyIdentityCommandOutput) => void): void;
|
|
329
|
-
verifyIdentity(args: VerifyIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyIdentityCommandOutput) => void): void;
|
|
357
|
+
paginateListAccountEmailChanges(args: ListAccountEmailChangesCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListAccountEmailChangesCommandOutput>;
|
|
330
358
|
}
|
|
331
359
|
/**
|
|
332
360
|
* @public
|
|
@@ -5,11 +5,14 @@ import { type HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/cor
|
|
|
5
5
|
import { type RetryInputConfig, type RetryResolvedConfig } from "@smithy/core/retry";
|
|
6
6
|
import type { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
|
|
7
7
|
import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
8
|
+
import type { ApplyAccountWorkspaceChangesCommandInput, ApplyAccountWorkspaceChangesCommandOutput } from "./commands/ApplyAccountWorkspaceChangesCommand";
|
|
9
|
+
import type { ApplyIdentityRemovalCommandInput, ApplyIdentityRemovalCommandOutput } from "./commands/ApplyIdentityRemovalCommand";
|
|
8
10
|
import type { BatchGetUsersCommandInput, BatchGetUsersCommandOutput } from "./commands/BatchGetUsersCommand";
|
|
9
11
|
import type { BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput } from "./commands/BatchGetUsersEmailNotificationsSettingsCommand";
|
|
10
12
|
import type { BatchGetUsersPbxLinkDataCommandInput, BatchGetUsersPbxLinkDataCommandOutput } from "./commands/BatchGetUsersPbxLinkDataCommand";
|
|
11
13
|
import type { BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1CommandOutput } from "./commands/BatchGetUsersPbxLinkDataV1Command";
|
|
12
14
|
import type { ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
|
|
15
|
+
import type { ConfirmIdentityChallengeCommandInput, ConfirmIdentityChallengeCommandOutput } from "./commands/ConfirmIdentityChallengeCommand";
|
|
13
16
|
import type { CreateAnonymousSessionCommandInput, CreateAnonymousSessionCommandOutput } from "./commands/CreateAnonymousSessionCommand";
|
|
14
17
|
import type { CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
|
|
15
18
|
import type { CreateBotCommandInput, CreateBotCommandOutput } from "./commands/CreateBotCommand";
|
|
@@ -27,7 +30,7 @@ import type { GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionComm
|
|
|
27
30
|
import type { GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
|
|
28
31
|
import type { IntelligenceSearchCommandInput, IntelligenceSearchCommandOutput } from "./commands/IntelligenceSearchCommand";
|
|
29
32
|
import type { InviteCommandInput, InviteCommandOutput } from "./commands/InviteCommand";
|
|
30
|
-
import type {
|
|
33
|
+
import type { ListAccountEmailChangesCommandInput, ListAccountEmailChangesCommandOutput } from "./commands/ListAccountEmailChangesCommand";
|
|
31
34
|
import type { ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
|
|
32
35
|
import type { ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
|
|
33
36
|
import type { ListIdentitiesCommandInput, ListIdentitiesCommandOutput } from "./commands/ListIdentitiesCommand";
|
|
@@ -36,10 +39,11 @@ import type { PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUp
|
|
|
36
39
|
import type { QueryColleaguesCommandInput, QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
|
|
37
40
|
import type { QueryUserCommandInput, QueryUserCommandOutput } from "./commands/QueryUserCommand";
|
|
38
41
|
import type { QueryUsersCommandInput, QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
|
|
42
|
+
import type { ResendIdentityChallengeCodeCommandInput, ResendIdentityChallengeCodeCommandOutput } from "./commands/ResendIdentityChallengeCodeCommand";
|
|
39
43
|
import type { ResetUserChatHistoryCommandInput, ResetUserChatHistoryCommandOutput } from "./commands/ResetUserChatHistoryCommand";
|
|
44
|
+
import type { StartIdentityChallengeCommandInput, StartIdentityChallengeCommandOutput } from "./commands/StartIdentityChallengeCommand";
|
|
40
45
|
import type { ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand";
|
|
41
46
|
import type { ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleUnreadEmailNotificationsSubscriptionCommand";
|
|
42
|
-
import type { UnlinkIdentityCommandInput, UnlinkIdentityCommandOutput } from "./commands/UnlinkIdentityCommand";
|
|
43
47
|
import type { UnlinkWorkspaceCommandInput, UnlinkWorkspaceCommandOutput } from "./commands/UnlinkWorkspaceCommand";
|
|
44
48
|
import type { UpdateAccountCommandInput, UpdateAccountCommandOutput } from "./commands/UpdateAccountCommand";
|
|
45
49
|
import type { UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
|
|
@@ -50,18 +54,17 @@ import type { UploadPictureCommandInput, UploadPictureCommandOutput } from "./co
|
|
|
50
54
|
import type { UploadPictureV1CommandInput, UploadPictureV1CommandOutput } from "./commands/UploadPictureV1Command";
|
|
51
55
|
import type { VerifyBotSecretKeyCommandInput, VerifyBotSecretKeyCommandOutput } from "./commands/VerifyBotSecretKeyCommand";
|
|
52
56
|
import type { VerifyBotSecretKeyV1CommandInput, VerifyBotSecretKeyV1CommandOutput } from "./commands/VerifyBotSecretKeyV1Command";
|
|
53
|
-
import type { VerifyIdentityCommandInput, VerifyIdentityCommandOutput } from "./commands/VerifyIdentityCommand";
|
|
54
57
|
import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
|
|
55
58
|
import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
56
59
|
export { __Client };
|
|
57
60
|
/**
|
|
58
61
|
* @public
|
|
59
62
|
*/
|
|
60
|
-
export type ServiceInputTypes = BatchGetUsersCommandInput | BatchGetUsersEmailNotificationsSettingsCommandInput | BatchGetUsersPbxLinkDataCommandInput | BatchGetUsersPbxLinkDataV1CommandInput | ChangeUserEmailCommandInput | CreateAnonymousSessionCommandInput | CreateBotApiKeyCommandInput | CreateBotCommandInput | CreateSystemBotCommandInput | DeleteBotApiKeyCommandInput | DeleteBotCommandInput | GetAccountCommandInput | GetAppVersionCommandInput | GetBotCallbackCommandInput | GetBotCommandInput | GetUserCommandInput | GetUserEmailNotificationsSettingsCommandInput | GetUserPbxLinkDataCommandInput | GetUserPbxLinkSuggestionCommandInput | GetUserPbxLinkSuggestionV1CommandInput | IntelligenceSearchCommandInput | InviteCommandInput |
|
|
63
|
+
export type ServiceInputTypes = ApplyAccountWorkspaceChangesCommandInput | ApplyIdentityRemovalCommandInput | BatchGetUsersCommandInput | BatchGetUsersEmailNotificationsSettingsCommandInput | BatchGetUsersPbxLinkDataCommandInput | BatchGetUsersPbxLinkDataV1CommandInput | ChangeUserEmailCommandInput | ConfirmIdentityChallengeCommandInput | CreateAnonymousSessionCommandInput | CreateBotApiKeyCommandInput | CreateBotCommandInput | CreateSystemBotCommandInput | DeleteBotApiKeyCommandInput | DeleteBotCommandInput | GetAccountCommandInput | GetAppVersionCommandInput | GetBotCallbackCommandInput | GetBotCommandInput | GetUserCommandInput | GetUserEmailNotificationsSettingsCommandInput | GetUserPbxLinkDataCommandInput | GetUserPbxLinkSuggestionCommandInput | GetUserPbxLinkSuggestionV1CommandInput | IntelligenceSearchCommandInput | InviteCommandInput | ListAccountEmailChangesCommandInput | ListBotApiKeysCommandInput | ListBotsCommandInput | ListIdentitiesCommandInput | ListWorkspacesCommandInput | PartialUpdateUserEmailNotificationsSettingsCommandInput | QueryColleaguesCommandInput | QueryUserCommandInput | QueryUsersCommandInput | ResendIdentityChallengeCodeCommandInput | ResetUserChatHistoryCommandInput | StartIdentityChallengeCommandInput | ToggleTranscriptionEmailNotificationsSubscriptionCommandInput | ToggleUnreadEmailNotificationsSubscriptionCommandInput | UnlinkWorkspaceCommandInput | UpdateAccountCommandInput | UpdateBotCallbackCommandInput | UpdateBotCommandInput | UpdateUserEmailNotificationsSettingsCommandInput | UpdateWorkspaceCommandInput | UploadPictureCommandInput | UploadPictureV1CommandInput | VerifyBotSecretKeyCommandInput | VerifyBotSecretKeyV1CommandInput;
|
|
61
64
|
/**
|
|
62
65
|
* @public
|
|
63
66
|
*/
|
|
64
|
-
export type ServiceOutputTypes = BatchGetUsersCommandOutput | BatchGetUsersEmailNotificationsSettingsCommandOutput | BatchGetUsersPbxLinkDataCommandOutput | BatchGetUsersPbxLinkDataV1CommandOutput | ChangeUserEmailCommandOutput | CreateAnonymousSessionCommandOutput | CreateBotApiKeyCommandOutput | CreateBotCommandOutput | CreateSystemBotCommandOutput | DeleteBotApiKeyCommandOutput | DeleteBotCommandOutput | GetAccountCommandOutput | GetAppVersionCommandOutput | GetBotCallbackCommandOutput | GetBotCommandOutput | GetUserCommandOutput | GetUserEmailNotificationsSettingsCommandOutput | GetUserPbxLinkDataCommandOutput | GetUserPbxLinkSuggestionCommandOutput | GetUserPbxLinkSuggestionV1CommandOutput | IntelligenceSearchCommandOutput | InviteCommandOutput |
|
|
67
|
+
export type ServiceOutputTypes = ApplyAccountWorkspaceChangesCommandOutput | ApplyIdentityRemovalCommandOutput | BatchGetUsersCommandOutput | BatchGetUsersEmailNotificationsSettingsCommandOutput | BatchGetUsersPbxLinkDataCommandOutput | BatchGetUsersPbxLinkDataV1CommandOutput | ChangeUserEmailCommandOutput | ConfirmIdentityChallengeCommandOutput | CreateAnonymousSessionCommandOutput | CreateBotApiKeyCommandOutput | CreateBotCommandOutput | CreateSystemBotCommandOutput | DeleteBotApiKeyCommandOutput | DeleteBotCommandOutput | GetAccountCommandOutput | GetAppVersionCommandOutput | GetBotCallbackCommandOutput | GetBotCommandOutput | GetUserCommandOutput | GetUserEmailNotificationsSettingsCommandOutput | GetUserPbxLinkDataCommandOutput | GetUserPbxLinkSuggestionCommandOutput | GetUserPbxLinkSuggestionV1CommandOutput | IntelligenceSearchCommandOutput | InviteCommandOutput | ListAccountEmailChangesCommandOutput | ListBotApiKeysCommandOutput | ListBotsCommandOutput | ListIdentitiesCommandOutput | ListWorkspacesCommandOutput | PartialUpdateUserEmailNotificationsSettingsCommandOutput | QueryColleaguesCommandOutput | QueryUserCommandOutput | QueryUsersCommandOutput | ResendIdentityChallengeCodeCommandOutput | ResetUserChatHistoryCommandOutput | StartIdentityChallengeCommandOutput | ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput | ToggleUnreadEmailNotificationsSubscriptionCommandOutput | UnlinkWorkspaceCommandOutput | UpdateAccountCommandOutput | UpdateBotCallbackCommandOutput | UpdateBotCommandOutput | UpdateUserEmailNotificationsSettingsCommandOutput | UpdateWorkspaceCommandOutput | UploadPictureCommandOutput | UploadPictureV1CommandOutput | VerifyBotSecretKeyCommandOutput | VerifyBotSecretKeyV1CommandOutput;
|
|
65
68
|
/**
|
|
66
69
|
* @public
|
|
67
70
|
*/
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ApplyAccountWorkspaceChangesInput, ApplyAccountWorkspaceChangesOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ApplyAccountWorkspaceChangesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ApplyAccountWorkspaceChangesCommandInput extends ApplyAccountWorkspaceChangesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ApplyAccountWorkspaceChangesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ApplyAccountWorkspaceChangesCommandOutput extends ApplyAccountWorkspaceChangesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ApplyAccountWorkspaceChangesCommand_base: {
|
|
25
|
+
new (input: ApplyAccountWorkspaceChangesCommandInput): import("@smithy/core/client").CommandImpl<ApplyAccountWorkspaceChangesCommandInput, ApplyAccountWorkspaceChangesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ApplyAccountWorkspaceChangesCommandInput): import("@smithy/core/client").CommandImpl<ApplyAccountWorkspaceChangesCommandInput, ApplyAccountWorkspaceChangesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Previews or applies a set of changes to the workspaces of one or several x-bees accounts as one plan and one transaction: attach a workspace (taken from another account, or a detached one that belongs to no account), detach a workspace, make a workspace the default one. Every change names the account it acts on, so a whole board draft (for example a detach on an orphaned account plus a make-default on the login account) is applied atomically or not at all. Built for Stream Console; the owner (x-bees users service) is the only place the rules live.
|
|
31
|
+
*
|
|
32
|
+
* Callers: s2s (service-to-service) only, and only the service clients allowed to change account workspaces; any other caller gets ForbiddenException. x-bees tokens and API keys are refused.
|
|
33
|
+
*
|
|
34
|
+
* `dryRun: true` (preview) never writes anything: no DynamoDB write, no lock, no side effect. It always answers 200 with the planned `writes`, the `after` state and every `checks` entry, including the blocking ones (a stale `expected` is a blocking check `conflict`, a refusal is a blocking check with its code); it does not throw for them. Only malformed requests (ValidationException), an unknown `accountId` of a change (AccountNotFoundException) and a refused caller (ForbiddenException) throw in a dry run. Dry-run timestamps in `after` (e.g. `domainLinkedAt`) are those of the dry run: a backup must be built from the output of the apply call, not from the dry run's.
|
|
35
|
+
*
|
|
36
|
+
* `dryRun: false` (apply) re-runs every check against freshly read rows. When any check is blocking it writes nothing and throws: AccountWorkspaceConflictException for a stale `expected` (the row and the field that differ), AccountWorkspaceChangeRefusedException with the refusal `code` otherwise. When no check is blocking it takes the stream-link locks of the touched workspaces, writes every row of every touched account in one DynamoDB transaction conditional on `expected` (a row that changed in the meantime still ends in AccountWorkspaceConflictException with nothing written), then runs the post-commit side effects and reports each in `effects`. A failed side effect does not undo the committed change.
|
|
37
|
+
*
|
|
38
|
+
* Rules the checks enforce (dry run and apply alike):
|
|
39
|
+
* - The per-account rules below run per account inside the one plan: an account's default, orphan state and `no_default` are judged on its state after all the changes of the call.
|
|
40
|
+
* - Optimistic concurrency: every row the change touches must be in `expected` with the values the caller read (`expected_incomplete` when a row is missing, `conflict` when a value differs). `lastUsedAt` is never part of `expected`: a sign-in is not a conflict.
|
|
41
|
+
* - attach with `fromAccountId` moves the membership of `workspaceId` from the account `fromAccountId` to the change's `accountId`, keeping its `type`. The workspace must be a membership of `fromAccountId` (`workspace_not_in_source_account`) and not yet of `accountId` (`workspace_already_in_account`).
|
|
42
|
+
* - attach without `fromAccountId` attaches a workspace that has no membership in any account (the board's Detached column, or one just detached in an earlier call). The owner checks that through the `AccountsByWorkspace` index and refuses with `workspace_has_account` when the workspace is a member of any account (the index is eventually consistent, so the check is best effort; concurrent attaches of one workspace are serialized by its stream-link lock); `fromAccountId` is required when it is a member of another account.
|
|
43
|
+
* - detach removes only the membership of `workspaceId` from the change's `accountId` (`workspace_not_in_account` when it has none); the Stream and Pbx rows of the workspace and its channels stay.
|
|
44
|
+
* - makeDefault sets `Settings.defaultWorkspace` of the change's `accountId` to `workspaceId` (`workspace_not_in_account` when it is not a membership of that account; the current default is a no-op). The PBX link moves with the default: a workspace of the same company, or a personal workspace without a link, takes the link (a personal one becomes work, `pbx_link_moves`); a workspace of another company with its own link keeps it and only the default changes (`pbx_link_stays`); a workspace of another company without a link is refused (`pbx_other_company`: the PBX link does not move there).
|
|
45
|
+
* - Default of an orphaned account (an account with no identity left) that loses its default workspace, by detach or because attach takes it away: the default moves to its remaining active workspace with the latest `lastUsedAt` (`orphan_default_moved`; the candidates are its active workspaces after all the changes of the call, and the PBX link does not move to an automatically chosen default); when none is left a new personal workspace is created and becomes the default (`orphan_personal_workspace_created`). A login account (one that still has an identity) never gets an automatic default: leaving it without one is refused (`no_default`).
|
|
46
|
+
* - Refused as well: a workspace whose Stream email belongs to another person (`foreign_stream_email`); a deleted workspace (`deleted_workspace`); a plan larger than one DynamoDB transaction (`too_many_writes`).
|
|
47
|
+
*
|
|
48
|
+
* - The owner adds condition checks to the same transaction on the rows it picks or relies on by itself (the orphan's chosen fallback membership, its identity-less state), so `expected` need not name them.
|
|
49
|
+
* - A new default re-routes email resolution (direct messages, invites, call messages) to it (`email_routing_changes`, not blocking).
|
|
50
|
+
*
|
|
51
|
+
* Inverse and backup: the output is enough to record a backup and to build the inverse plan as `changes` of this same operation: detach is undone by attach without `fromAccountId`, attach from an account by attach back to that account (with `fromAccountId` the account it went to), makeDefault by makeDefault of the previous default (see `before` of the `Settings` write). The one exception is the new personal workspace of an orphaned account, which has no inverse change. Pbx rows in `writes` never carry `sipPassword` or `xmppPassword`, so a Pbx row restored from the backup lacks them: a restored PBX link needs a re-link or refresh from the PBX.
|
|
52
|
+
*
|
|
53
|
+
* Side effects after the commit (see `effects`): `custom:wid` set to the new default on every Cognito user of every identity of the account (all users of one address: native and federated; a phone identity by its sign-in address `<E.164 without +>@phone.wildix.com`), applied at the user's next token refresh without revoking sessions; the workspaces cache invalidated for every touched account; the GetStream PBX fields moved; the external-flag job scheduled for the workspaces the PBX link left and reached.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
57
|
+
* ```javascript
|
|
58
|
+
* import { UsersClient, ApplyAccountWorkspaceChangesCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
59
|
+
* // const { UsersClient, ApplyAccountWorkspaceChangesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
60
|
+
* // import type { UsersClientConfig } from "@wildix/xbees-users-client";
|
|
61
|
+
* const config = {}; // type is UsersClientConfig
|
|
62
|
+
* const client = new UsersClient(config);
|
|
63
|
+
* const input = { // ApplyAccountWorkspaceChangesInput
|
|
64
|
+
* changes: [ // AccountWorkspaceChangeList // required
|
|
65
|
+
* { // AccountWorkspaceChange
|
|
66
|
+
* accountId: "STRING_VALUE", // required
|
|
67
|
+
* op: "attach" || "detach" || "makeDefault", // required
|
|
68
|
+
* workspaceId: "STRING_VALUE", // required
|
|
69
|
+
* fromAccountId: "STRING_VALUE",
|
|
70
|
+
* },
|
|
71
|
+
* ],
|
|
72
|
+
* expected: [ // AccountWorkspaceExpectedRowList // required
|
|
73
|
+
* { // AccountWorkspaceExpectedRow
|
|
74
|
+
* pk: "STRING_VALUE", // required
|
|
75
|
+
* sk: "STRING_VALUE", // required
|
|
76
|
+
* fields: { // AccountWorkspaceRowFields
|
|
77
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
78
|
+
* },
|
|
79
|
+
* },
|
|
80
|
+
* ],
|
|
81
|
+
* dryRun: true || false, // required
|
|
82
|
+
* operator: { // AccountWorkspaceChangeOperator
|
|
83
|
+
* email: "STRING_VALUE", // required
|
|
84
|
+
* id: "STRING_VALUE",
|
|
85
|
+
* name: "STRING_VALUE",
|
|
86
|
+
* },
|
|
87
|
+
* reason: "STRING_VALUE", // required
|
|
88
|
+
* };
|
|
89
|
+
* const command = new ApplyAccountWorkspaceChangesCommand(input);
|
|
90
|
+
* const response = await client.send(command);
|
|
91
|
+
* // { // ApplyAccountWorkspaceChangesOutput
|
|
92
|
+
* // writes: [ // AccountWorkspaceWriteList // required
|
|
93
|
+
* // { // AccountWorkspaceWrite
|
|
94
|
+
* // pk: "STRING_VALUE", // required
|
|
95
|
+
* // sk: "STRING_VALUE", // required
|
|
96
|
+
* // kind: "put" || "update" || "delete" || "append", // required
|
|
97
|
+
* // entity: "membership" || "accountSettings" || "pbx" || "stream" || "pbxUser", // required
|
|
98
|
+
* // before: { // AccountWorkspaceRowFields
|
|
99
|
+
* // "<keys>": "DOCUMENT_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // after: {
|
|
102
|
+
* // "<keys>": "DOCUMENT_VALUE",
|
|
103
|
+
* // },
|
|
104
|
+
* // },
|
|
105
|
+
* // ],
|
|
106
|
+
* // after: [ // AccountWorkspacesStateList // required
|
|
107
|
+
* // { // AccountWorkspacesState
|
|
108
|
+
* // accountId: "STRING_VALUE", // required
|
|
109
|
+
* // defaultWorkspace: "STRING_VALUE",
|
|
110
|
+
* // workspaces: [ // AccountWorkspaceStateList // required
|
|
111
|
+
* // { // AccountWorkspaceState
|
|
112
|
+
* // id: "STRING_VALUE", // required
|
|
113
|
+
* // type: "personal" || "work" || "support",
|
|
114
|
+
* // active: true || false, // required
|
|
115
|
+
* // isDefault: true || false, // required
|
|
116
|
+
* // companyId: "STRING_VALUE",
|
|
117
|
+
* // pbxLink: { // AccountWorkspacePbxLink
|
|
118
|
+
* // companyId: "STRING_VALUE", // required
|
|
119
|
+
* // domain: "STRING_VALUE", // required
|
|
120
|
+
* // serial: "STRING_VALUE", // required
|
|
121
|
+
* // pbxUserId: "STRING_VALUE",
|
|
122
|
+
* // extension: "STRING_VALUE",
|
|
123
|
+
* // },
|
|
124
|
+
* // created: true || false,
|
|
125
|
+
* // },
|
|
126
|
+
* // ],
|
|
127
|
+
* // },
|
|
128
|
+
* // ],
|
|
129
|
+
* // checks: [ // AccountWorkspaceCheckList // required
|
|
130
|
+
* // { // AccountWorkspaceCheck
|
|
131
|
+
* // code: "conflict" || "expected_incomplete" || "workspace_not_in_source_account" || "workspace_has_account" || "workspace_already_in_account" || "workspace_not_in_account" || "foreign_stream_email" || "deleted_workspace" || "no_default" || "pbx_other_company" || "too_many_writes" || "pbx_link_moves" || "pbx_link_stays" || "orphan_default_moved" || "orphan_personal_workspace_created" || "email_routing_changes", // required
|
|
132
|
+
* // blocking: true || false, // required
|
|
133
|
+
* // row: { // AccountWorkspaceRowKey
|
|
134
|
+
* // pk: "STRING_VALUE", // required
|
|
135
|
+
* // sk: "STRING_VALUE", // required
|
|
136
|
+
* // },
|
|
137
|
+
* // field: "STRING_VALUE",
|
|
138
|
+
* // accountId: "STRING_VALUE",
|
|
139
|
+
* // workspaceId: "STRING_VALUE",
|
|
140
|
+
* // message: "STRING_VALUE", // required
|
|
141
|
+
* // },
|
|
142
|
+
* // ],
|
|
143
|
+
* // effects: [ // AccountWorkspaceEffectList // required
|
|
144
|
+
* // { // AccountWorkspaceEffect
|
|
145
|
+
* // name: "cognito" || "cache" || "stream" || "job", // required
|
|
146
|
+
* // status: "ok" || "failed" || "skipped", // required
|
|
147
|
+
* // target: "STRING_VALUE",
|
|
148
|
+
* // detail: "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // ],
|
|
151
|
+
* // };
|
|
152
|
+
*
|
|
153
|
+
* ```
|
|
154
|
+
*
|
|
155
|
+
* @param ApplyAccountWorkspaceChangesCommandInput - {@link ApplyAccountWorkspaceChangesCommandInput}
|
|
156
|
+
* @returns {@link ApplyAccountWorkspaceChangesCommandOutput}
|
|
157
|
+
* @see {@link ApplyAccountWorkspaceChangesCommandInput} for command's `input` shape.
|
|
158
|
+
* @see {@link ApplyAccountWorkspaceChangesCommandOutput} for command's `response` shape.
|
|
159
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
160
|
+
*
|
|
161
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link AccountWorkspaceConflictException} (client fault)
|
|
164
|
+
* A row the change touches no longer holds the values in `expected` (another writer changed it after the caller read it). Nothing was written. When several rows differ, the first one found is named; a dry run lists every one as a `conflict` check. Read the rows again and retry with fresh `expected`.
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link AccountWorkspaceChangeRefusedException} (client fault)
|
|
167
|
+
* The change breaks a rule of the owner and is refused (an apply whose checks hold a blocking refusal). Nothing was written. When several refusals apply, the first one found is named; a dry run lists every one as a blocking check.
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link ValidationException} (client fault)
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
174
|
+
*
|
|
175
|
+
* @throws {@link UsersServiceException}
|
|
176
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
177
|
+
*
|
|
178
|
+
*
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
export declare class ApplyAccountWorkspaceChangesCommand extends ApplyAccountWorkspaceChangesCommand_base {
|
|
182
|
+
/** @internal type navigation helper, not in runtime. */
|
|
183
|
+
protected static __types: {
|
|
184
|
+
api: {
|
|
185
|
+
input: ApplyAccountWorkspaceChangesInput;
|
|
186
|
+
output: ApplyAccountWorkspaceChangesOutput;
|
|
187
|
+
};
|
|
188
|
+
sdk: {
|
|
189
|
+
input: ApplyAccountWorkspaceChangesCommandInput;
|
|
190
|
+
output: ApplyAccountWorkspaceChangesCommandOutput;
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ApplyIdentityRemovalInput, ApplyIdentityRemovalOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ApplyIdentityRemovalCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ApplyIdentityRemovalCommandInput extends ApplyIdentityRemovalInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ApplyIdentityRemovalCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ApplyIdentityRemovalCommandOutput extends ApplyIdentityRemovalOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ApplyIdentityRemovalCommand_base: {
|
|
25
|
+
new (input: ApplyIdentityRemovalCommandInput): import("@smithy/core/client").CommandImpl<ApplyIdentityRemovalCommandInput, ApplyIdentityRemovalCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ApplyIdentityRemovalCommandInput): import("@smithy/core/client").CommandImpl<ApplyIdentityRemovalCommandInput, ApplyIdentityRemovalCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes the address of a `remove` challenge whose primary code has been confirmed (`step: readyToApply`); uses up the challenge. Signs out and revokes the sessions and devices signed in with the address (including the calling session, when it signed in with it), and deactivates the company workspaces for which it was the last link, as the challenge's `dryRun` said. A challenge that is unknown, already used, expired, or of another account gives `ChallengeNotFoundException` (which one is not revealed); the app starts the dialog again. A challenge that is not `readyToApply` gives `ValidationException`. If the Cognito cleanup (signing out and revoking the sessions and devices) fails, `ServiceUnavailableException` is returned: the challenge is not used up and the call may be retried. Available via s2s (service-to-service) or the x-bees token of the account owner; API keys are refused.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, ApplyIdentityRemovalCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, ApplyIdentityRemovalCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* // import type { UsersClientConfig } from "@wildix/xbees-users-client";
|
|
37
|
+
* const config = {}; // type is UsersClientConfig
|
|
38
|
+
* const client = new UsersClient(config);
|
|
39
|
+
* const input = { // ApplyIdentityRemovalInput
|
|
40
|
+
* accountId: "STRING_VALUE", // required
|
|
41
|
+
* challengeId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new ApplyIdentityRemovalCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param ApplyIdentityRemovalCommandInput - {@link ApplyIdentityRemovalCommandInput}
|
|
50
|
+
* @returns {@link ApplyIdentityRemovalCommandOutput}
|
|
51
|
+
* @see {@link ApplyIdentityRemovalCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link ApplyIdentityRemovalCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
58
|
+
* The address is not a sign-in method of the account (or no longer is).
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
61
|
+
* The primary sign-in method cannot be removed; make another verified address primary first.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ChallengeNotFoundException} (client fault)
|
|
64
|
+
* The challenge is unknown, already used, expired, or belongs to another account; the message does not say which. The challenge cannot go on: start the change again with `StartIdentityChallenge`.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
69
|
+
* The service is temporarily unable to handle the request; retry later.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link UsersServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class ApplyIdentityRemovalCommand extends ApplyIdentityRemovalCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: ApplyIdentityRemovalInput;
|
|
86
|
+
output: {};
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: ApplyIdentityRemovalCommandInput;
|
|
90
|
+
output: ApplyIdentityRemovalCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|