@wildix/xbees-users-client 4.4.0-stage.1 → 4.4.0-wms29809.2

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 (41) hide show
  1. package/dist-cjs/Users.js +6 -10
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +18 -31
  3. package/dist-cjs/commands/{ApplyIdentityRemovalCommand.js → LinkIdentityCommand.js} +6 -6
  4. package/dist-cjs/commands/{ResetUserChatHistoryCommand.js → UnlinkIdentityCommand.js} +6 -6
  5. package/dist-cjs/commands/{StartIdentityChallengeCommand.js → VerifyIdentityCommand.js} +6 -6
  6. package/dist-cjs/commands/index.js +3 -5
  7. package/dist-cjs/models/enums.js +3 -25
  8. package/dist-cjs/models/errors.js +24 -106
  9. package/dist-cjs/schemas/schemas_0.js +69 -180
  10. package/dist-es/Users.js +6 -10
  11. package/dist-es/auth/httpAuthSchemeProvider.js +18 -31
  12. package/dist-es/commands/{ApplyIdentityRemovalCommand.js → LinkIdentityCommand.js} +5 -5
  13. package/dist-es/commands/{ResetUserChatHistoryCommand.js → UnlinkIdentityCommand.js} +5 -5
  14. package/dist-es/commands/{StartIdentityChallengeCommand.js → VerifyIdentityCommand.js} +5 -5
  15. package/dist-es/commands/index.js +3 -5
  16. package/dist-es/models/enums.js +2 -24
  17. package/dist-es/models/errors.js +20 -96
  18. package/dist-es/schemas/schemas_0.js +65 -176
  19. package/dist-types/Users.d.ts +21 -35
  20. package/dist-types/UsersClient.d.ts +5 -7
  21. package/dist-types/commands/ApplyAccountWorkspaceChangesCommand.d.ts +9 -8
  22. package/dist-types/commands/LinkIdentityCommand.d.ts +89 -0
  23. package/dist-types/commands/ListIdentitiesCommand.d.ts +2 -4
  24. package/dist-types/commands/UnlinkIdentityCommand.d.ts +85 -0
  25. package/dist-types/commands/UpdateAccountCommand.d.ts +1 -2
  26. package/dist-types/commands/VerifyIdentityCommand.d.ts +90 -0
  27. package/dist-types/commands/index.d.ts +3 -5
  28. package/dist-types/models/enums.d.ts +9 -103
  29. package/dist-types/models/errors.d.ts +17 -102
  30. package/dist-types/models/models_0.d.ts +80 -299
  31. package/dist-types/schemas/schemas_0.d.ts +9 -24
  32. package/package.json +1 -1
  33. package/dist-cjs/commands/ConfirmIdentityChallengeCommand.js +0 -20
  34. package/dist-cjs/commands/ResendIdentityChallengeCodeCommand.js +0 -20
  35. package/dist-es/commands/ConfirmIdentityChallengeCommand.js +0 -16
  36. package/dist-es/commands/ResendIdentityChallengeCodeCommand.js +0 -16
  37. package/dist-types/commands/ApplyIdentityRemovalCommand.d.ts +0 -93
  38. package/dist-types/commands/ConfirmIdentityChallengeCommand.d.ts +0 -138
  39. package/dist-types/commands/ResendIdentityChallengeCodeCommand.d.ts +0 -96
  40. package/dist-types/commands/ResetUserChatHistoryCommand.d.ts +0 -89
  41. package/dist-types/commands/StartIdentityChallengeCommand.d.ts +0 -139
@@ -154,7 +154,7 @@ export declare const AccountWorkspaceChangeOperation: {
154
154
  */
155
155
  readonly DETACH: "detach";
156
156
  /**
157
- * Make the workspace the account's default (the one sign-in opens). The PBX link moves with the default, see ApplyAccountWorkspaceChanges.
157
+ * Make the workspace the account's default (the one sign-in opens). Only the default changes: the PBX link stays on the workspace that holds it.
158
158
  */
159
159
  readonly MAKE_DEFAULT: "makeDefault";
160
160
  };
