@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.
- package/dist-cjs/Users.js +8 -6
- package/dist-cjs/auth/httpAuthSchemeProvider.js +63 -0
- package/dist-cjs/commands/{LinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +6 -6
- package/dist-cjs/commands/{VerifyIdentityCommand.js → ConfirmIdentityChallengeCommand.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 +4 -3
- package/dist-cjs/models/enums.js +17 -1
- package/dist-cjs/models/errors.js +106 -24
- package/dist-cjs/schemas/schemas_0.js +183 -89
- package/dist-es/Users.js +8 -6
- package/dist-es/auth/httpAuthSchemeProvider.js +63 -0
- package/dist-es/commands/{UnlinkIdentityCommand.js → ApplyIdentityRemovalCommand.js} +5 -5
- package/dist-es/commands/{LinkIdentityCommand.js → ConfirmIdentityChallengeCommand.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 +4 -3
- package/dist-es/models/enums.js +16 -0
- package/dist-es/models/errors.js +96 -20
- package/dist-es/schemas/schemas_0.js +179 -85
- package/dist-types/Users.d.ts +28 -21
- package/dist-types/UsersClient.d.ts +6 -5
- package/dist-types/commands/ApplyIdentityRemovalCommand.d.ts +93 -0
- package/dist-types/commands/ConfirmIdentityChallengeCommand.d.ts +138 -0
- package/dist-types/commands/GetAccountCommand.d.ts +1 -1
- package/dist-types/commands/ListIdentitiesCommand.d.ts +4 -2
- package/dist-types/commands/ListWorkspacesCommand.d.ts +1 -1
- package/dist-types/commands/QueryUserCommand.d.ts +2 -1
- package/dist-types/commands/QueryUsersCommand.d.ts +2 -1
- package/dist-types/commands/ResendIdentityChallengeCodeCommand.d.ts +96 -0
- package/dist-types/commands/StartIdentityChallengeCommand.d.ts +138 -0
- package/dist-types/commands/UnlinkWorkspaceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountCommand.d.ts +2 -1
- package/dist-types/commands/index.d.ts +4 -3
- package/dist-types/models/enums.d.ts +70 -0
- package/dist-types/models/errors.d.ts +102 -17
- package/dist-types/models/models_0.d.ts +274 -87
- package/dist-types/schemas/schemas_0.d.ts +21 -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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
-
import type { AppType, BotAccess, BotCapabilityToolPipelineType, BotIntegrationType, BotLlmEmbeddedToolType, BotLlmFunctionIntegrationMethod, BotLlmToolType, BotSessionTimeoutMinutes, GetPbxColleaguesDir, PbxColleagueRole, PbxColleaguesQueryField, PbxColleaguesSearchStrategy, PbxLicenseType, SearchStrategy, SearchThresholdValue, WorkspaceType } from "./enums";
|
|
2
|
+
import type { AppType, BotAccess, BotCapabilityToolPipelineType, BotIntegrationType, BotLlmEmbeddedToolType, BotLlmFunctionIntegrationMethod, BotLlmToolType, BotSessionTimeoutMinutes, GetPbxColleaguesDir, IdentityChallengeOperation, IdentityChallengeStep, IdentityType, PbxColleagueRole, PbxColleaguesQueryField, PbxColleaguesSearchStrategy, PbxLicenseType, SearchStrategy, SearchThresholdValue, WorkspaceType } from "./enums";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
5
|
*/
|
|
@@ -100,12 +100,12 @@ export interface PbxColleague {
|
|
|
100
100
|
*/
|
|
101
101
|
export interface UserToInvite {
|
|
102
102
|
/**
|
|
103
|
-
* The email address of the invited user. If no user exists with the specified email and "colleague" flag is provided, the system will retrieve the colleague's details from the PBX.
|
|
103
|
+
* The email address of the invited user. If no user exists with the specified email and "colleague" flag is provided, the system will retrieve the colleague's details from the PBX. A phone-user address (`\{digits\}@phone.wildix.com`) invites the user who signs in via SMS with that number: the user is created before their first sign-in, without a phone, and is never the SMS/WhatsApp contact of the number.
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
106
|
email?: string | undefined;
|
|
107
107
|
/**
|
|
108
|
-
* The phone number of the invited
|
|
108
|
+
* The phone number of the invited SMS/WhatsApp contact: an external customer who never signs in. This phone number is used to create or find the contact if an email address is not provided; it never finds the user who signs in via SMS with that number. On a customer messaging channel (see MessagingChannel) it is not a phone number at all: the caller passes the channel's own customer id, the Page Scoped ID on Messenger, so the identity key stays the one the supplier reports. On RCS it is the person's phone number. A phone number allows up to 17 digits and a Page Scoped ID is 17, so there is no headroom left, and the Instagram scoped id has to be checked against the same limit. A WhatsApp user who hides the number is invited by the BSUID exactly as Meta spells it (see InviteePhone).
|
|
109
109
|
* @public
|
|
110
110
|
*/
|
|
111
111
|
phone?: string | undefined;
|
|
@@ -190,7 +190,7 @@ export interface Account {
|
|
|
190
190
|
*/
|
|
191
191
|
defaultWorkspace?: string | undefined;
|
|
192
192
|
/**
|
|
193
|
-
* The
|
|
193
|
+
* The address of the primary sign-in method, the one confirmation codes go to.
|
|
194
194
|
* @public
|
|
195
195
|
*/
|
|
196
196
|
primaryIdentity?: string | undefined;
|
|
@@ -235,6 +235,26 @@ export declare namespace AnonymousEntryContext {
|
|
|
235
235
|
_: (name: string, value: any) => T;
|
|
236
236
|
}
|
|
237
237
|
}
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
export interface ApplyIdentityRemovalInput {
|
|
242
|
+
/**
|
|
243
|
+
* The unique identifier of the account.
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
accountId: string;
|
|
247
|
+
/**
|
|
248
|
+
* The `remove` challenge returned by `StartIdentityChallenge`, at `step: readyToApply`.
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
challengeId: string;
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
export interface ApplyIdentityRemovalOutput {
|
|
257
|
+
}
|
|
238
258
|
/**
|
|
239
259
|
* @public
|
|
240
260
|
*/
|
|
@@ -256,7 +276,7 @@ export interface BatchGetUsersOutput {
|
|
|
256
276
|
*/
|
|
257
277
|
export interface BatchGetUsersEmailNotificationsSettingsInput {
|
|
258
278
|
/**
|
|
259
|
-
*
|
|
279
|
+
* The users to read, 1 to 500 ids. A PBX token or an API key gets the stored settings only of the users of its own company; any other id gets the default settings, as an unknown id does.
|
|
260
280
|
* @public
|
|
261
281
|
*/
|
|
262
282
|
usersIds: string[];
|
|
@@ -1203,6 +1223,125 @@ export interface ChangeUserEmailInput {
|
|
|
1203
1223
|
export interface ChangeUserEmailOutput {
|
|
1204
1224
|
sfnArn: string;
|
|
1205
1225
|
}
|
|
1226
|
+
/**
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
export interface ConfirmIdentityChallengeInput {
|
|
1230
|
+
/**
|
|
1231
|
+
* The unique identifier of the account.
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
accountId: string;
|
|
1235
|
+
/**
|
|
1236
|
+
* The challenge returned by `StartIdentityChallenge`.
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
challengeId: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* The code of the current step, as the user entered it.
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1244
|
+
code: string;
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
* A company workspace the account loses access to when the address is removed: the removed address is its last link to that PBX user.
|
|
1248
|
+
* @public
|
|
1249
|
+
*/
|
|
1250
|
+
export interface IdentityRemovalLostWorkspace {
|
|
1251
|
+
/**
|
|
1252
|
+
* The workspace that becomes inactive after the removal.
|
|
1253
|
+
* @public
|
|
1254
|
+
*/
|
|
1255
|
+
workspaceId: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* The name of the company of the workspace, for the warning text.
|
|
1258
|
+
* @public
|
|
1259
|
+
*/
|
|
1260
|
+
companyName: string;
|
|
1261
|
+
}
|
|
1262
|
+
/**
|
|
1263
|
+
* What removing the address will do, for the removal dialog. Computed when the challenge starts.
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
export interface IdentityRemovalDryRun {
|
|
1267
|
+
/**
|
|
1268
|
+
* True when the session that makes the request signed in with the address being removed: the removal signs it out, and the app should sign out right after `ApplyIdentityRemoval`.
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
endsThisSession: boolean;
|
|
1272
|
+
/**
|
|
1273
|
+
* Company workspaces for which the address is the last link of the account; empty when there are none.
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
lostWorkspaces: IdentityRemovalLostWorkspace[];
|
|
1277
|
+
/**
|
|
1278
|
+
* True when devices are signed in with the address being removed; they will be signed out.
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
signsOutDevices: boolean;
|
|
1282
|
+
}
|
|
1283
|
+
/**
|
|
1284
|
+
* A sign-in method (identity) of the account.
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
export interface Identity {
|
|
1288
|
+
/**
|
|
1289
|
+
* The identity value: an email in lower case or a phone number in E.164.
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
identity: string;
|
|
1293
|
+
/**
|
|
1294
|
+
* The unique identifier of the account.
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
account: string;
|
|
1298
|
+
/**
|
|
1299
|
+
* The kind of the sign-in method.
|
|
1300
|
+
* @public
|
|
1301
|
+
*/
|
|
1302
|
+
type: IdentityType;
|
|
1303
|
+
/**
|
|
1304
|
+
* True when the address has been confirmed with a code and can be used to sign in. False for an address being added (pending): it cannot sign in, gets nothing but its own verification code and is not reserved, so it disappears when another account verifies it first.
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
verified: boolean;
|
|
1308
|
+
/**
|
|
1309
|
+
* True for the primary sign-in method of the account, the one confirmation codes go to. Exactly one identity of the account is primary, and it is always verified.
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
primary: boolean;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* The state of an identity challenge, returned by `StartIdentityChallenge` and `ConfirmIdentityChallenge`.
|
|
1316
|
+
* @public
|
|
1317
|
+
*/
|
|
1318
|
+
export interface ConfirmIdentityChallengeOutput {
|
|
1319
|
+
/**
|
|
1320
|
+
* The identifier to pass to `ConfirmIdentityChallenge`, `ResendIdentityChallengeCode` and `ApplyIdentityRemoval`.
|
|
1321
|
+
* @public
|
|
1322
|
+
*/
|
|
1323
|
+
challengeId: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Where the challenge stands after this call.
|
|
1326
|
+
* @public
|
|
1327
|
+
*/
|
|
1328
|
+
step: IdentityChallengeStep;
|
|
1329
|
+
/**
|
|
1330
|
+
* Seconds until `ResendIdentityChallengeCode` may send the code of this step again. Present when this call sent a code (`step` is `primaryCode` or `targetCode`).
|
|
1331
|
+
* @public
|
|
1332
|
+
*/
|
|
1333
|
+
resendAfter?: number | undefined;
|
|
1334
|
+
/**
|
|
1335
|
+
* What the removal will do. Present on every response of a `remove` challenge.
|
|
1336
|
+
* @public
|
|
1337
|
+
*/
|
|
1338
|
+
dryRun?: IdentityRemovalDryRun | undefined;
|
|
1339
|
+
/**
|
|
1340
|
+
* The identity as it is now. Present when `step` is `done`.
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
identity?: Identity | undefined;
|
|
1344
|
+
}
|
|
1206
1345
|
/**
|
|
1207
1346
|
* @public
|
|
1208
1347
|
*/
|
|
@@ -1495,24 +1634,20 @@ export interface GetUserPbxLinkSuggestionV1Output {
|
|
|
1495
1634
|
suggestion?: UserPbxLinkSuggestion | undefined;
|
|
1496
1635
|
}
|
|
1497
1636
|
/**
|
|
1637
|
+
* The address an identity challenge is about.
|
|
1498
1638
|
* @public
|
|
1499
1639
|
*/
|
|
1500
|
-
export interface
|
|
1640
|
+
export interface IdentityTarget {
|
|
1501
1641
|
/**
|
|
1502
|
-
* The
|
|
1642
|
+
* The kind of the address.
|
|
1503
1643
|
* @public
|
|
1504
1644
|
*/
|
|
1505
|
-
|
|
1645
|
+
type: IdentityType;
|
|
1506
1646
|
/**
|
|
1507
|
-
* The
|
|
1647
|
+
* The address. The service normalizes it before any check: an email is lower-cased; a phone number is brought to E.164 and must be in a country SMS sign-in allows. For `verify`, `makePrimary` and `remove` it must match the `identity` of an identity of the account as `ListIdentities` returns it.
|
|
1508
1648
|
* @public
|
|
1509
1649
|
*/
|
|
1510
|
-
|
|
1511
|
-
/**
|
|
1512
|
-
* Indicates if the identity is verified.
|
|
1513
|
-
* @public
|
|
1514
|
-
*/
|
|
1515
|
-
verified?: boolean | undefined;
|
|
1650
|
+
value: string;
|
|
1516
1651
|
}
|
|
1517
1652
|
/**
|
|
1518
1653
|
* @public
|
|
@@ -1566,31 +1701,6 @@ export interface InviteOutput {
|
|
|
1566
1701
|
*/
|
|
1567
1702
|
skippedInvitees: SkippedMember[];
|
|
1568
1703
|
}
|
|
1569
|
-
/**
|
|
1570
|
-
* @public
|
|
1571
|
-
*/
|
|
1572
|
-
export interface LinkIdentityInput {
|
|
1573
|
-
/**
|
|
1574
|
-
* The unique identifier of the account.
|
|
1575
|
-
* @public
|
|
1576
|
-
*/
|
|
1577
|
-
accountId: string;
|
|
1578
|
-
/**
|
|
1579
|
-
* The identity value: email address or phone number in E.164.
|
|
1580
|
-
* @public
|
|
1581
|
-
*/
|
|
1582
|
-
identity: string;
|
|
1583
|
-
}
|
|
1584
|
-
/**
|
|
1585
|
-
* @public
|
|
1586
|
-
*/
|
|
1587
|
-
export interface LinkIdentityOutput {
|
|
1588
|
-
/**
|
|
1589
|
-
* The identity in pending state. OTP has been sent; call VerifyIdentity to complete.
|
|
1590
|
-
* @public
|
|
1591
|
-
*/
|
|
1592
|
-
identity: Identity;
|
|
1593
|
-
}
|
|
1594
1704
|
/**
|
|
1595
1705
|
* @public
|
|
1596
1706
|
*/
|
|
@@ -1630,6 +1740,10 @@ export interface ListIdentitiesInput {
|
|
|
1630
1740
|
* @public
|
|
1631
1741
|
*/
|
|
1632
1742
|
export interface ListIdentitiesOutput {
|
|
1743
|
+
/**
|
|
1744
|
+
* The verified and pending sign-in methods of the account.
|
|
1745
|
+
* @public
|
|
1746
|
+
*/
|
|
1633
1747
|
identities: Identity[];
|
|
1634
1748
|
}
|
|
1635
1749
|
/**
|
|
@@ -1768,7 +1882,7 @@ export interface QueryColleaguesInput {
|
|
|
1768
1882
|
company?: string | undefined;
|
|
1769
1883
|
query?: QueryColleaguesParameters | undefined;
|
|
1770
1884
|
/**
|
|
1771
|
-
* If enabled, the system will automatically invite users for colleagues returned from the PBX if they haven't logged in yet.
|
|
1885
|
+
* If enabled, the system will automatically invite users for colleagues returned from the PBX if they haven't logged in yet. A colleague without an email is the user of the phone-user address (`\{digits\}@phone.wildix.com`) of their mobile, which must be in E.164; a colleague with neither gets no user.
|
|
1772
1886
|
* @public
|
|
1773
1887
|
*/
|
|
1774
1888
|
invite?: boolean | undefined;
|
|
@@ -1827,7 +1941,7 @@ export declare namespace UserQuery {
|
|
|
1827
1941
|
$unknown?: never;
|
|
1828
1942
|
}
|
|
1829
1943
|
/**
|
|
1830
|
-
* The email address of the user.
|
|
1944
|
+
* The email address of the user. A phone-user address (`\{digits\}@phone.wildix.com`) finds the user who signs in via SMS with that number.
|
|
1831
1945
|
* @public
|
|
1832
1946
|
*/
|
|
1833
1947
|
interface EmailMember {
|
|
@@ -1837,7 +1951,7 @@ export declare namespace UserQuery {
|
|
|
1837
1951
|
$unknown?: never;
|
|
1838
1952
|
}
|
|
1839
1953
|
/**
|
|
1840
|
-
* The phone number of the user
|
|
1954
|
+
* The phone number of an SMS/WhatsApp contact: an external customer reached in SMS, WhatsApp or Messenger channels, who never signs in. It never finds the user who signs in via SMS with that number; query that user by the phone-user address in `email`.
|
|
1841
1955
|
* @public
|
|
1842
1956
|
*/
|
|
1843
1957
|
interface PhoneMember {
|
|
@@ -1870,6 +1984,11 @@ export declare namespace UserQuery {
|
|
|
1870
1984
|
* @public
|
|
1871
1985
|
*/
|
|
1872
1986
|
export interface QueryUserInput {
|
|
1987
|
+
/**
|
|
1988
|
+
* The unique identifier of the tenant when a service token is used. A user who has a workspace in this tenant is returned as that workspace instead of the default one. Other tokens use the tenant they were issued for.
|
|
1989
|
+
* @public
|
|
1990
|
+
*/
|
|
1991
|
+
companyId?: string | undefined;
|
|
1873
1992
|
query: UserQuery;
|
|
1874
1993
|
/**
|
|
1875
1994
|
* A condition that must be satisfied for the user query to be considered valid. If this predicate is not met, a UserQueryPredicateNotMetException will be thrown.
|
|
@@ -1887,6 +2006,11 @@ export interface QueryUserOutput {
|
|
|
1887
2006
|
* @public
|
|
1888
2007
|
*/
|
|
1889
2008
|
export interface QueryUsersInput {
|
|
2009
|
+
/**
|
|
2010
|
+
* The unique identifier of the tenant when a service token is used. A user who has a workspace in this tenant is returned as that workspace instead of the default one. Other tokens use the tenant they were issued for.
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
companyId?: string | undefined;
|
|
1890
2014
|
queries: UserQuery[];
|
|
1891
2015
|
predicate?: UserQueryPredicate | undefined;
|
|
1892
2016
|
}
|
|
@@ -1900,6 +2024,36 @@ export interface QueryUsersOutput {
|
|
|
1900
2024
|
*/
|
|
1901
2025
|
users: User[];
|
|
1902
2026
|
}
|
|
2027
|
+
/**
|
|
2028
|
+
* @public
|
|
2029
|
+
*/
|
|
2030
|
+
export interface ResendIdentityChallengeCodeInput {
|
|
2031
|
+
/**
|
|
2032
|
+
* The unique identifier of the account.
|
|
2033
|
+
* @public
|
|
2034
|
+
*/
|
|
2035
|
+
accountId: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* The challenge returned by `StartIdentityChallenge`.
|
|
2038
|
+
* @public
|
|
2039
|
+
*/
|
|
2040
|
+
challengeId: string;
|
|
2041
|
+
}
|
|
2042
|
+
/**
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
export interface ResendIdentityChallengeCodeOutput {
|
|
2046
|
+
/**
|
|
2047
|
+
* The step the new code is for: `primaryCode` or `targetCode`.
|
|
2048
|
+
* @public
|
|
2049
|
+
*/
|
|
2050
|
+
step: IdentityChallengeStep;
|
|
2051
|
+
/**
|
|
2052
|
+
* Seconds until the code may be sent again.
|
|
2053
|
+
* @public
|
|
2054
|
+
*/
|
|
2055
|
+
resendAfter: number;
|
|
2056
|
+
}
|
|
1903
2057
|
/**
|
|
1904
2058
|
* @public
|
|
1905
2059
|
*/
|
|
@@ -1934,32 +2088,95 @@ export interface ResetUserChatHistoryInput {
|
|
|
1934
2088
|
* @public
|
|
1935
2089
|
*/
|
|
1936
2090
|
export interface ResetUserChatHistoryOutput {
|
|
2091
|
+
/**
|
|
2092
|
+
* The workspaces marked deleted. Empty when no workspace matched.
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
1937
2095
|
deletedWorkspaceIds: string[];
|
|
2096
|
+
/**
|
|
2097
|
+
* The new workspaces, one for each account that lost a workspace. Empty when the user does not stay on the PBX or nothing was deleted.
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
1938
2100
|
createdWorkspaceIds: string[];
|
|
1939
2101
|
}
|
|
1940
2102
|
/**
|
|
1941
2103
|
* @public
|
|
1942
2104
|
*/
|
|
1943
|
-
export interface
|
|
1944
|
-
unsubscribeToken: string;
|
|
2105
|
+
export interface StartIdentityChallengeInput {
|
|
1945
2106
|
/**
|
|
1946
|
-
*
|
|
2107
|
+
* The unique identifier of the account.
|
|
1947
2108
|
* @public
|
|
1948
2109
|
*/
|
|
1949
|
-
|
|
2110
|
+
accountId: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* The change to make.
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
2115
|
+
operation: IdentityChallengeOperation;
|
|
2116
|
+
/**
|
|
2117
|
+
* The address the change is about.
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
target: IdentityTarget;
|
|
2121
|
+
/**
|
|
2122
|
+
* Cloudflare Turnstile token, as in SMS sign-in. Required when a code goes to a phone target: `add` of a phone number and `verify` of a pending phone number. A missing token or one Cloudflare rejects gives `ValidationException`; Turnstile unreachable or timing out gives `ServiceUnavailableException`.
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
2125
|
+
captchaToken?: string | undefined;
|
|
2126
|
+
/**
|
|
2127
|
+
* The user agreed to receive one-time codes by SMS from Wildix, Inc. Required (true) for a US or Canadian number in `add` and `verify`; a missing consent gives `ValidationException`.
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
smsConsent?: boolean | undefined;
|
|
2131
|
+
/**
|
|
2132
|
+
* The user accepted the Terms of Service and the Privacy Policy. Required (true) for a US or Canadian number in `add` and `verify`; a missing consent gives `ValidationException`.
|
|
2133
|
+
* @public
|
|
2134
|
+
*/
|
|
2135
|
+
termsAccepted?: boolean | undefined;
|
|
2136
|
+
/**
|
|
2137
|
+
* The app's current locale, used for the letters and SMS with codes of this challenge. English when absent or not supported.
|
|
2138
|
+
* @public
|
|
2139
|
+
*/
|
|
2140
|
+
language?: string | undefined;
|
|
1950
2141
|
}
|
|
1951
2142
|
/**
|
|
2143
|
+
* The state of an identity challenge, returned by `StartIdentityChallenge` and `ConfirmIdentityChallenge`.
|
|
1952
2144
|
* @public
|
|
1953
2145
|
*/
|
|
1954
|
-
export interface
|
|
2146
|
+
export interface StartIdentityChallengeOutput {
|
|
2147
|
+
/**
|
|
2148
|
+
* The identifier to pass to `ConfirmIdentityChallenge`, `ResendIdentityChallengeCode` and `ApplyIdentityRemoval`.
|
|
2149
|
+
* @public
|
|
2150
|
+
*/
|
|
2151
|
+
challengeId: string;
|
|
2152
|
+
/**
|
|
2153
|
+
* Where the challenge stands after this call.
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
step: IdentityChallengeStep;
|
|
2157
|
+
/**
|
|
2158
|
+
* Seconds until `ResendIdentityChallengeCode` may send the code of this step again. Present when this call sent a code (`step` is `primaryCode` or `targetCode`).
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
2161
|
+
resendAfter?: number | undefined;
|
|
2162
|
+
/**
|
|
2163
|
+
* What the removal will do. Present on every response of a `remove` challenge.
|
|
2164
|
+
* @public
|
|
2165
|
+
*/
|
|
2166
|
+
dryRun?: IdentityRemovalDryRun | undefined;
|
|
2167
|
+
/**
|
|
2168
|
+
* The identity as it is now. Present when `step` is `done`.
|
|
2169
|
+
* @public
|
|
2170
|
+
*/
|
|
2171
|
+
identity?: Identity | undefined;
|
|
1955
2172
|
}
|
|
1956
2173
|
/**
|
|
1957
2174
|
* @public
|
|
1958
2175
|
*/
|
|
1959
|
-
export interface
|
|
2176
|
+
export interface ToggleTranscriptionEmailNotificationsSubscriptionInput {
|
|
1960
2177
|
unsubscribeToken: string;
|
|
1961
2178
|
/**
|
|
1962
|
-
* A flag that indicates whether the system should send email notifications about
|
|
2179
|
+
* A flag that indicates whether the system should send email notifications about AI transcription.
|
|
1963
2180
|
* @public
|
|
1964
2181
|
*/
|
|
1965
2182
|
subscribe: boolean;
|
|
@@ -1967,27 +2184,23 @@ export interface ToggleUnreadEmailNotificationsSubscriptionInput {
|
|
|
1967
2184
|
/**
|
|
1968
2185
|
* @public
|
|
1969
2186
|
*/
|
|
1970
|
-
export interface
|
|
2187
|
+
export interface ToggleTranscriptionEmailNotificationsSubscriptionOutput {
|
|
1971
2188
|
}
|
|
1972
2189
|
/**
|
|
1973
2190
|
* @public
|
|
1974
2191
|
*/
|
|
1975
|
-
export interface
|
|
1976
|
-
|
|
1977
|
-
* The unique identifier of the account.
|
|
1978
|
-
* @public
|
|
1979
|
-
*/
|
|
1980
|
-
accountId: string;
|
|
2192
|
+
export interface ToggleUnreadEmailNotificationsSubscriptionInput {
|
|
2193
|
+
unsubscribeToken: string;
|
|
1981
2194
|
/**
|
|
1982
|
-
*
|
|
2195
|
+
* A flag that indicates whether the system should send email notifications about unread messages.
|
|
1983
2196
|
* @public
|
|
1984
2197
|
*/
|
|
1985
|
-
|
|
2198
|
+
subscribe: boolean;
|
|
1986
2199
|
}
|
|
1987
2200
|
/**
|
|
1988
2201
|
* @public
|
|
1989
2202
|
*/
|
|
1990
|
-
export interface
|
|
2203
|
+
export interface ToggleUnreadEmailNotificationsSubscriptionOutput {
|
|
1991
2204
|
}
|
|
1992
2205
|
/**
|
|
1993
2206
|
* @public
|
|
@@ -2024,7 +2237,7 @@ export interface UpdateAccountInput {
|
|
|
2024
2237
|
*/
|
|
2025
2238
|
defaultWorkspace?: string | undefined;
|
|
2026
2239
|
/**
|
|
2027
|
-
* The identity
|
|
2240
|
+
* The verified identity of the account (email or phone) to set as primary. Accepted only from s2s (service-to-service) callers, such as the support tool that recovers a lost primary; a request with an x-bees token that sets it gets `ForbiddenException`. Users change the primary with a `makePrimary` identity challenge.
|
|
2028
2241
|
* @public
|
|
2029
2242
|
*/
|
|
2030
2243
|
primaryIdentity?: string | undefined;
|
|
@@ -2226,29 +2439,3 @@ export interface VerifyBotSecretKeyV1Output {
|
|
|
2226
2439
|
id: string;
|
|
2227
2440
|
name?: string | undefined;
|
|
2228
2441
|
}
|
|
2229
|
-
/**
|
|
2230
|
-
* @public
|
|
2231
|
-
*/
|
|
2232
|
-
export interface VerifyIdentityInput {
|
|
2233
|
-
/**
|
|
2234
|
-
* The unique identifier of the account.
|
|
2235
|
-
* @public
|
|
2236
|
-
*/
|
|
2237
|
-
accountId: string;
|
|
2238
|
-
/**
|
|
2239
|
-
* The identity value that was added (email or phone).
|
|
2240
|
-
* @public
|
|
2241
|
-
*/
|
|
2242
|
-
identity: string;
|
|
2243
|
-
/**
|
|
2244
|
-
* OTP sent to the new identity to prove ownership.
|
|
2245
|
-
* @public
|
|
2246
|
-
*/
|
|
2247
|
-
otp: string;
|
|
2248
|
-
}
|
|
2249
|
-
/**
|
|
2250
|
-
* @public
|
|
2251
|
-
*/
|
|
2252
|
-
export interface VerifyIdentityOutput {
|
|
2253
|
-
identity: Identity;
|
|
2254
|
-
}
|
|
@@ -3,6 +3,7 @@ import type { StaticErrorSchema, StaticOperationSchema, StaticStructureSchema, S
|
|
|
3
3
|
export declare var UsersServiceException$: StaticErrorSchema;
|
|
4
4
|
export declare var ForbiddenException$: StaticErrorSchema;
|
|
5
5
|
export declare var RateLimitExceededException$: StaticErrorSchema;
|
|
6
|
+
export declare var ServiceUnavailableException$: StaticErrorSchema;
|
|
6
7
|
export declare var ValidationException$: StaticErrorSchema;
|
|
7
8
|
export declare var ChannelNotFoundException$: StaticErrorSchema;
|
|
8
9
|
export declare var WidgetNotFoundException$: StaticErrorSchema;
|
|
@@ -13,9 +14,14 @@ export declare var BotNotFoundException$: StaticErrorSchema;
|
|
|
13
14
|
export declare var BotSecretKeyNotValidException$: StaticErrorSchema;
|
|
14
15
|
export declare var CannotRemovePrimaryIdentityException$: StaticErrorSchema;
|
|
15
16
|
export declare var CannotUnbindDefaultWorkspaceException$: StaticErrorSchema;
|
|
17
|
+
export declare var ChallengeNotFoundException$: StaticErrorSchema;
|
|
18
|
+
export declare var CodeExpiredException$: StaticErrorSchema;
|
|
16
19
|
export declare var IdentityAlreadyLinkedException$: StaticErrorSchema;
|
|
17
20
|
export declare var IdentityNotFoundException$: StaticErrorSchema;
|
|
21
|
+
export declare var IncorrectCodeException$: StaticErrorSchema;
|
|
18
22
|
export declare var PublicAccessIsRestrictedException$: StaticErrorSchema;
|
|
23
|
+
export declare var RateLimitedException$: StaticErrorSchema;
|
|
24
|
+
export declare var TooManyAttemptsException$: StaticErrorSchema;
|
|
19
25
|
export declare var UserCompanyNotValidException$: StaticErrorSchema;
|
|
20
26
|
export declare var UserNotFoundException$: StaticErrorSchema;
|
|
21
27
|
export declare var UserQueryPredicateNotMetException$: StaticErrorSchema;
|
|
@@ -32,6 +38,8 @@ export declare var SkippedMember$: StaticStructureSchema;
|
|
|
32
38
|
export declare var User$: StaticStructureSchema;
|
|
33
39
|
export declare var UserToInvite$: StaticStructureSchema;
|
|
34
40
|
export declare var Account$: StaticStructureSchema;
|
|
41
|
+
export declare var ApplyIdentityRemovalInput$: StaticStructureSchema;
|
|
42
|
+
export declare var ApplyIdentityRemovalOutput$: StaticStructureSchema;
|
|
35
43
|
export declare var BatchGetUsersEmailNotificationsSettingsInput$: StaticStructureSchema;
|
|
36
44
|
export declare var BatchGetUsersEmailNotificationsSettingsOutput$: StaticStructureSchema;
|
|
37
45
|
export declare var BatchGetUsersInput$: StaticStructureSchema;
|
|
@@ -69,6 +77,8 @@ export declare var BotToolVariablesAnnotation$: StaticStructureSchema;
|
|
|
69
77
|
export declare var BotWebhookEndpoint$: StaticStructureSchema;
|
|
70
78
|
export declare var ChangeUserEmailInput$: StaticStructureSchema;
|
|
71
79
|
export declare var ChangeUserEmailOutput$: StaticStructureSchema;
|
|
80
|
+
export declare var ConfirmIdentityChallengeInput$: StaticStructureSchema;
|
|
81
|
+
export declare var ConfirmIdentityChallengeOutput$: StaticStructureSchema;
|
|
72
82
|
export declare var CreateAnonymousSessionInput$: StaticStructureSchema;
|
|
73
83
|
export declare var CreateAnonymousSessionOutput$: StaticStructureSchema;
|
|
74
84
|
export declare var CreateBotApiKeyInput$: StaticStructureSchema;
|
|
@@ -101,12 +111,13 @@ export declare var GetUserPbxLinkSuggestionOutput$: StaticStructureSchema;
|
|
|
101
111
|
export declare var GetUserPbxLinkSuggestionV1Input$: StaticStructureSchema;
|
|
102
112
|
export declare var GetUserPbxLinkSuggestionV1Output$: StaticStructureSchema;
|
|
103
113
|
export declare var Identity$: StaticStructureSchema;
|
|
114
|
+
export declare var IdentityRemovalDryRun$: StaticStructureSchema;
|
|
115
|
+
export declare var IdentityRemovalLostWorkspace$: StaticStructureSchema;
|
|
116
|
+
export declare var IdentityTarget$: StaticStructureSchema;
|
|
104
117
|
export declare var IntelligenceSearchInput$: StaticStructureSchema;
|
|
105
118
|
export declare var IntelligenceSearchOutput$: StaticStructureSchema;
|
|
106
119
|
export declare var InviteInput$: StaticStructureSchema;
|
|
107
120
|
export declare var InviteOutput$: StaticStructureSchema;
|
|
108
|
-
export declare var LinkIdentityInput$: StaticStructureSchema;
|
|
109
|
-
export declare var LinkIdentityOutput$: StaticStructureSchema;
|
|
110
121
|
export declare var ListBotApiKeysInput$: StaticStructureSchema;
|
|
111
122
|
export declare var ListBotApiKeysOutput$: StaticStructureSchema;
|
|
112
123
|
export declare var ListBotsInput$: StaticStructureSchema;
|
|
@@ -127,14 +138,16 @@ export declare var QueryUserInput$: StaticStructureSchema;
|
|
|
127
138
|
export declare var QueryUserOutput$: StaticStructureSchema;
|
|
128
139
|
export declare var QueryUsersInput$: StaticStructureSchema;
|
|
129
140
|
export declare var QueryUsersOutput$: StaticStructureSchema;
|
|
141
|
+
export declare var ResendIdentityChallengeCodeInput$: StaticStructureSchema;
|
|
142
|
+
export declare var ResendIdentityChallengeCodeOutput$: StaticStructureSchema;
|
|
130
143
|
export declare var ResetUserChatHistoryInput$: StaticStructureSchema;
|
|
131
144
|
export declare var ResetUserChatHistoryOutput$: StaticStructureSchema;
|
|
145
|
+
export declare var StartIdentityChallengeInput$: StaticStructureSchema;
|
|
146
|
+
export declare var StartIdentityChallengeOutput$: StaticStructureSchema;
|
|
132
147
|
export declare var ToggleTranscriptionEmailNotificationsSubscriptionInput$: StaticStructureSchema;
|
|
133
148
|
export declare var ToggleTranscriptionEmailNotificationsSubscriptionOutput$: StaticStructureSchema;
|
|
134
149
|
export declare var ToggleUnreadEmailNotificationsSubscriptionInput$: StaticStructureSchema;
|
|
135
150
|
export declare var ToggleUnreadEmailNotificationsSubscriptionOutput$: StaticStructureSchema;
|
|
136
|
-
export declare var UnlinkIdentityInput$: StaticStructureSchema;
|
|
137
|
-
export declare var UnlinkIdentityOutput$: StaticStructureSchema;
|
|
138
151
|
export declare var UnlinkWorkspaceInput$: StaticStructureSchema;
|
|
139
152
|
export declare var UnlinkWorkspaceOutput$: StaticStructureSchema;
|
|
140
153
|
export declare var UpdateAccountInput$: StaticStructureSchema;
|
|
@@ -164,8 +177,6 @@ export declare var VerifyBotSecretKeyInput$: StaticStructureSchema;
|
|
|
164
177
|
export declare var VerifyBotSecretKeyOutput$: StaticStructureSchema;
|
|
165
178
|
export declare var VerifyBotSecretKeyV1Input$: StaticStructureSchema;
|
|
166
179
|
export declare var VerifyBotSecretKeyV1Output$: StaticStructureSchema;
|
|
167
|
-
export declare var VerifyIdentityInput$: StaticStructureSchema;
|
|
168
|
-
export declare var VerifyIdentityOutput$: StaticStructureSchema;
|
|
169
180
|
export declare var Workspace$: StaticStructureSchema;
|
|
170
181
|
export declare var AnonymousEntryContext$: StaticUnionSchema;
|
|
171
182
|
export declare var BotCapability$: StaticUnionSchema;
|
|
@@ -175,11 +186,13 @@ export declare var BotLlmFunctionIntegrationWebhookAuthorization$: StaticUnionSc
|
|
|
175
186
|
export declare var BotToolAnnotation$: StaticUnionSchema;
|
|
176
187
|
export declare var BotToolVariableHandler$: StaticUnionSchema;
|
|
177
188
|
export declare var UserQuery$: StaticUnionSchema;
|
|
189
|
+
export declare var ApplyIdentityRemoval$: StaticOperationSchema;
|
|
178
190
|
export declare var BatchGetUsers$: StaticOperationSchema;
|
|
179
191
|
export declare var BatchGetUsersEmailNotificationsSettings$: StaticOperationSchema;
|
|
180
192
|
export declare var BatchGetUsersPbxLinkData$: StaticOperationSchema;
|
|
181
193
|
export declare var BatchGetUsersPbxLinkDataV1$: StaticOperationSchema;
|
|
182
194
|
export declare var ChangeUserEmail$: StaticOperationSchema;
|
|
195
|
+
export declare var ConfirmIdentityChallenge$: StaticOperationSchema;
|
|
183
196
|
export declare var CreateAnonymousSession$: StaticOperationSchema;
|
|
184
197
|
export declare var CreateBot$: StaticOperationSchema;
|
|
185
198
|
export declare var CreateBotApiKey$: StaticOperationSchema;
|
|
@@ -197,7 +210,6 @@ export declare var GetUserPbxLinkSuggestion$: StaticOperationSchema;
|
|
|
197
210
|
export declare var GetUserPbxLinkSuggestionV1$: StaticOperationSchema;
|
|
198
211
|
export declare var IntelligenceSearch$: StaticOperationSchema;
|
|
199
212
|
export declare var Invite$: StaticOperationSchema;
|
|
200
|
-
export declare var LinkIdentity$: StaticOperationSchema;
|
|
201
213
|
export declare var ListBotApiKeys$: StaticOperationSchema;
|
|
202
214
|
export declare var ListBots$: StaticOperationSchema;
|
|
203
215
|
export declare var ListIdentities$: StaticOperationSchema;
|
|
@@ -206,10 +218,11 @@ export declare var PartialUpdateUserEmailNotificationsSettings$: StaticOperation
|
|
|
206
218
|
export declare var QueryColleagues$: StaticOperationSchema;
|
|
207
219
|
export declare var QueryUser$: StaticOperationSchema;
|
|
208
220
|
export declare var QueryUsers$: StaticOperationSchema;
|
|
221
|
+
export declare var ResendIdentityChallengeCode$: StaticOperationSchema;
|
|
209
222
|
export declare var ResetUserChatHistory$: StaticOperationSchema;
|
|
223
|
+
export declare var StartIdentityChallenge$: StaticOperationSchema;
|
|
210
224
|
export declare var ToggleTranscriptionEmailNotificationsSubscription$: StaticOperationSchema;
|
|
211
225
|
export declare var ToggleUnreadEmailNotificationsSubscription$: StaticOperationSchema;
|
|
212
|
-
export declare var UnlinkIdentity$: StaticOperationSchema;
|
|
213
226
|
export declare var UnlinkWorkspace$: StaticOperationSchema;
|
|
214
227
|
export declare var UpdateAccount$: StaticOperationSchema;
|
|
215
228
|
export declare var UpdateBot$: StaticOperationSchema;
|
|
@@ -220,4 +233,3 @@ export declare var UploadPicture$: StaticOperationSchema;
|
|
|
220
233
|
export declare var UploadPictureV1$: StaticOperationSchema;
|
|
221
234
|
export declare var VerifyBotSecretKey$: StaticOperationSchema;
|
|
222
235
|
export declare var VerifyBotSecretKeyV1$: StaticOperationSchema;
|
|
223
|
-
export declare var VerifyIdentity$: StaticOperationSchema;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wildix/xbees-users-client",
|
|
3
3
|
"description": "@wildix/xbees-users-client client",
|
|
4
|
-
"version": "4.3.
|
|
4
|
+
"version": "4.3.3-wms26787.1",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -17,24 +17,24 @@
|
|
|
17
17
|
"module": "./dist-es/index.js",
|
|
18
18
|
"sideEffects": false,
|
|
19
19
|
"dependencies": {
|
|
20
|
-
"tslib": "^2.6.2",
|
|
21
20
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
21
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
22
|
"@aws-sdk/core": "^3.974.15",
|
|
24
23
|
"@smithy/core": "^3.24.5",
|
|
25
24
|
"@smithy/fetch-http-handler": "^5.4.5",
|
|
25
|
+
"@smithy/middleware-endpoint": "^4.7.2",
|
|
26
26
|
"@smithy/node-http-handler": "^4.7.5",
|
|
27
27
|
"@smithy/types": "^4.14.2",
|
|
28
28
|
"@wildix/smithy-react-native": "^1.0.0",
|
|
29
|
-
"
|
|
29
|
+
"tslib": "^2.6.2"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@tsconfig/node20": "20.1.8",
|
|
33
|
+
"@types/node": "^20.14.8",
|
|
33
34
|
"concurrently": "7.0.0",
|
|
34
35
|
"downlevel-dts": "0.10.1",
|
|
35
36
|
"premove": "4.0.0",
|
|
36
|
-
"typescript": "~5.8.3"
|
|
37
|
-
"@types/node": "^20.14.8"
|
|
37
|
+
"typescript": "~5.8.3"
|
|
38
38
|
},
|
|
39
39
|
"engines": {
|
|
40
40
|
"node": ">=20.0.0"
|