@wildix/xbees-users-client 4.2.0 → 4.2.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.
@@ -328,7 +328,8 @@ const _kb = "kb";
328
328
  const _ke = "keys";
329
329
  const _l = "language";
330
330
  const _lT = "licenseType";
331
- const _li = "license";
331
+ const _li = "limit";
332
+ const _lic = "license";
332
333
  const _ll = "llm";
333
334
  const _lo = "login";
334
335
  const _loc = "locale";
@@ -341,11 +342,12 @@ const _n = "name";
341
342
  const _nA = "networkAddresses";
342
343
  const _nD = "newData";
343
344
  const _no = "notifications";
344
- const _o = "otp";
345
+ const _o = "offset";
345
346
  const _oAA = "openAiAssistant";
346
347
  const _oD = "oldData";
347
348
  const _oP = "officePhone";
348
349
  const _oa = "oauth";
350
+ const _ot = "otp";
349
351
  const _p = "pbx";
350
352
  const _pD = "pbxDn";
351
353
  const _pDb = "pbxDomain";
@@ -406,6 +408,7 @@ const _ti = "timeout";
406
408
  const _to = "tools";
407
409
  const _tok = "token";
408
410
  const _too = "tool";
411
+ const _tot = "total";
409
412
  const _tr = "transcription";
410
413
  const _u = "users";
411
414
  const _uA = "updatedAt";
@@ -1001,13 +1004,13 @@ exports.ListIdentitiesOutput$ = [3, n3, _LIOi,
1001
1004
  ];
1002
1005
  exports.ListWorkspacesInput$ = [3, n3, _LWI,
1003
1006
  0,
1004
- [_aIc],
1005
- [[0, 1]], 1
1007
+ [_aIc, _li, _o, _q],
1008
+ [[0, 1], [1, { [_hQ]: _li }], [1, { [_hQ]: _o }], [0, { [_hQ]: _q }]], 1
1006
1009
  ];
1007
1010
  exports.ListWorkspacesOutput$ = [3, n3, _LWO,
1008
1011
  0,
1009
- [_w],
1010
- [() => WorkspaceList], 1
1012
+ [_w, _tot],
1013
+ [() => WorkspaceList, 1], 1
1011
1014
  ];
