@wildix/xbees-users-client 4.3.3-wms26787.2 → 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.
Files changed (38) hide show
  1. package/dist-cjs/Users.js +9 -1
  2. package/dist-cjs/auth/httpAuthSchemeProvider.js +12 -0
  3. package/dist-cjs/commands/ApplyAccountWorkspaceChangesCommand.js +20 -0
  4. package/dist-cjs/commands/ListAccountEmailChangesCommand.js +20 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/index.js +1 -0
  7. package/dist-cjs/models/enums.js +73 -6
  8. package/dist-cjs/models/errors.js +39 -1
  9. package/dist-cjs/pagination/Interfaces.js +2 -0
  10. package/dist-cjs/pagination/ListAccountEmailChangesPaginator.js +7 -0
  11. package/dist-cjs/pagination/index.js +5 -0
  12. package/dist-cjs/schemas/schemas_0.js +288 -102
  13. package/dist-es/Users.js +9 -1
  14. package/dist-es/auth/httpAuthSchemeProvider.js +12 -0
  15. package/dist-es/commands/ApplyAccountWorkspaceChangesCommand.js +16 -0
  16. package/dist-es/commands/ListAccountEmailChangesCommand.js +16 -0
  17. package/dist-es/commands/index.js +2 -0
  18. package/dist-es/index.js +1 -0
  19. package/dist-es/models/enums.js +72 -5
  20. package/dist-es/models/errors.js +36 -0
  21. package/dist-es/pagination/Interfaces.js +1 -0
  22. package/dist-es/pagination/ListAccountEmailChangesPaginator.js +4 -0
  23. package/dist-es/pagination/index.js +2 -0
  24. package/dist-es/schemas/schemas_0.js +284 -98
  25. package/dist-types/Users.d.ts +22 -1
  26. package/dist-types/UsersClient.d.ts +4 -2
  27. package/dist-types/commands/ApplyAccountWorkspaceChangesCommand.d.ts +193 -0
  28. package/dist-types/commands/ListAccountEmailChangesCommand.d.ts +101 -0
  29. package/dist-types/commands/index.d.ts +2 -0
  30. package/dist-types/index.d.ts +1 -0
  31. package/dist-types/models/enums.d.ts +288 -22
  32. package/dist-types/models/errors.d.ts +56 -0
  33. package/dist-types/models/models_0.d.ts +418 -2
  34. package/dist-types/pagination/Interfaces.d.ts +8 -0
  35. package/dist-types/pagination/ListAccountEmailChangesPaginator.d.ts +7 -0
  36. package/dist-types/pagination/index.d.ts +2 -0
  37. package/dist-types/schemas/schemas_0.d.ts +19 -0
  38. package/package.json +5 -5
