@wildix/xbees-users-client 4.3.0 → 4.3.3-wms26787.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.
Files changed (42) hide show
  1. package/dist-cjs/Users.js +8 -6
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +63 -0
  3. package/dist-cjs/commands/{LinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +6 -6
  4. package/dist-cjs/commands/{VerifyIdentityCommand.js → ConfirmIdentityChallengeCommand.js} +6 -6
  5. package/dist-cjs/commands/ResendIdentityChallengeCodeCommand.js +20 -0
  6. package/dist-cjs/commands/{UnlinkIdentityCommand.js → StartIdentityChallengeCommand.js} +6 -6
  7. package/dist-cjs/commands/index.js +4 -3
  8. package/dist-cjs/models/enums.js +17 -1
  9. package/dist-cjs/models/errors.js +106 -24
  10. package/dist-cjs/schemas/schemas_0.js +183 -89
  11. package/dist-es/Users.js +8 -6
  12. package/dist-es/auth/httpAuthSchemeProvider.js +63 -0
  13. package/dist-es/commands/{UnlinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +5 -5
  14. package/dist-es/commands/{LinkIdentityCommand.js → ConfirmIdentityChallengeCommand.js} +5 -5
  15. package/dist-es/commands/ResendIdentityChallengeCodeCommand.js +16 -0
  16. package/dist-es/commands/{VerifyIdentityCommand.js → StartIdentityChallengeCommand.js} +5 -5
  17. package/dist-es/commands/index.js +4 -3
  18. package/dist-es/models/enums.js +16 -0
  19. package/dist-es/models/errors.js +96 -20
  20. package/dist-es/schemas/schemas_0.js +179 -85
  21. package/dist-types/Users.d.ts +28 -21
  22. package/dist-types/UsersClient.d.ts +6 -5
  23. package/dist-types/commands/ApplyIdentityRemovalCommand.d.ts +93 -0
  24. package/dist-types/commands/ConfirmIdentityChallengeCommand.d.ts +138 -0
  25. package/dist-types/commands/GetAccountCommand.d.ts +1 -1
  26. package/dist-types/commands/ListIdentitiesCommand.d.ts +4 -2
  27. package/dist-types/commands/ListWorkspacesCommand.d.ts +1 -1
  28. package/dist-types/commands/QueryUserCommand.d.ts +2 -1
  29. package/dist-types/commands/QueryUsersCommand.d.ts +2 -1
  30. package/dist-types/commands/ResendIdentityChallengeCodeCommand.d.ts +96 -0
  31. package/dist-types/commands/StartIdentityChallengeCommand.d.ts +138 -0
  32. package/dist-types/commands/UnlinkWorkspaceCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateAccountCommand.d.ts +2 -1
  34. package/dist-types/commands/index.d.ts +4 -3
  35. package/dist-types/models/enums.d.ts +70 -0
  36. package/dist-types/models/errors.d.ts +102 -17
  37. package/dist-types/models/models_0.d.ts +274 -87
  38. package/dist-types/schemas/schemas_0.d.ts +21 -9
  39. package/package.json +5 -5
  40. package/dist-types/commands/LinkIdentityCommand.d.ts +0 -89
  41. package/dist-types/commands/UnlinkIdentityCommand.d.ts +0 -85
  42. package/dist-types/commands/VerifyIdentityCommand.d.ts +0 -90
@@ -1,9 +1,11 @@
1
1
  import type { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
2
+ import { type ApplyIdentityRemovalCommandInput, type ApplyIdentityRemovalCommandOutput } from "./commands/ApplyIdentityRemovalCommand";
2
3
  import { type BatchGetUsersCommandInput, type BatchGetUsersCommandOutput } from "./commands/BatchGetUsersCommand";
3
4
  import { type BatchGetUsersEmailNotificationsSettingsCommandInput, type BatchGetUsersEmailNotificationsSettingsCommandOutput } from "./commands/BatchGetUsersEmailNotificationsSettingsCommand";
4
5
  import { type BatchGetUsersPbxLinkDataCommandInput, type BatchGetUsersPbxLinkDataCommandOutput } from "./commands/BatchGetUsersPbxLinkDataCommand";
5
6
  import { type BatchGetUsersPbxLinkDataV1CommandInput, type BatchGetUsersPbxLinkDataV1CommandOutput } from "./commands/BatchGetUsersPbxLinkDataV1Command";
6
7
  import { type ChangeUserEmailCommandInput, type ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
8
+ import { type ConfirmIdentityChallengeCommandInput, type ConfirmIdentityChallengeCommandOutput } from "./commands/ConfirmIdentityChallengeCommand";
7
9
  import { type CreateAnonymousSessionCommandInput, type CreateAnonymousSessionCommandOutput } from "./commands/CreateAnonymousSessionCommand";
8
10
  import { type CreateBotApiKeyCommandInput, type CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
9
11
  import { type CreateBotCommandInput, type CreateBotCommandOutput } from "./commands/CreateBotCommand";
@@ -21,7 +23,6 @@ import { type GetUserPbxLinkSuggestionCommandInput, type GetUserPbxLinkSuggestio
21
23
  import { type GetUserPbxLinkSuggestionV1CommandInput, type GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
22
24
  import { type IntelligenceSearchCommandInput, type IntelligenceSearchCommandOutput } from "./commands/IntelligenceSearchCommand";
23
25
  import { type InviteCommandInput, type InviteCommandOutput } from "./commands/InviteCommand";
24
- import { type LinkIdentityCommandInput, type LinkIdentityCommandOutput } from "./commands/LinkIdentityCommand";
25
26
  import { type ListBotApiKeysCommandInput, type ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
26
27
  import { type ListBotsCommandInput, type ListBotsCommandOutput } from "./commands/ListBotsCommand";
27
28
  import { type ListIdentitiesCommandInput, type ListIdentitiesCommandOutput } from "./commands/ListIdentitiesCommand";
@@ -30,10 +31,11 @@ import { type PartialUpdateUserEmailNotificationsSettingsCommandInput, type Part
30
31
  import { type QueryColleaguesCommandInput, type QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
31
32
  import { type QueryUserCommandInput, type QueryUserCommandOutput } from "./commands/QueryUserCommand";
32
33
  import { type QueryUsersCommandInput, type QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
34
+ import { type ResendIdentityChallengeCodeCommandInput, type ResendIdentityChallengeCodeCommandOutput } from "./commands/ResendIdentityChallengeCodeCommand";
33
35
  import { type ResetUserChatHistoryCommandInput, type ResetUserChatHistoryCommandOutput } from "./commands/ResetUserChatHistoryCommand";
36
+ import { type StartIdentityChallengeCommandInput, type StartIdentityChallengeCommandOutput } from "./commands/StartIdentityChallengeCommand";
34
37
  import { type ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, type ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand";
35
38
  import { type ToggleUnreadEmailNotificationsSubscriptionCommandInput, type ToggleUnreadEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleUnreadEmailNotificationsSubscriptionCommand";
36
- import { type UnlinkIdentityCommandInput, type UnlinkIdentityCommandOutput } from "./commands/UnlinkIdentityCommand";
37
39
  import { type UnlinkWorkspaceCommandInput, type UnlinkWorkspaceCommandOutput } from "./commands/UnlinkWorkspaceCommand";
38
40
  import { type UpdateAccountCommandInput, type UpdateAccountCommandOutput } from "./commands/UpdateAccountCommand";
39
41
  import { type UpdateBotCallbackCommandInput, type UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
@@ -44,9 +46,14 @@ import { type UploadPictureCommandInput, type UploadPictureCommandOutput } from
44
46
  import { type UploadPictureV1CommandInput, type UploadPictureV1CommandOutput } from "./commands/UploadPictureV1Command";
45
47
  import { type VerifyBotSecretKeyCommandInput, type VerifyBotSecretKeyCommandOutput } from "./commands/VerifyBotSecretKeyCommand";
46
48
  import { type VerifyBotSecretKeyV1CommandInput, type VerifyBotSecretKeyV1CommandOutput } from "./commands/VerifyBotSecretKeyV1Command";
47
- import { type VerifyIdentityCommandInput, type VerifyIdentityCommandOutput } from "./commands/VerifyIdentityCommand";
48
49
  import { UsersClient } from "./UsersClient";
49
50
  export interface Users {
51
+ /**
52
+ * @see {@link ApplyIdentityRemovalCommand}
53
+ */
54
+ applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, options?: __HttpHandlerOptions): Promise<ApplyIdentityRemovalCommandOutput>;
55
+ applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, cb: (err: any, data?: ApplyIdentityRemovalCommandOutput) => void): void;
56
+ applyIdentityRemoval(args: ApplyIdentityRemovalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ApplyIdentityRemovalCommandOutput) => void): void;
50
57
  /**
51
58
  * @see {@link BatchGetUsersCommand}
52
59
  */
@@ -77,6 +84,12 @@ export interface Users {
77
84
  changeUserEmail(args: ChangeUserEmailCommandInput, options?: __HttpHandlerOptions): Promise<ChangeUserEmailCommandOutput>;
78
85
  changeUserEmail(args: ChangeUserEmailCommandInput, cb: (err: any, data?: ChangeUserEmailCommandOutput) => void): void;
79
86
  changeUserEmail(args: ChangeUserEmailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChangeUserEmailCommandOutput) => void): void;
87
+ /**
88
+ * @see {@link ConfirmIdentityChallengeCommand}
89
+ */
90
+ confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, options?: __HttpHandlerOptions): Promise<ConfirmIdentityChallengeCommandOutput>;
91
+ confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, cb: (err: any, data?: ConfirmIdentityChallengeCommandOutput) => void): void;
92
+ confirmIdentityChallenge(args: ConfirmIdentityChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConfirmIdentityChallengeCommandOutput) => void): void;
80
93
  /**
81
94
  * @see {@link CreateAnonymousSessionCommand}
82
95
  */
@@ -181,12 +194,6 @@ export interface Users {
181
194
  invite(args: InviteCommandInput, options?: __HttpHandlerOptions): Promise<InviteCommandOutput>;
182
195
  invite(args: InviteCommandInput, cb: (err: any, data?: InviteCommandOutput) => void): void;
183
196
  invite(args: InviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: InviteCommandOutput) => void): void;
184
- /**
185
- * @see {@link LinkIdentityCommand}
186
- */
187
- linkIdentity(args: LinkIdentityCommandInput, options?: __HttpHandlerOptions): Promise<LinkIdentityCommandOutput>;
188
- linkIdentity(args: LinkIdentityCommandInput, cb: (err: any, data?: LinkIdentityCommandOutput) => void): void;
189
- linkIdentity(args: LinkIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LinkIdentityCommandOutput) => void): void;
190
197
  /**
191
198
  * @see {@link ListBotApiKeysCommand}
192
199
  */
@@ -237,12 +244,24 @@ export interface Users {
237
244
  queryUsers(args: QueryUsersCommandInput, options?: __HttpHandlerOptions): Promise<QueryUsersCommandOutput>;
238
245
  queryUsers(args: QueryUsersCommandInput, cb: (err: any, data?: QueryUsersCommandOutput) => void): void;
239
246
  queryUsers(args: QueryUsersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryUsersCommandOutput) => void): void;
247
+ /**
248
+ * @see {@link ResendIdentityChallengeCodeCommand}
249
+ */
250
+ resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, options?: __HttpHandlerOptions): Promise<ResendIdentityChallengeCodeCommandOutput>;
251
+ resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, cb: (err: any, data?: ResendIdentityChallengeCodeCommandOutput) => void): void;
252
+ resendIdentityChallengeCode(args: ResendIdentityChallengeCodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResendIdentityChallengeCodeCommandOutput) => void): void;
240
253
  /**
241
254
  * @see {@link ResetUserChatHistoryCommand}
242
255
  */
243
256
  resetUserChatHistory(args: ResetUserChatHistoryCommandInput, options?: __HttpHandlerOptions): Promise<ResetUserChatHistoryCommandOutput>;
244
257
  resetUserChatHistory(args: ResetUserChatHistoryCommandInput, cb: (err: any, data?: ResetUserChatHistoryCommandOutput) => void): void;
245
258
  resetUserChatHistory(args: ResetUserChatHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetUserChatHistoryCommandOutput) => void): void;
259
+ /**
260
+ * @see {@link StartIdentityChallengeCommand}
261
+ */
262
+ startIdentityChallenge(args: StartIdentityChallengeCommandInput, options?: __HttpHandlerOptions): Promise<StartIdentityChallengeCommandOutput>;
263
+ startIdentityChallenge(args: StartIdentityChallengeCommandInput, cb: (err: any, data?: StartIdentityChallengeCommandOutput) => void): void;
264
+ startIdentityChallenge(args: StartIdentityChallengeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartIdentityChallengeCommandOutput) => void): void;
246
265
  /**
247
266
  * @see {@link ToggleTranscriptionEmailNotificationsSubscriptionCommand}
248
267
  */
@@ -255,12 +274,6 @@ export interface Users {
255
274
  toggleUnreadEmailNotificationsSubscription(args: ToggleUnreadEmailNotificationsSubscriptionCommandInput, options?: __HttpHandlerOptions): Promise<ToggleUnreadEmailNotificationsSubscriptionCommandOutput>;
256
275
  toggleUnreadEmailNotificationsSubscription(args: ToggleUnreadEmailNotificationsSubscriptionCommandInput, cb: (err: any, data?: ToggleUnreadEmailNotificationsSubscriptionCommandOutput) => void): void;
257
276
  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
277
  /**
265
278
  * @see {@link UnlinkWorkspaceCommand}
266
279
  */
@@ -321,12 +334,6 @@ export interface Users {
321
334
  verifyBotSecretKeyV1(args: VerifyBotSecretKeyV1CommandInput, options?: __HttpHandlerOptions): Promise<VerifyBotSecretKeyV1CommandOutput>;
322
335
  verifyBotSecretKeyV1(args: VerifyBotSecretKeyV1CommandInput, cb: (err: any, data?: VerifyBotSecretKeyV1CommandOutput) => void): void;
323
336
  verifyBotSecretKeyV1(args: VerifyBotSecretKeyV1CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyBotSecretKeyV1CommandOutput) => void): void;
324
- /**
325
- * @see {@link VerifyIdentityCommand}
326
- */
327
- verifyIdentity(args: VerifyIdentityCommandInput, options?: __HttpHandlerOptions): Promise<VerifyIdentityCommandOutput>;
328
- verifyIdentity(args: VerifyIdentityCommandInput, cb: (err: any, data?: VerifyIdentityCommandOutput) => void): void;
329
- verifyIdentity(args: VerifyIdentityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyIdentityCommandOutput) => void): void;
330
337
  }
331
338
  /**
332
339
  * @public
@@ -5,11 +5,13 @@ 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 { ApplyIdentityRemovalCommandInput, ApplyIdentityRemovalCommandOutput } from "./commands/ApplyIdentityRemovalCommand";
8
9
  import type { BatchGetUsersCommandInput, BatchGetUsersCommandOutput } from "./commands/BatchGetUsersCommand";
9
10
  import type { BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput } from "./commands/BatchGetUsersEmailNotificationsSettingsCommand";
10
11
  import type { BatchGetUsersPbxLinkDataCommandInput, BatchGetUsersPbxLinkDataCommandOutput } from "./commands/BatchGetUsersPbxLinkDataCommand";
11
12
  import type { BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1CommandOutput } from "./commands/BatchGetUsersPbxLinkDataV1Command";
12
13
  import type { ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput } from "./commands/ChangeUserEmailCommand";
14
+ import type { ConfirmIdentityChallengeCommandInput, ConfirmIdentityChallengeCommandOutput } from "./commands/ConfirmIdentityChallengeCommand";
13
15
  import type { CreateAnonymousSessionCommandInput, CreateAnonymousSessionCommandOutput } from "./commands/CreateAnonymousSessionCommand";
14
16
  import type { CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput } from "./commands/CreateBotApiKeyCommand";
15
17
  import type { CreateBotCommandInput, CreateBotCommandOutput } from "./commands/CreateBotCommand";
@@ -27,7 +29,6 @@ import type { GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionComm
27
29
  import type { GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput } from "./commands/GetUserPbxLinkSuggestionV1Command";
28
30
  import type { IntelligenceSearchCommandInput, IntelligenceSearchCommandOutput } from "./commands/IntelligenceSearchCommand";
29
31
  import type { InviteCommandInput, InviteCommandOutput } from "./commands/InviteCommand";
30
- import type { LinkIdentityCommandInput, LinkIdentityCommandOutput } from "./commands/LinkIdentityCommand";
31
32
  import type { ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput } from "./commands/ListBotApiKeysCommand";
32
33
  import type { ListBotsCommandInput, ListBotsCommandOutput } from "./commands/ListBotsCommand";
33
34
  import type { ListIdentitiesCommandInput, ListIdentitiesCommandOutput } from "./commands/ListIdentitiesCommand";
@@ -36,10 +37,11 @@ import type { PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUp
36
37
  import type { QueryColleaguesCommandInput, QueryColleaguesCommandOutput } from "./commands/QueryColleaguesCommand";
37
38
  import type { QueryUserCommandInput, QueryUserCommandOutput } from "./commands/QueryUserCommand";
38
39
  import type { QueryUsersCommandInput, QueryUsersCommandOutput } from "./commands/QueryUsersCommand";
40
+ import type { ResendIdentityChallengeCodeCommandInput, ResendIdentityChallengeCodeCommandOutput } from "./commands/ResendIdentityChallengeCodeCommand";
39
41
  import type { ResetUserChatHistoryCommandInput, ResetUserChatHistoryCommandOutput } from "./commands/ResetUserChatHistoryCommand";
42
+ import type { StartIdentityChallengeCommandInput, StartIdentityChallengeCommandOutput } from "./commands/StartIdentityChallengeCommand";
40
43
  import type { ToggleTranscriptionEmailNotificationsSubscriptionCommandInput, ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand";
41
44
  import type { ToggleUnreadEmailNotificationsSubscriptionCommandInput, ToggleUnreadEmailNotificationsSubscriptionCommandOutput } from "./commands/ToggleUnreadEmailNotificationsSubscriptionCommand";
42
- import type { UnlinkIdentityCommandInput, UnlinkIdentityCommandOutput } from "./commands/UnlinkIdentityCommand";
43
45
  import type { UnlinkWorkspaceCommandInput, UnlinkWorkspaceCommandOutput } from "./commands/UnlinkWorkspaceCommand";
44
46
  import type { UpdateAccountCommandInput, UpdateAccountCommandOutput } from "./commands/UpdateAccountCommand";
45
47
  import type { UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput } from "./commands/UpdateBotCallbackCommand";
@@ -50,18 +52,17 @@ import type { UploadPictureCommandInput, UploadPictureCommandOutput } from "./co
50
52
  import type { UploadPictureV1CommandInput, UploadPictureV1CommandOutput } from "./commands/UploadPictureV1Command";
51
53
  import type { VerifyBotSecretKeyCommandInput, VerifyBotSecretKeyCommandOutput } from "./commands/VerifyBotSecretKeyCommand";
52
54
  import type { VerifyBotSecretKeyV1CommandInput, VerifyBotSecretKeyV1CommandOutput } from "./commands/VerifyBotSecretKeyV1Command";
53
- import type { VerifyIdentityCommandInput, VerifyIdentityCommandOutput } from "./commands/VerifyIdentityCommand";
54
55
  import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
55
56
  import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
56
57
  export { __Client };
57
58
  /**
58
59
  * @public
59
60
  */
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 | LinkIdentityCommandInput | ListBotApiKeysCommandInput | ListBotsCommandInput | ListIdentitiesCommandInput | ListWorkspacesCommandInput | PartialUpdateUserEmailNotificationsSettingsCommandInput | QueryColleaguesCommandInput | QueryUserCommandInput | QueryUsersCommandInput | ResetUserChatHistoryCommandInput | ToggleTranscriptionEmailNotificationsSubscriptionCommandInput | ToggleUnreadEmailNotificationsSubscriptionCommandInput | UnlinkIdentityCommandInput | UnlinkWorkspaceCommandInput | UpdateAccountCommandInput | UpdateBotCallbackCommandInput | UpdateBotCommandInput | UpdateUserEmailNotificationsSettingsCommandInput | UpdateWorkspaceCommandInput | UploadPictureCommandInput | UploadPictureV1CommandInput | VerifyBotSecretKeyCommandInput | VerifyBotSecretKeyV1CommandInput | VerifyIdentityCommandInput;
61
+ export type ServiceInputTypes = ApplyIdentityRemovalCommandInput | BatchGetUsersCommandInput | BatchGetUsersEmailNotificationsSettingsCommandInput | BatchGetUsersPbxLinkDataCommandInput | BatchGetUsersPbxLinkDataV1CommandInput | ChangeUserEmailCommandInput | ConfirmIdentityChallengeCommandInput | CreateAnonymousSessionCommandInput | CreateBotApiKeyCommandInput | CreateBotCommandInput | CreateSystemBotCommandInput | DeleteBotApiKeyCommandInput | DeleteBotCommandInput | GetAccountCommandInput | GetAppVersionCommandInput | GetBotCallbackCommandInput | GetBotCommandInput | GetUserCommandInput | GetUserEmailNotificationsSettingsCommandInput | GetUserPbxLinkDataCommandInput | GetUserPbxLinkSuggestionCommandInput | GetUserPbxLinkSuggestionV1CommandInput | IntelligenceSearchCommandInput | InviteCommandInput | ListBotApiKeysCommandInput | ListBotsCommandInput | ListIdentitiesCommandInput | ListWorkspacesCommandInput | PartialUpdateUserEmailNotificationsSettingsCommandInput | QueryColleaguesCommandInput | QueryUserCommandInput | QueryUsersCommandInput | ResendIdentityChallengeCodeCommandInput | ResetUserChatHistoryCommandInput | StartIdentityChallengeCommandInput | ToggleTranscriptionEmailNotificationsSubscriptionCommandInput | ToggleUnreadEmailNotificationsSubscriptionCommandInput | UnlinkWorkspaceCommandInput | UpdateAccountCommandInput | UpdateBotCallbackCommandInput | UpdateBotCommandInput | UpdateUserEmailNotificationsSettingsCommandInput | UpdateWorkspaceCommandInput | UploadPictureCommandInput | UploadPictureV1CommandInput | VerifyBotSecretKeyCommandInput | VerifyBotSecretKeyV1CommandInput;
61
62
  /**
62
63
  * @public
63
64
  */
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 | LinkIdentityCommandOutput | ListBotApiKeysCommandOutput | ListBotsCommandOutput | ListIdentitiesCommandOutput | ListWorkspacesCommandOutput | PartialUpdateUserEmailNotificationsSettingsCommandOutput | QueryColleaguesCommandOutput | QueryUserCommandOutput | QueryUsersCommandOutput | ResetUserChatHistoryCommandOutput | ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput | ToggleUnreadEmailNotificationsSubscriptionCommandOutput | UnlinkIdentityCommandOutput | UnlinkWorkspaceCommandOutput | UpdateAccountCommandOutput | UpdateBotCallbackCommandOutput | UpdateBotCommandOutput | UpdateUserEmailNotificationsSettingsCommandOutput | UpdateWorkspaceCommandOutput | UploadPictureCommandOutput | UploadPictureV1CommandOutput | VerifyBotSecretKeyCommandOutput | VerifyBotSecretKeyV1CommandOutput | VerifyIdentityCommandOutput;
65
+ export type ServiceOutputTypes = ApplyIdentityRemovalCommandOutput | BatchGetUsersCommandOutput | BatchGetUsersEmailNotificationsSettingsCommandOutput | BatchGetUsersPbxLinkDataCommandOutput | BatchGetUsersPbxLinkDataV1CommandOutput | ChangeUserEmailCommandOutput | ConfirmIdentityChallengeCommandOutput | CreateAnonymousSessionCommandOutput | CreateBotApiKeyCommandOutput | CreateBotCommandOutput | CreateSystemBotCommandOutput | DeleteBotApiKeyCommandOutput | DeleteBotCommandOutput | GetAccountCommandOutput | GetAppVersionCommandOutput | GetBotCallbackCommandOutput | GetBotCommandOutput | GetUserCommandOutput | GetUserEmailNotificationsSettingsCommandOutput | GetUserPbxLinkDataCommandOutput | GetUserPbxLinkSuggestionCommandOutput | GetUserPbxLinkSuggestionV1CommandOutput | IntelligenceSearchCommandOutput | InviteCommandOutput | ListBotApiKeysCommandOutput | ListBotsCommandOutput | ListIdentitiesCommandOutput | ListWorkspacesCommandOutput | PartialUpdateUserEmailNotificationsSettingsCommandOutput | QueryColleaguesCommandOutput | QueryUserCommandOutput | QueryUsersCommandOutput | ResendIdentityChallengeCodeCommandOutput | ResetUserChatHistoryCommandOutput | StartIdentityChallengeCommandOutput | ToggleTranscriptionEmailNotificationsSubscriptionCommandOutput | ToggleUnreadEmailNotificationsSubscriptionCommandOutput | UnlinkWorkspaceCommandOutput | UpdateAccountCommandOutput | UpdateBotCallbackCommandOutput | UpdateBotCommandOutput | UpdateUserEmailNotificationsSettingsCommandOutput | UpdateWorkspaceCommandOutput | UploadPictureCommandOutput | UploadPictureV1CommandOutput | VerifyBotSecretKeyCommandOutput | VerifyBotSecretKeyV1CommandOutput;
65
66
  /**
66
67
  * @public
67
68
  */
@@ -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
+ }
@@ -0,0 +1,138 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ConfirmIdentityChallengeInput, ConfirmIdentityChallengeOutput } 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 ConfirmIdentityChallengeCommand}.
14
+ */
15
+ export interface ConfirmIdentityChallengeCommandInput extends ConfirmIdentityChallengeInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ConfirmIdentityChallengeCommand}.
21
+ */
22
+ export interface ConfirmIdentityChallengeCommandOutput extends ConfirmIdentityChallengeOutput, __MetadataBearer {
23
+ }
24
+ declare const ConfirmIdentityChallengeCommand_base: {
25
+ new (input: ConfirmIdentityChallengeCommandInput): import("@smithy/core/client").CommandImpl<ConfirmIdentityChallengeCommandInput, ConfirmIdentityChallengeCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ConfirmIdentityChallengeCommandInput): import("@smithy/core/client").CommandImpl<ConfirmIdentityChallengeCommandInput, ConfirmIdentityChallengeCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Confirms the code of the current step of a challenge started by `StartIdentityChallenge` and advances it:
31
+ *
32
+ * - `add`: the primary code stores the address as pending and sends a code to it (`step: targetCode`); the target code verifies it (`step: done`, with `identity`). If another account verified the address meanwhile, `IdentityAlreadyLinkedException` is returned and the pending address is dropped.
33
+ * - `verify`: the target code verifies the pending address (`step: done`, with `identity`). If another account verified the address meanwhile, `IdentityAlreadyLinkedException` is returned and the pending address is dropped, as for `add`.
34
+ * - `makePrimary`: the primary code sends a code to the target (`step: targetCode`); the target code makes it the primary (`step: done`, with `identity`).
35
+ * - `remove`: the primary code makes the challenge `readyToApply`; call `ApplyIdentityRemoval`. The response carries `dryRun`.
36
+ *
37
+ * A wrong code gives `IncorrectCodeException` and the challenge stays open; too many wrong codes give `TooManyAttemptsException`. 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. If the next code cannot be delivered (the WNS email or SMS send fails or times out), `ServiceUnavailableException` is returned: the confirmed code is not spent, the challenge stays at its step and nothing is half-applied; the call may be retried. The Turnstile token is checked by `StartIdentityChallenge` only (rejected: `ValidationException`; unreachable: `ServiceUnavailableException`); this call does not check it again. Available via s2s (service-to-service) or the x-bees token of the account owner; API keys are refused.
38
+ *
39
+ * @example
40
+ * Use a bare-bones client and the command you need to make an API call.
41
+ * ```javascript
42
+ * import { UsersClient, ConfirmIdentityChallengeCommand } from "@wildix/xbees-users-client"; // ES Modules import
43
+ * // const { UsersClient, ConfirmIdentityChallengeCommand } = require("@wildix/xbees-users-client"); // CommonJS import
44
+ * // import type { UsersClientConfig } from "@wildix/xbees-users-client";
45
+ * const config = {}; // type is UsersClientConfig
46
+ * const client = new UsersClient(config);
47
+ * const input = { // ConfirmIdentityChallengeInput
48
+ * accountId: "STRING_VALUE", // required
49
+ * challengeId: "STRING_VALUE", // required
50
+ * code: "STRING_VALUE", // required
51
+ * };
52
+ * const command = new ConfirmIdentityChallengeCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // ConfirmIdentityChallengeOutput
55
+ * // challengeId: "STRING_VALUE", // required
56
+ * // step: "primaryCode" || "targetCode" || "readyToApply" || "done", // required
57
+ * // resendAfter: Number("int"),
58
+ * // dryRun: { // IdentityRemovalDryRun
59
+ * // endsThisSession: true || false, // required
60
+ * // lostWorkspaces: [ // IdentityRemovalLostWorkspaceList // required
61
+ * // { // IdentityRemovalLostWorkspace
62
+ * // workspaceId: "STRING_VALUE", // required
63
+ * // companyName: "STRING_VALUE", // required
64
+ * // },
65
+ * // ],
66
+ * // signsOutDevices: true || false, // required
67
+ * // },
68
+ * // identity: { // Identity
69
+ * // identity: "STRING_VALUE", // required
70
+ * // account: "STRING_VALUE", // required
71
+ * // type: "email" || "phone", // required
72
+ * // verified: true || false, // required
73
+ * // primary: true || false, // required
74
+ * // },
75
+ * // };
76
+ *
77
+ * ```
78
+ *
79
+ * @param ConfirmIdentityChallengeCommandInput - {@link ConfirmIdentityChallengeCommandInput}
80
+ * @returns {@link ConfirmIdentityChallengeCommandOutput}
81
+ * @see {@link ConfirmIdentityChallengeCommandInput} for command's `input` shape.
82
+ * @see {@link ConfirmIdentityChallengeCommandOutput} for command's `response` shape.
83
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
84
+ *
85
+ * @throws {@link AccountNotFoundException} (client fault)
86
+ *
87
+ * @throws {@link IncorrectCodeException} (client fault)
88
+ * The code does not match the code sent for the current step. The challenge stays open: the user may correct the code and try again, up to the attempts limit.
89
+ *
90
+ * @throws {@link CodeExpiredException} (client fault)
91
+ * The code of the current step has expired. Call `ResendIdentityChallengeCode` to send a new one.
92
+ *
93
+ * @throws {@link TooManyAttemptsException} (client fault)
94
+ * Too many wrong codes: the challenge, or confirmation codes for this address, are blocked for a while. Confirming and resending are refused until `retryAfter` seconds pass.
95
+ *
96
+ * @throws {@link RateLimitedException} (client fault)
97
+ * A limit on sending codes or starting challenges was hit (per address, per IP or per account). No code was sent.
98
+ *
99
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
100
+ * The address is already used by another account (verified there, or pending in an account that has been signed in to), or is already a verified sign-in method of this account. The message does not say whose account it is.
101
+ *
102
+ * @throws {@link IdentityNotFoundException} (client fault)
103
+ * The address is not a sign-in method of the account (or no longer is).
104
+ *
105
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
106
+ * The primary sign-in method cannot be removed; make another verified address primary first.
107
+ *
108
+ * @throws {@link ChallengeNotFoundException} (client fault)
109
+ * 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`.
110
+ *
111
+ * @throws {@link ValidationException} (client fault)
112
+ *
113
+ * @throws {@link ServiceUnavailableException} (server fault)
114
+ * The service is temporarily unable to handle the request; retry later.
115
+ *
116
+ * @throws {@link ForbiddenException} (client fault)
117
+ *
118
+ * @throws {@link RateLimitExceededException} (client fault)
119
+ *
120
+ * @throws {@link UsersServiceException}
121
+ * <p>Base exception class for all service exceptions from Users service.</p>
122
+ *
123
+ *
124
+ * @public
125
+ */
126
+ export declare class ConfirmIdentityChallengeCommand extends ConfirmIdentityChallengeCommand_base {
127
+ /** @internal type navigation helper, not in runtime. */
128
+ protected static __types: {
129
+ api: {
130
+ input: ConfirmIdentityChallengeInput;
131
+ output: ConfirmIdentityChallengeOutput;
132
+ };
133
+ sdk: {
134
+ input: ConfirmIdentityChallengeCommandInput;
135
+ output: ConfirmIdentityChallengeCommandOutput;
136
+ };
137
+ };
138
+ }
@@ -27,7 +27,7 @@ declare const GetAccountCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Retrieves the account.
30
+ * Retrieves the account. Available via s2s (service-to-service) or the x-bees token of the account owner; API keys are refused.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListIdentitiesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Lists all identities (login methods) for the current account.
30
+ * Lists the sign-in methods of the account: the verified identities and the pending ones (being added, `verified: false`), each with its type and whether it is the primary. The technical address behind a phone sign-in never appears; a phone appears as its E.164 number. Available via s2s (service-to-service) or the x-bees token of the account owner; API keys are refused.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -46,7 +46,9 @@ declare const ListIdentitiesCommand_base: {
46
46
  * // { // Identity
47
47
  * // identity: "STRING_VALUE", // required
48
48
  * // account: "STRING_VALUE", // required
49
- * // verified: true || false,
49
+ * // type: "email" || "phone", // required
50
+ * // verified: true || false, // required
51
+ * // primary: true || false, // required
50
52
  * // },
51
53
  * // ],
52
54
  * // };
@@ -27,7 +27,7 @@ declare const ListWorkspacesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Lists workspaces available to the account. Without limit, returns every workspace. With limit, returns one page of active work workspaces: query narrows that set by PBX domain before the page is sliced, offset skips into the filtered set, and each workspace includes pbxUser when a PBX record exists.
30
+ * Lists workspaces available to the account. Without limit, returns every workspace. With limit, returns one page of active work workspaces: query narrows that set by PBX domain before the page is sliced, offset skips into the filtered set, and each workspace includes pbxUser when a PBX record exists. Available via s2s (service-to-service) or the x-bees token of the account owner; API keys are refused.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const QueryUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Searches for a single user using a query with optional predicate validation.
30
+ * Searches for a single user using a query with optional predicate validation. A user with a workspace in the caller's company is returned in that workspace; otherwise, and for a service token, in the user's default workspace.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -37,6 +37,7 @@ declare const QueryUserCommand_base: {
37
37
  * const config = {}; // type is UsersClientConfig
38
38
  * const client = new UsersClient(config);
39
39
  * const input = { // QueryUserInput
40
+ * companyId: "STRING_VALUE",
40
41
  * query: { // UserQuery Union: only one key present
41
42
  * id: "STRING_VALUE",
42
43
  * email: "STRING_VALUE",
@@ -27,7 +27,7 @@ declare const QueryUsersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Searches for multiple users using queries with optional predicate validation.
30
+ * Searches for multiple users using queries with optional predicate validation. A user with a workspace in the caller's company is returned in that workspace; otherwise, and for a service token, in the user's default workspace.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -37,6 +37,7 @@ declare const QueryUsersCommand_base: {
37
37
  * const config = {}; // type is UsersClientConfig
38
38
  * const client = new UsersClient(config);
39
39
  * const input = { // QueryUsersInput
40
+ * companyId: "STRING_VALUE",
40
41
  * queries: [ // UsersQueryList // required
41
42
  * { // UserQuery Union: only one key present
42
43
  * id: "STRING_VALUE",
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/core/client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { ResendIdentityChallengeCodeInput, ResendIdentityChallengeCodeOutput } 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 ResendIdentityChallengeCodeCommand}.
14
+ */
15
+ export interface ResendIdentityChallengeCodeCommandInput extends ResendIdentityChallengeCodeInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ResendIdentityChallengeCodeCommand}.
21
+ */
22
+ export interface ResendIdentityChallengeCodeCommandOutput extends ResendIdentityChallengeCodeOutput, __MetadataBearer {
23
+ }
24
+ declare const ResendIdentityChallengeCodeCommand_base: {
25
+ new (input: ResendIdentityChallengeCodeCommandInput): import("@smithy/core/client").CommandImpl<ResendIdentityChallengeCodeCommandInput, ResendIdentityChallengeCodeCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: ResendIdentityChallengeCodeCommandInput): import("@smithy/core/client").CommandImpl<ResendIdentityChallengeCodeCommandInput, ResendIdentityChallengeCodeCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Sends the code of the current step of a challenge again (to the primary at `primaryCode`, to the target at `targetCode`); the previous code of that step stops working. Allowed once `resendAfter` seconds of the previous send have passed, within the sending limits. 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 waiting for a code gives `ValidationException`. If the code cannot be delivered (the WNS email or SMS send fails or times out), `ServiceUnavailableException` is returned: no send is counted and the previous code keeps working; 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, ResendIdentityChallengeCodeCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ResendIdentityChallengeCodeCommand } = 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 = { // ResendIdentityChallengeCodeInput
40
+ * accountId: "STRING_VALUE", // required
41
+ * challengeId: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new ResendIdentityChallengeCodeCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ResendIdentityChallengeCodeOutput
46
+ * // step: "primaryCode" || "targetCode" || "readyToApply" || "done", // required
47
+ * // resendAfter: Number("int"), // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param ResendIdentityChallengeCodeCommandInput - {@link ResendIdentityChallengeCodeCommandInput}
53
+ * @returns {@link ResendIdentityChallengeCodeCommandOutput}
54
+ * @see {@link ResendIdentityChallengeCodeCommandInput} for command's `input` shape.
55
+ * @see {@link ResendIdentityChallengeCodeCommandOutput} for command's `response` shape.
56
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
57
+ *
58
+ * @throws {@link AccountNotFoundException} (client fault)
59
+ *
60
+ * @throws {@link RateLimitedException} (client fault)
61
+ * A limit on sending codes or starting challenges was hit (per address, per IP or per account). No code was sent.
62
+ *
63
+ * @throws {@link TooManyAttemptsException} (client fault)
64
+ * Too many wrong codes: the challenge, or confirmation codes for this address, are blocked for a while. Confirming and resending are refused until `retryAfter` seconds pass.
65
+ *
66
+ * @throws {@link ChallengeNotFoundException} (client fault)
67
+ * 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`.
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ *
71
+ * @throws {@link ServiceUnavailableException} (server fault)
72
+ * The service is temporarily unable to handle the request; retry later.
73
+ *
74
+ * @throws {@link ForbiddenException} (client fault)
75
+ *
76
+ * @throws {@link RateLimitExceededException} (client fault)
77
+ *
78
+ * @throws {@link UsersServiceException}
79
+ * <p>Base exception class for all service exceptions from Users service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class ResendIdentityChallengeCodeCommand extends ResendIdentityChallengeCodeCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: ResendIdentityChallengeCodeInput;
89
+ output: ResendIdentityChallengeCodeOutput;
90
+ };
91
+ sdk: {
92
+ input: ResendIdentityChallengeCodeCommandInput;
93
+ output: ResendIdentityChallengeCodeCommandOutput;
94
+ };
95
+ };
96
+ }