1012
1015
  exports.NewEmailData$ = [3, n3, _NED,
1013
1016
  0,
@@ -1051,8 +1054,8 @@ exports.QueryColleaguesParameters$ = [3, n3, _QCP,
1051
1054
  ];
1052
1055
  exports.QueryUserInput$ = [3, n3, _QUI,
1053
1056
  0,
1054
- [_q, _pre],
1055
- [() => exports.UserQuery$, () => exports.UserQueryPredicate$], 1
1057
+ [_q, _cIo, _pre],
1058
+ [() => exports.UserQuery$, [0, { [_hQ]: _co }], () => exports.UserQueryPredicate$], 1
1056
1059
  ];
1057
1060
  exports.QueryUserOutput$ = [3, n3, _QUO,
1058
1061
  0,
@@ -1061,8 +1064,8 @@ exports.QueryUserOutput$ = [3, n3, _QUO,
1061
1064
  ];
1062
1065
  exports.QueryUsersInput$ = [3, n3, _QUIu,
1063
1066
  0,
1064
- [_qu, _pre],
1065
- [() => UsersQueryList, () => exports.UserQueryPredicate$], 1
1067
+ [_qu, _cIo, _pre],
1068
+ [() => UsersQueryList, [0, { [_hQ]: _co }], () => exports.UserQueryPredicate$], 1
1066
1069
  ];
1067
1070
  exports.QueryUsersOutput$ = [3, n3, _QUOu,
1068
1071
  0,
@@ -1221,7 +1224,7 @@ exports.UserPersonalInfo$ = [3, n3, _UPIse,
1221
1224
  ];
1222
1225
  exports.UserQueryPredicate$ = [3, n3, _UQP,
1223
1226
  0,
1224
- [_li],
1227
+ [_lic],
1225
1228
  [0]
1226
1229
  ];
1227
1230
  exports.VerifyBotSecretKeyInput$ = [3, n3, _VBSKI,
@@ -1246,7 +1249,7 @@ exports.VerifyBotSecretKeyV1Output$ = [3, n3, _VBSKVO,
1246
1249
  ];
1247
1250
  exports.VerifyIdentityInput$ = [3, n3, _VII,
1248
1251
  0,
1249
- [_aIc, _id, _o],
1252
+ [_aIc, _id, _ot],
1250
1253
  [[0, 1], 0, 0], 3
1251
1254
  ];
1252
1255
  exports.VerifyIdentityOutput$ = [3, n3, _VIO,
@@ -321,7 +321,8 @@ const _kb = "kb";
321
321
  const _ke = "keys";
322
322
  const _l = "language";
323
323
  const _lT = "licenseType";
324
- const _li = "license";
324
+ const _li = "limit";
325
+ const _lic = "license";
325
326
  const _ll = "llm";
326
327
  const _lo = "login";
327
328
  const _loc = "locale";
@@ -334,11 +335,12 @@ const _n = "name";
334
335
  const _nA = "networkAddresses";
335
336
  const _nD = "newData";
336
337
  const _no = "notifications";
337
- const _o = "otp";
338
+ const _o = "offset";
338
339
  const _oAA = "openAiAssistant";
339
340
  const _oD = "oldData";
340
341
  const _oP = "officePhone";
341
342
  const _oa = "oauth";
343
+ const _ot = "otp";
342
344
  const _p = "pbx";
343
345
  const _pD = "pbxDn";
344
346
  const _pDb = "pbxDomain";
@@ -399,6 +401,7 @@ const _ti = "timeout";
399
401
  const _to = "tools";
400
402
  const _tok = "token";
401
403
  const _too = "tool";
404
+ const _tot = "total";
402
405
  const _tr = "transcription";
403
406
  const _u = "users";
404
407
  const _uA = "updatedAt";
@@ -994,13 +997,13 @@ export var ListIdentitiesOutput$ = [3, n3, _LIOi,
994
997
  ];
995
998
  export var ListWorkspacesInput$ = [3, n3, _LWI,
996
999
  0,
997
- [_aIc],
998
- [[0, 1]], 1
1000
+ [_aIc, _li, _o, _q],
1001
+ [[0, 1], [1, { [_hQ]: _li }], [1, { [_hQ]: _o }], [0, { [_hQ]: _q }]], 1
999
1002
  ];
1000
1003
  export var ListWorkspacesOutput$ = [3, n3, _LWO,
1001
1004
  0,
1002
- [_w],
1003
- [() => WorkspaceList], 1
1005
+ [_w, _tot],
1006
+ [() => WorkspaceList, 1], 1
1004
1007
  ];
1005
1008
  export var NewEmailData$ = [3, n3, _NED,
1006
1009
  0,
@@ -1044,8 +1047,8 @@ export var QueryColleaguesParameters$ = [3, n3, _QCP,
1044
1047
  ];
1045
1048
  export var QueryUserInput$ = [3, n3, _QUI,
1046
1049
  0,
1047
- [_q, _pre],
1048
- [() => UserQuery$, () => UserQueryPredicate$], 1
1050
+ [_q, _cIo, _pre],
1051
+ [() => UserQuery$, [0, { [_hQ]: _co }], () => UserQueryPredicate$], 1
1049
1052
  ];
1050
1053
  export var QueryUserOutput$ = [3, n3, _QUO,
1051
1054
  0,
@@ -1054,8 +1057,8 @@ export var QueryUserOutput$ = [3, n3, _QUO,
1054
1057
  ];
1055
1058
  export var QueryUsersInput$ = [3, n3, _QUIu,
1056
1059
  0,
1057
- [_qu, _pre],
1058
- [() => UsersQueryList, () => UserQueryPredicate$], 1
1060
+ [_qu, _cIo, _pre],
1061
+ [() => UsersQueryList, [0, { [_hQ]: _co }], () => UserQueryPredicate$], 1
1059
1062
  ];
1060
1063
  export var QueryUsersOutput$ = [3, n3, _QUOu,
1061
1064
  0,
@@ -1214,7 +1217,7 @@ export var UserPersonalInfo$ = [3, n3, _UPIse,
1214
1217
  ];
1215
1218
  export var UserQueryPredicate$ = [3, n3, _UQP,
1216
1219
  0,
1217
- [_li],
1220
+ [_lic],
1218
1221
  [0]
1219
1222
  ];
1220
1223
  export var VerifyBotSecretKeyInput$ = [3, n3, _VBSKI,
@@ -1239,7 +1242,7 @@ export var VerifyBotSecretKeyV1Output$ = [3, n3, _VBSKVO,
1239
1242
  ];
1240
1243
  export var VerifyIdentityInput$ = [3, n3, _VII,
1241
1244
  0,
1242
- [_aIc, _id, _o],
1245
+ [_aIc, _id, _ot],
1243
1246
  [[0, 1], 0, 0], 3
1244
1247
  ];
1245
1248
  export var VerifyIdentityOutput$ = [3, n3, _VIO,
@@ -27,7 +27,7 @@ declare const ListWorkspacesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Lists all workspaces available to the account.
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.
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -38,6 +38,9 @@ declare const ListWorkspacesCommand_base: {
38
38
  * const client = new UsersClient(config);
39
39
  * const input = { // ListWorkspacesInput
40
40
  * accountId: "STRING_VALUE", // required
41
+ * limit: Number("int"),
42
+ * offset: Number("int"),
43
+ * query: "STRING_VALUE",
41
44
  * };
42
45
  * const command = new ListWorkspacesCommand(input);
43
46
  * const response = await client.send(command);
@@ -125,6 +128,7 @@ declare const ListWorkspacesCommand_base: {
125
128
  * // active: true || false, // required
126
129
  * // },
127
130
  * // ],
131
+ * // total: Number("int"),
128
132
  * // };
129
133
  *
130
134
  * ```
@@ -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",
@@ -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",
@@ -105,7 +105,7 @@ export interface UserToInvite {
105
105
  */
106
106
  email?: string | undefined;
107
107
  /**
108
- * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided. 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. 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).
108
+ * The phone number of the invited user. This phone number is used to create or find the user if an email address is not provided. On Messenger and Instagram 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;
@@ -1641,6 +1641,21 @@ export interface ListWorkspacesInput {
1641
1641
  * @public
1642
1642
  */
1643
1643
  accountId: string;
1644
+ /**
1645
+ * Maximum number of selectable workspaces to return, from 1 to 100. When omitted, every workspace is returned and offset and query are ignored.
1646
+ * @public
1647
+ */
1648
+ limit?: number | undefined;
1649
+ /**
1650
+ * Number of selectable workspaces to skip before this page. Applied only when limit is set. Defaults to 0. An offset past the end returns an empty page.
1651
+ * @public
1652
+ */
1653
+ offset?: number | undefined;
1654
+ /**
1655
+ * Case-insensitive substring matched against the PBX domain. Applied only when limit is set. Blank values are ignored. Narrows total as well as the page.
1656
+ * @public
1657
+ */
1658
+ query?: string | undefined;
1644
1659
  }
1645
1660
  /**
1646
1661
  * @public
@@ -1652,7 +1667,7 @@ export interface Workspace {
1652
1667
  */
1653
1668
  companyId?: string | undefined;
1654
1669
  /**
1655
- * PBX information where user connected to.
1670
+ * Stored PBX link for this workspace. ListWorkspaces sets it on each returned workspace so the page includes domain and port. Omitted when the workspace has no PBX record.
1656
1671
  * @public
1657
1672
  */
1658
1673
  pbxUser?: UserPbxLinkData | undefined;
@@ -1686,7 +1701,16 @@ export interface Workspace {
1686
1701
  * @public
1687
1702
  */
1688
1703
  export interface ListWorkspacesOutput {
1704
+ /**
1705
+ * Workspaces for this request. A paged response contains only active work workspaces, ordered with the account default first, then workspaces the user linked to before (most recent first), then the rest by domain.
1706
+ * @public
1707
+ */
1689
1708
  workspaces: Workspace[];
1709
+ /**
1710
+ * Number of selectable workspaces (active and type work) that match query, ignoring offset. Present when limit is set.
1711
+ * @public
1712
+ */
1713
+ total?: number | undefined;
1690
1714
  }
1691
1715
  /**
1692
1716
  * @public
@@ -1846,6 +1870,11 @@ export declare namespace UserQuery {
1846
1870
  * @public
1847
1871
  */
1848
1872
  export interface QueryUserInput {
1873
+ /**
1874
+ * 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.
1875
+ * @public
1876
+ */
1877
+ companyId?: string | undefined;
1849
1878
  query: UserQuery;
1850
1879
  /**
1851
1880
  * 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.
@@ -1863,6 +1892,11 @@ export interface QueryUserOutput {
1863
1892
  * @public
1864
1893
  */
1865
1894
  export interface QueryUsersInput {
1895
+ /**
1896
+ * 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.
1897
+ * @public
1898
+ */
1899
+ companyId?: string | undefined;
1866
1900
  queries: UserQuery[];
1867
1901
  predicate?: UserQueryPredicate | undefined;
1868
1902
  }
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.2.0",
4
+ "version": "4.2.2",
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",