@@ -124,6 +124,294 @@ export declare const AppType: {
124
124
  * @public
125
125
  */
126
126
  export type AppType = (typeof AppType)[keyof typeof AppType];
127
+ /**
128
+ * @public
129
+ * @enum
130
+ */
131
+ export declare const AccountEmailChangeStatus: {
132
+ readonly ABORTED: "ABORTED";
133
+ readonly FAILED: "FAILED";
134
+ readonly PENDING_REDRIVE: "PENDING_REDRIVE";
135
+ readonly RUNNING: "RUNNING";
136
+ readonly SUCCEEDED: "SUCCEEDED";
137
+ readonly TIMED_OUT: "TIMED_OUT";
138
+ };
139
+ /**
140
+ * @public
141
+ */
142
+ export type AccountEmailChangeStatus = (typeof AccountEmailChangeStatus)[keyof typeof AccountEmailChangeStatus];
143
+ /**
144
+ * @public
145
+ * @enum
146
+ */
147
+ export declare const AccountWorkspaceChangeOperation: {
148
+ /**
149
+ * Move the membership of the workspace from `fromAccountId` to the change's account (keeping its `type`), or, without `fromAccountId`, attach a workspace that has no membership in any account.
150
+ */
151
+ readonly ATTACH: "attach";
152
+ /**
153
+ * Remove the membership of the workspace from the change's account. The Stream and Pbx rows of the workspace and its channels stay.
154
+ */
155
+ readonly DETACH: "detach";
156
+ /**
157
+ * Make the workspace the account's default (the one sign-in opens). The PBX link moves with the default, see ApplyAccountWorkspaceChanges.
158
+ */
159
+ readonly MAKE_DEFAULT: "makeDefault";
160
+ };
161
+ /**
162
+ * @public
163
+ */
164
+ export type AccountWorkspaceChangeOperation = (typeof AccountWorkspaceChangeOperation)[keyof typeof AccountWorkspaceChangeOperation];
165
+ /**
166
+ * @public
167
+ * @enum
168
+ */
169
+ export declare const AccountWorkspaceRefusalCode: {
170
+ /**
171
+ * The workspace is deleted.
172
+ */
173
+ readonly DELETED_WORKSPACE: "deleted_workspace";
174
+ /**
175
+ * A row the change touches is missing from `expected`, or lacks the fields it must carry.
176
+ */
177
+ readonly EXPECTED_INCOMPLETE: "expected_incomplete";
178
+ /**
179
+ * The workspace's Stream email belongs to another person.
180
+ */
181
+ readonly FOREIGN_STREAM_EMAIL: "foreign_stream_email";
182
+ /**
183
+ * A login account (one that still has an identity) would be left without a default workspace. It never gets an automatic default.
184
+ */
185
+ 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
+ /**
191
+ * The plan needs more row writes than one DynamoDB transaction holds (100).
192
+ */
193
+ readonly TOO_MANY_WRITES: "too_many_writes";
194
+ /**
195
+ * attach: the workspace is already a membership of the change's `accountId`.
196
+ */
197
+ readonly WORKSPACE_ALREADY_IN_ACCOUNT: "workspace_already_in_account";
198
+ /**
199
+ * attach without `fromAccountId`: the workspace is a member of an account (found through the `AccountsByWorkspace` index), so it is not detached. Name the account in `fromAccountId`.
200
+ */
201
+ readonly WORKSPACE_HAS_ACCOUNT: "workspace_has_account";
202
+ /**
203
+ * detach or makeDefault: the workspace is not a membership of the change's `accountId`.
204
+ */
205
+ readonly WORKSPACE_NOT_IN_ACCOUNT: "workspace_not_in_account";
206
+ /**
207
+ * attach with `fromAccountId`: the workspace is not a membership of `fromAccountId` (or that account does not exist).
208
+ */
209
+ readonly WORKSPACE_NOT_IN_SOURCE_ACCOUNT: "workspace_not_in_source_account";
210
+ };
211
+ /**
212
+ * @public
213
+ */
214
+ export type AccountWorkspaceRefusalCode = (typeof AccountWorkspaceRefusalCode)[keyof typeof AccountWorkspaceRefusalCode];
215
+ /**
216
+ * @public
217
+ * @enum
218
+ */
219
+ export declare const AccountWorkspaceCheckCode: {
220
+ /**
221
+ * Blocking. A row differs from `expected`: `row` names it, and `field` the differing attribute when the row exists as expected. On apply: AccountWorkspaceConflictException.
222
+ */
223
+ readonly CONFLICT: "conflict";
224
+ /**
225
+ * Blocking, see AccountWorkspaceRefusalCode.
226
+ */
227
+ readonly DELETED_WORKSPACE: "deleted_workspace";
228
+ /**
229
+ * Not blocking. The account gets a new default: email resolution (direct messages, invites, call messages) follows it.
230
+ */
231
+ readonly EMAIL_ROUTING_CHANGES: "email_routing_changes";
232
+ /**
233
+ * Blocking, see AccountWorkspaceRefusalCode.
234
+ */
235
+ readonly EXPECTED_INCOMPLETE: "expected_incomplete";
236
+ /**
237
+ * Blocking, see AccountWorkspaceRefusalCode.
238
+ */
239
+ readonly FOREIGN_STREAM_EMAIL: "foreign_stream_email";
240
+ /**
241
+ * Blocking, see AccountWorkspaceRefusalCode.
242
+ */
243
+ readonly NO_DEFAULT: "no_default";
244
+ /**
245
+ * Not blocking. An orphaned account loses its default: the default moves to its remaining active workspace with the latest `lastUsedAt` (`workspaceId`, `accountId`).
246
+ */
247
+ readonly ORPHAN_DEFAULT_MOVED: "orphan_default_moved";
248
+ /**
249
+ * Not blocking. An orphaned account is left with no active workspace: a new personal workspace is created and becomes its default.
250
+ */
251
+ 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
+ /**
265
+ * Blocking, see AccountWorkspaceRefusalCode.
266
+ */
267
+ readonly TOO_MANY_WRITES: "too_many_writes";
268
+ /**
269
+ * Blocking, see AccountWorkspaceRefusalCode.
270
+ */
271
+ readonly WORKSPACE_ALREADY_IN_ACCOUNT: "workspace_already_in_account";
272
+ /**
273
+ * Blocking, see AccountWorkspaceRefusalCode.
274
+ */
275
+ readonly WORKSPACE_HAS_ACCOUNT: "workspace_has_account";
276
+ /**
277
+ * Blocking, see AccountWorkspaceRefusalCode.
278
+ */
279
+ readonly WORKSPACE_NOT_IN_ACCOUNT: "workspace_not_in_account";
280
+ /**
281
+ * Blocking, see AccountWorkspaceRefusalCode.
282
+ */
283
+ readonly WORKSPACE_NOT_IN_SOURCE_ACCOUNT: "workspace_not_in_source_account";
284
+ };
285
+ /**
286
+ * @public
287
+ */
288
+ export type AccountWorkspaceCheckCode = (typeof AccountWorkspaceCheckCode)[keyof typeof AccountWorkspaceCheckCode];
289
+ /**
290
+ * @public
291
+ * @enum
292
+ */
293
+ export declare const AccountWorkspaceEffectName: {
294
+ /**
295
+ * Workspaces cache of a touched account invalidated (version bump).
296
+ */
297
+ readonly CACHE: "cache";
298
+ /**
299
+ * `custom:wid` set to the new default on the Cognito users of the account's identities. Applies at the next token refresh.
300
+ */
301
+ 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
+ };
311
+ /**
312
+ * @public
313
+ */
314
+ export type AccountWorkspaceEffectName = (typeof AccountWorkspaceEffectName)[keyof typeof AccountWorkspaceEffectName];
315
+ /**
316
+ * @public
317
+ * @enum
318
+ */
319
+ export declare const AccountWorkspaceEffectStatus: {
320
+ /**
321
+ * Failed. The committed change stays; `detail` says what failed.
322
+ */
323
+ readonly FAILED: "failed";
324
+ /**
325
+ * Done.
326
+ */
327
+ readonly OK: "ok";
328
+ /**
329
+ * Not needed or nothing to do, e.g. no Cognito user found for an identity; `detail` says why.
330
+ */
331
+ readonly SKIPPED: "skipped";
332
+ };
333
+ /**
334
+ * @public
335
+ */
336
+ export type AccountWorkspaceEffectStatus = (typeof AccountWorkspaceEffectStatus)[keyof typeof AccountWorkspaceEffectStatus];
337
+ /**
338
+ * @public
339
+ * @enum
340
+ */
341
+ export declare const AccountWorkspaceRowEntity: {
342
+ /**
343
+ * Account settings: `Account#<acc>/Settings` (`defaultWorkspace`).
344
+ */
345
+ readonly ACCOUNT_SETTINGS: "accountSettings";
346
+ /**
347
+ * Membership of a workspace in an account: `Account#<acc>/Workspace#<ws>`.
348
+ */
349
+ readonly MEMBERSHIP: "membership";
350
+ /**
351
+ * PBX link of a workspace: `Workspace#<ws>/Pbx`.
352
+ */
353
+ readonly PBX: "pbx";
354
+ /**
355
+ * PBX user record with its `linkHistory`: `PbxUser#…`.
356
+ */
357
+ readonly PBX_USER: "pbxUser";
358
+ /**
359
+ * Stream link of a workspace: `Workspace#<ws>/Stream`.
360
+ */
361
+ readonly STREAM: "stream";
362
+ };
363
+ /**
364
+ * @public
365
+ */
366
+ export type AccountWorkspaceRowEntity = (typeof AccountWorkspaceRowEntity)[keyof typeof AccountWorkspaceRowEntity];
367
+ /**
368
+ * @public
369
+ * @enum
370
+ */
371
+ export declare const WorkspaceType: {
372
+ /**
373
+ * User is not linked to any company.
374
+ */
375
+ readonly PERSONAL: "personal";
376
+ /**
377
+ * Support staff with temporary access to a user's workspace.
378
+ */
379
+ readonly SUPPORT: "support";
380
+ /**
381
+ * User is a colleague of the company.
382
+ */
383
+ readonly WORK: "work";
384
+ };
385
+ /**
386
+ * @public
387
+ */
388
+ export type WorkspaceType = (typeof WorkspaceType)[keyof typeof WorkspaceType];
389
+ /**
390
+ * @public
391
+ * @enum
392
+ */
393
+ 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
+ /**
399
+ * The row is deleted: `before` is the whole deleted row, `after` is absent.
400
+ */
401
+ readonly DELETE: "delete";
402
+ /**
403
+ * The row is created or replaced: `after` is the whole new row, `before` the replaced row (absent when the row did not exist).
404
+ */
405
+ readonly PUT: "put";
406
+ /**
407
+ * Attributes of an existing row are set or removed: `before` and `after` hold the changed attributes only (`null` = absent).
408
+ */
409
+ readonly UPDATE: "update";
410
+ };
411
+ /**
412
+ * @public
413
+ */
414
+ export type AccountWorkspaceWriteKind = (typeof AccountWorkspaceWriteKind)[keyof typeof AccountWorkspaceWriteKind];
127
415
  /**
128
416
  * @public
129
417
  * @enum
@@ -274,25 +562,3 @@ export declare const IdentityChallengeOperation: {
274
562
  * @public
275
563
  */
