@wildix/stream-client 4.2.3 → 4.3.0

package/dist-cjs/models/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchUsersMode = exports.UserMatchedOn = exports.SearchSort = exports.MessageUnsetFields = exports.MessageAnchor = exports.MentionsFilter = exports.GroupChannelUnsetOptions = exports.FileCategory = exports.DownloadStrategy = exports.SectionType = exports.TargetNotEligibleReason = exports.MessageWhatsAppStatus = exports.MessageSmsStatus = exports.MessageMessagingStatus = exports.GroupChannelCreationEventType = exports.ChannelsFilter = exports.ChannelWhatsAppStatus = exports.ChannelMessagingStatus = exports.MessagingChannel = exports.MessageType = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.AttachmentType = exports.AssignChannelVariant = exports.ChannelMemberRole = exports.ButtonVariant = void 0;
+exports.SearchUsersMode = exports.SearchUsersKind = exports.UserMatchedOn = exports.SearchSort = exports.MessageUnsetFields = exports.MessageAnchor = exports.MentionsFilter = exports.GroupChannelUnsetOptions = exports.FileCategory = exports.DownloadStrategy = exports.SectionType = exports.TargetNotEligibleReason = exports.MessageWhatsAppStatus = exports.MessageSmsStatus = exports.MessageMessagingStatus = exports.GroupChannelCreationEventType = exports.ChannelsFilter = exports.ChannelWhatsAppStatus = exports.ChannelMessagingStatus = exports.MessagingChannel = exports.MessageType = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.AttachmentType = exports.AssignChannelVariant = exports.ChannelMemberRole = exports.ButtonVariant = void 0;
 exports.ButtonVariant = {
     CONTAINED: "contained",
     OUTLINED: "outlined",
@@ -149,6 +149,11 @@ exports.UserMatchedOn = {
     PHONETIC: "phonetic",
     PREFIX: "prefix",
 };
+exports.SearchUsersKind = {
+    ALL: "all",
+    BOT: "bot",
+    HUMAN: "human",
+};
 exports.SearchUsersMode = {
     AUTO: "auto",
     EMAIL: "email",

package/dist-cjs/schemas/schemas_0.js

@@ -348,7 +348,6 @@ const _hi = "hidden";
 const _hig = "highlights";
 const _ht = "http";
 const _i = "id";
-const _iB = "includeBots";
 const _iM = "initialMessage";
 const _id = "ids";
 const _in = "inbox";
@@ -359,6 +358,7 @@ const _kDS = "kiteDefaultSubject";
 const _kSN = "kiteServiceName";
 const _kT = "kiteTarget";
 const _kV = "kiteVariant";
+const _ki = "kind";
 const _l = "limit";
 const _lAA = "lastActivityAt";
 const _lM = "lastMessage";
@@ -1260,8 +1260,8 @@ exports.SearchUserHit$ = [3, n1, _SUH,
 ];
 exports.SearchUsersInput$ = [3, n1, _SUI,
     0,
-    [_q_, _cIo, _uI, _mo, _siz, _cu, _iB, _wEO, _mCi],
-    [[0, { [_hQ]: _q_ }], [0, { [_hQ]: _co }], [0, { [_hQ]: _uI }], [0, { [_hQ]: _mo }], [1, { [_hQ]: _siz }], [0, { [_hQ]: _cu }], [2, { [_hQ]: _iB }], [2, { [_hQ]: _wEO }], [1, { [_hQ]: _mCi }]], 1
+    [_q_, _cIo, _uI, _mo, _siz, _cu, _ki, _wEO, _mCi],
+    [[0, { [_hQ]: _q_ }], [0, { [_hQ]: _co }], [0, { [_hQ]: _uI }], [0, { [_hQ]: _mo }], [1, { [_hQ]: _siz }], [0, { [_hQ]: _cu }], [0, { [_hQ]: _ki }], [2, { [_hQ]: _wEO }], [1, { [_hQ]: _mCi }]], 1
 ];
 exports.SearchUsersOutput$ = [3, n1, _SUO,
     0,

package/dist-es/models/enums.js

@@ -146,6 +146,11 @@ export const UserMatchedOn = {
     PHONETIC: "phonetic",
     PREFIX: "prefix",
 };
+export const SearchUsersKind = {
+    ALL: "all",
+    BOT: "bot",
+    HUMAN: "human",
+};
 export const SearchUsersMode = {
     AUTO: "auto",
     EMAIL: "email",

package/dist-es/schemas/schemas_0.js

@@ -340,7 +340,6 @@ const _hi = "hidden";
 const _hig = "highlights";
 const _ht = "http";
 const _i = "id";
-const _iB = "includeBots";
 const _iM = "initialMessage";
 const _id = "ids";
 const _in = "inbox";
@@ -351,6 +350,7 @@ const _kDS = "kiteDefaultSubject";
 const _kSN = "kiteServiceName";
 const _kT = "kiteTarget";
 const _kV = "kiteVariant";
+const _ki = "kind";
 const _l = "limit";
 const _lAA = "lastActivityAt";
 const _lM = "lastMessage";
@@ -1252,8 +1252,8 @@ export var SearchUserHit$ = [3, n1, _SUH,
 ];
 export var SearchUsersInput$ = [3, n1, _SUI,
     0,
-    [_q_, _cIo, _uI, _mo, _siz, _cu, _iB, _wEO, _mCi],
-    [[0, { [_hQ]: _q_ }], [0, { [_hQ]: _co }], [0, { [_hQ]: _uI }], [0, { [_hQ]: _mo }], [1, { [_hQ]: _siz }], [0, { [_hQ]: _cu }], [2, { [_hQ]: _iB }], [2, { [_hQ]: _wEO }], [1, { [_hQ]: _mCi }]], 1
+    [_q_, _cIo, _uI, _mo, _siz, _cu, _ki, _wEO, _mCi],
+    [[0, { [_hQ]: _q_ }], [0, { [_hQ]: _co }], [0, { [_hQ]: _uI }], [0, { [_hQ]: _mo }], [1, { [_hQ]: _siz }], [0, { [_hQ]: _cu }], [0, { [_hQ]: _ki }], [2, { [_hQ]: _wEO }], [1, { [_hQ]: _mCi }]], 1
 ];
 export var SearchUsersOutput$ = [3, n1, _SUO,
     0,

package/dist-types/commands/SearchUsersCommand.d.ts

@@ -43,7 +43,7 @@ declare const SearchUsersCommand_base: {
  *   mode: "auto" || "name" || "email" || "phone",
  *   size: Number("int"),
  *   cursor: "STRING_VALUE",
- *   includeBots: true || false,
+ *   kind: "human" || "bot" || "all",
  *   withExtensionOnly: true || false,
  *   minConfidence: Number("double"),
  * };

package/dist-types/models/enums.d.ts

@@ -380,6 +380,19 @@ export declare const UserMatchedOn: {
  * @public
  */
 export type UserMatchedOn = (typeof UserMatchedOn)[keyof typeof UserMatchedOn];
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchUsersKind: {
+    readonly ALL: "all";
+    readonly BOT: "bot";
+    readonly HUMAN: "human";
+};
+/**
+ * @public
+ */
+export type SearchUsersKind = (typeof SearchUsersKind)[keyof typeof SearchUsersKind];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, SearchSort, SearchUsersMode, SectionType, UserMatchedOn } from "./enums";
+import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, SearchSort, SearchUsersKind, SearchUsersMode, SectionType, UserMatchedOn } from "./enums";
 /**
  * @public
  */
@@ -3992,7 +3992,7 @@ export interface SearchUsersInput {
      */
     q: string;
     /**
-     * How `q` is read. `auto` (default) takes `q` for an email address when it contains `@`, for a phone number when it holds only digits, spaces and `+-()` with at least four digits, and for a name otherwise. `name`, `email` and `phone` force the reading. An email or phone lookup is exact and gives every result a `confidence` of 1. `includeBots`, `withExtensionOnly` and `minConfidence` apply in every mode.
+     * How `q` is read. `auto` (default) takes `q` for an email address when it contains `@` (looked up exactly, so a malformed one matches nobody), for a phone number when it is a number with its country code (`+` and digits, grouped by spaces, `-`, `.`, `/` or brackets as written), and for a name otherwise. A number of seven or more digits without its country code is refused with a `ValidationException`: numbers are stored in E.164, so it would match nobody. `name`, `email` and `phone` force the reading and refuse input that cannot be it. An email or phone lookup is exact and gives every result a `confidence` of 1. `kind`, `withExtensionOnly` and `minConfidence` apply in every mode.
      * @public
      */
     mode?: SearchUsersMode | undefined;
@@ -4007,10 +4007,10 @@ export interface SearchUsersInput {
      */
     cursor?: string | undefined;
     /**
-     * When true, bots are returned along with people. Default false.
+     * Which users are searched: `human` (default) people only, `bot` bots only, `all` both.
      * @public
      */
-    includeBots?: boolean | undefined;
+    kind?: SearchUsersKind | undefined;
     /**
      * When true, returns only users that have an extension on a PBX, so a call can be transferred to them. Default false.
      * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/stream-client",
     "description": "@wildix/stream-client client",
-    "version": "4.2.3",
+    "version": "4.3.0",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",