@@ -167,6 +167,10 @@ export type AccountWorkspaceChangeOperation = (typeof AccountWorkspaceChangeOper
167
167
  * @enum
168
168
  */
169
169
  export declare const AccountWorkspaceRefusalCode: {
170
+ /**
171
+ * attach: the account would hold two workspaces of one company and one address type, or two workspaces without a company. Address type: `phone` when the workspace's effective Stream email (`Workspace#<ws>/Stream`, else the legacy `User#<ws>/Stream`) is `<8 to 15 digits>@phone.wildix.com`, otherwise `email` (no Stream row or no email counts as `email`). Company: the `company` of the effective Stream row, else of the effective Pbx row; none when both lack it. The rule counts the active memberships of the account after all the changes of the call (a deleted workspace is still a member and counts): at most one email workspace and one phone workspace per company, and at most one workspace without a company, whatever its address type. Accounts that already break the rule are not blocked as a whole: a change is refused only when the draft makes a group worse, that is, a group that holds more than one workspace after the changes and whose workspaces are not all in the same group before them (so a detach, a makeDefault, or a draft that touches only other accounts passes). `accountId` is the account and `workspaceId` the incoming workspace; the message names the company (or no company), the address type and the workspace already in the account.
172
+ */
173
+ readonly COMPANY_WORKSPACE_TAKEN: "company_workspace_taken";
170
174
  /**
171
175
  * The workspace is deleted.
172
176
  */
@@ -183,10 +187,6 @@ export declare const AccountWorkspaceRefusalCode: {
183
187
  * A login account (one that still has an identity) would be left without a default workspace. It never gets an automatic default.
184
188
  */
185
189
  readonly NO_DEFAULT: "no_default";
186
- /**
187
- * makeDefault onto a workspace of another company that has no PBX link of its own: the PBX link does not move there.
188
- */
189
- readonly PBX_OTHER_COMPANY: "pbx_other_company";
190
190
  /**
191
191
  * The plan needs more row writes than one DynamoDB transaction holds (100).
192
192
  */
@@ -217,6 +217,10 @@ export type AccountWorkspaceRefusalCode = (typeof AccountWorkspaceRefusalCode)[k
217
217
  * @enum
218
218
  */
219
219
  export declare const AccountWorkspaceCheckCode: {
220
+ /**
221
+ * Blocking, see AccountWorkspaceRefusalCode.
222
+ */
223
+ readonly COMPANY_WORKSPACE_TAKEN: "company_workspace_taken";
220
224
  /**
221
225
  * Blocking. A row differs from `expected`: `row` names it, and `field` the differing attribute when the row exists as expected. On apply: AccountWorkspaceConflictException.
222
226
  */
@@ -249,18 +253,6 @@ export declare const AccountWorkspaceCheckCode: {
249
253
  * Not blocking. An orphaned account is left with no active workspace: a new personal workspace is created and becomes its default.
250
254
  */
251
255
  readonly ORPHAN_PERSONAL_WORKSPACE_CREATED: "orphan_personal_workspace_created";
252
- /**
253
- * Not blocking. makeDefault: the PBX link moves to the new default (a personal workspace becomes work).
254
- */
255
- readonly PBX_LINK_MOVES: "pbx_link_moves";
256
- /**
257
- * Not blocking. makeDefault onto a workspace of another company with its own PBX link: only the default changes, each workspace keeps its PBX link.
258
- */
259
- readonly PBX_LINK_STAYS: "pbx_link_stays";
260
- /**
261
- * Blocking, see AccountWorkspaceRefusalCode.
262
- */
263
- readonly PBX_OTHER_COMPANY: "pbx_other_company";
264
256
  /**
265
257
  * Blocking, see AccountWorkspaceRefusalCode.
266
258
  */
@@ -299,14 +291,6 @@ export declare const AccountWorkspaceEffectName: {
299
291
  * `custom:wid` set to the new default on the Cognito users of the account's identities. Applies at the next token refresh.
300
292
  */
301
293
  readonly COGNITO: "cognito";
302
- /**
303
- * External-flag job scheduled for a workspace.
304
- */
305
- readonly JOB: "job";
306
- /**
307
- * GetStream user PBX fields moved between workspaces.
308
- */
309
- readonly STREAM: "stream";
310
294
  };
311
295
  /**
312
296
  * @public
@@ -351,10 +335,6 @@ export declare const AccountWorkspaceRowEntity: {
351
335
  * PBX link of a workspace: `Workspace#<ws>/Pbx`.
352
336
  */
353
337
  readonly PBX: "pbx";
354
- /**
355
- * PBX user record with its `linkHistory`: `PbxUser#…`.
356
- */
357
- readonly PBX_USER: "pbxUser";
358
338
  /**
359
339
  * Stream link of a workspace: `Workspace#<ws>/Stream`.
360
340
  */
@@ -391,10 +371,6 @@ export type WorkspaceType = (typeof WorkspaceType)[keyof typeof WorkspaceType];
391
371
  * @enum
392
372
  */
393
373
  export declare const AccountWorkspaceWriteKind: {
394
- /**
395
- * Entries are appended to list attributes of a row (`linkHistory`, entries with `source: 'stream-console'`): `after` holds the appended entries only, `before` is absent.
396
- */
397
- readonly APPEND: "append";
398
374
  /**
399
375
  * The row is deleted: `before` is the whole deleted row, `after` is absent.
400
376
  */
@@ -492,73 +468,3 @@ export declare const BotLlmToolType: {
492
468
  * @public
493
469
  */
494
470
  export type BotLlmToolType = (typeof BotLlmToolType)[keyof typeof BotLlmToolType];
495
- /**
496
- * @public
497
- * @enum
498
- */
499
- export declare const IdentityType: {
500
- /**
501
- * An email address.
502
- */
503
- readonly EMAIL: "email";
504
- /**
505
- * A phone number.
506
- */
507
- readonly PHONE: "phone";
508
- };
509
- /**
510
- * @public
511
- */
512
- export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
513
- /**
514
- * @public
515
- * @enum
516
- */
517
- export declare const IdentityChallengeStep: {
518
- /**
519
- * The change is applied and the challenge is used up.
520
- */
521
- readonly DONE: "done";
522
- /**
523
- * A code has been sent to the current primary; confirm it with `ConfirmIdentityChallenge`.
524
- */
525
- readonly PRIMARY_CODE: "primaryCode";
526
- /**
527
- * Remove only: the primary code is accepted; call `ApplyIdentityRemoval` to remove the address.
528
- */
529
- readonly READY_TO_APPLY: "readyToApply";
530
- /**
531
- * A code has been sent to the target address; confirm it with `ConfirmIdentityChallenge`.
532
- */
533
- readonly TARGET_CODE: "targetCode";
534
- };
535
- /**
536
- * @public
537
- */
538
- export type IdentityChallengeStep = (typeof IdentityChallengeStep)[keyof typeof IdentityChallengeStep];
539
- /**
540
- * @public
541
- * @enum
542
- */
543
- export declare const IdentityChallengeOperation: {
544
- /**
545
- * Add a new address to the account: a code to the primary, then a code to the new address. After the primary code the address is stored as pending (not verified); after the target code it is verified.
546
- */
547
- readonly ADD: "add";
548
- /**
549
- * Make a verified address the primary: a code to the current primary, then a code to the new primary. The old primary stays a sign-in method.
550
- */
551
- readonly MAKE_PRIMARY: "makePrimary";
552
- /**
553
- * Remove an address that is not the primary: a code to the primary, then `ApplyIdentityRemoval`. No code goes to the address being removed.
554
- */
555
- readonly REMOVE: "remove";
556
- /**
557
- * Verify a pending address of the account: a code to that address only, since the primary was confirmed when the address was added.
558
- */
559
- readonly VERIFY: "verify";
560
- };
561
- /**
562
- * @public
563
- */
564
- export type IdentityChallengeOperation = (typeof IdentityChallengeOperation)[keyof typeof IdentityChallengeOperation];
@@ -44,18 +44,6 @@ export declare class RateLimitExceededException extends __BaseException {
44
44
  */
45
45
  constructor(opts: __ExceptionOptionType<RateLimitExceededException, __BaseException>);
46
46
  }
47
- /**
48
- * The service is temporarily unable to handle the request; retry later.
49
- * @public
50
- */
51
- export declare class ServiceUnavailableException extends __BaseException {
52
- readonly name: "ServiceUnavailableException";
53
- readonly $fault: "server";
54
- /**
55
- * @internal
56
- */
57
- constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
58
- }
59
47
  /**
60
48
  * @public
61
49
  */
@@ -154,42 +142,6 @@ export declare class AccountWorkspaceConflictException extends __BaseException {
154
142
  */
155
143
  constructor(opts: __ExceptionOptionType<AccountWorkspaceConflictException, __BaseException>);
156
144
  }
157
- /**
158
- * The primary sign-in method cannot be removed; make another verified address primary first.
159
- * @public
160
- */
161
- export declare class CannotRemovePrimaryIdentityException extends __BaseException {
162
- readonly name: "CannotRemovePrimaryIdentityException";
163
- readonly $fault: "client";
164
- /**
165
- * @internal
166
- */
167
- constructor(opts: __ExceptionOptionType<CannotRemovePrimaryIdentityException, __BaseException>);
168
- }
169
- /**
170
- * 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`.
171
- * @public
172
- */
173
- export declare class ChallengeNotFoundException extends __BaseException {
174
- readonly name: "ChallengeNotFoundException";
175
- readonly $fault: "client";
176
- /**
177
- * @internal
178
- */
179
- constructor(opts: __ExceptionOptionType<ChallengeNotFoundException, __BaseException>);
180
- }
181
- /**
182
- * The address is not a sign-in method of the account (or no longer is).
183
- * @public
184
- */
185
- export declare class IdentityNotFoundException extends __BaseException {
186
- readonly name: "IdentityNotFoundException";
187
- readonly $fault: "client";
188
- /**
189
- * @internal
190
- */
191
- constructor(opts: __ExceptionOptionType<IdentityNotFoundException, __BaseException>);
192
- }
193
145
  /**
194
146
  * @public
195
147
  */
@@ -234,6 +186,17 @@ export declare class BotSecretKeyNotValidException extends __BaseException {
234
186
  */
235
187
  constructor(opts: __ExceptionOptionType<BotSecretKeyNotValidException, __BaseException>);
236
188
  }
189
+ /**
190
+ * @public
191
+ */
192
+ export declare class CannotRemovePrimaryIdentityException extends __BaseException {
193
+ readonly name: "CannotRemovePrimaryIdentityException";
194
+ readonly $fault: "client";
195
+ /**
196
+ * @internal
197
+ */
198
+ constructor(opts: __ExceptionOptionType<CannotRemovePrimaryIdentityException, __BaseException>);
199
+ }
237
200
  /**
238
201
  * @public
239
202
  */
@@ -268,19 +231,17 @@ export declare class UserNotFoundException extends __BaseException {
268
231
  constructor(opts: __ExceptionOptionType<UserNotFoundException, __BaseException>);
269
232
  }
270
233
  /**
271
- * The code of the current step has expired. Call `ResendIdentityChallengeCode` to send a new one.
272
234
  * @public
273
235
  */
274
- export declare class CodeExpiredException extends __BaseException {
275
- readonly name: "CodeExpiredException";
236
+ export declare class PublicAccessIsRestrictedException extends __BaseException {
237
+ readonly name: "PublicAccessIsRestrictedException";
276
238
  readonly $fault: "client";
277
239
  /**
278
240
  * @internal
279
241
  */
280
- constructor(opts: __ExceptionOptionType<CodeExpiredException, __BaseException>);
242
+ constructor(opts: __ExceptionOptionType<PublicAccessIsRestrictedException, __BaseException>);
281
243
  }
282
244
  /**
283
- * 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.
284
245
  * @public
285
246
  */
286
247
  export declare class IdentityAlreadyLinkedException extends __BaseException {
@@ -292,61 +253,15 @@ export declare class IdentityAlreadyLinkedException extends __BaseException {
292
253
  constructor(opts: __ExceptionOptionType<IdentityAlreadyLinkedException, __BaseException>);
293
254
  }
294
255
  /**
295
- * 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.
296
- * @public
297
- */
298
- export declare class IncorrectCodeException extends __BaseException {
299
- readonly name: "IncorrectCodeException";
300
- readonly $fault: "client";
301
- /**
302
- * @internal
303
- */
304
- constructor(opts: __ExceptionOptionType<IncorrectCodeException, __BaseException>);
305
- }
306
- /**
307
- * A limit on sending codes or starting challenges was hit (per address, per IP or per account). No code was sent.
308
256
  * @public
309
257
  */
310
- export declare class RateLimitedException extends __BaseException {
311
- readonly name: "RateLimitedException";
312
- readonly $fault: "client";
313
- /**
314
- * Seconds until the caller may try again.
315
- * @public
316
- */
317
- retryAfter: number;
318
- /**
319
- * @internal
320
- */
321
- constructor(opts: __ExceptionOptionType<RateLimitedException, __BaseException>);
322
- }
323
- /**
324
- * 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.
325
- * @public
326
- */
327
- export declare class TooManyAttemptsException extends __BaseException {
328
- readonly name: "TooManyAttemptsException";
329
- readonly $fault: "client";
330
- /**
331
- * Seconds until the block ends.
332
- * @public
333
- */
334
- retryAfter: number;
335
- /**
336
- * @internal
337
- */
338
- constructor(opts: __ExceptionOptionType<TooManyAttemptsException, __BaseException>);
339
- }
340
- /**
341
- * @public
342
- */
343
- export declare class PublicAccessIsRestrictedException extends __BaseException {
344
- readonly name: "PublicAccessIsRestrictedException";
258
+ export declare class IdentityNotFoundException extends __BaseException {
259
+ readonly name: "IdentityNotFoundException";
345
260
  readonly $fault: "client";
346
261
  /**
347
262
  * @internal
348
263
  */
349
- constructor(opts: __ExceptionOptionType<PublicAccessIsRestrictedException, __BaseException>);
264
+ constructor(opts: __ExceptionOptionType<IdentityNotFoundException, __BaseException>);
350
265
  }
351
266
  /**
352
267
  * @public