276
564
  export type IdentityChallengeOperation = (typeof IdentityChallengeOperation)[keyof typeof IdentityChallengeOperation];
277
- /**
278
- * @public
279
- * @enum
280
- */
281
- export declare const WorkspaceType: {
282
- /**
283
- * User is not linked to any company.
284
- */
285
- readonly PERSONAL: "personal";
286
- /**
287
- * Support staff with temporary access to a user's workspace.
288
- */
289
- readonly SUPPORT: "support";
290
- /**
291
- * User is a colleague of the company.
292
- */
293
- readonly WORK: "work";
294
- };
295
- /**
296
- * @public
297
- */
298
- export type WorkspaceType = (typeof WorkspaceType)[keyof typeof WorkspaceType];
@@ -1,4 +1,6 @@
1
1
  import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/core/client";
2
+ import type { AccountWorkspaceRefusalCode } from "./enums";
3
+ import type { AccountWorkspaceRowKey } from "./models_0";
2
4
  import { UsersServiceException as __BaseException } from "./UsersServiceException";
3
5
  /**
4
6
  * @public
@@ -98,6 +100,60 @@ export declare class AccountNotFoundException extends __BaseException {
98
100
  */
99
101
  constructor(opts: __ExceptionOptionType<AccountNotFoundException, __BaseException>);
100
102
  }
103
+ /**
104
+ * 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.
105
+ * @public
106
+ */
107
+ export declare class AccountWorkspaceChangeRefusedException extends __BaseException {
108
+ readonly name: "AccountWorkspaceChangeRefusedException";
109
+ readonly $fault: "client";
110
+ /**
111
+ * Why the change is refused.
112
+ * @public
113
+ */
114
+ code: AccountWorkspaceRefusalCode;
115
+ /**
116
+ * The row the refusal is about, when it is about one (always for `expected_incomplete`).
117
+ * @public
118
+ */
119
+ row?: AccountWorkspaceRowKey | undefined;
120
+ /**
121
+ * The account the refusal is about, when it is about one.
122
+ * @public
123
+ */
124
+ accountId?: string | undefined;
125
+ /**
126
+ * The workspace the refusal is about, when it is about one.
127
+ * @public
128
+ */
129
+ workspaceId?: string | undefined;
130
+ /**
131
+ * @internal
132
+ */
133
+ constructor(opts: __ExceptionOptionType<AccountWorkspaceChangeRefusedException, __BaseException>);
134
+ }
135
+ /**
136
+ * 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`.
137
+ * @public
138
+ */
139
+ export declare class AccountWorkspaceConflictException extends __BaseException {
140
+ readonly name: "AccountWorkspaceConflictException";
141
+ readonly $fault: "client";
142
+ /**
143
+ * The row that differs.
144
+ * @public
145
+ */
146
+ row: AccountWorkspaceRowKey;
147
+ /**
148
+ * The attribute of that row whose stored value differs from `expected`. Present when the row exists as expected but a listed field differs; absent when a row expected absent now exists or a row expected present is gone, then only `row` names the conflict.
149
+ * @public
150
+ */
151
+ field?: string | undefined;
152
+ /**
153
+ * @internal
154
+ */
155
+ constructor(opts: __ExceptionOptionType<AccountWorkspaceConflictException, __BaseException>);
156
+ }
101
157
  /**
102
158
  * The primary sign-in method cannot be removed; make another verified address primary first.
103
159
  * @public