@wildix/stream-client 4.1.11 → 4.2.0

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

@@ -21,7 +21,6 @@ export * from "./GetOrCreateTelephonyChannelCommand";
 export * from "./GetOrCreateWhatsAppChannelCommand";
 export * from "./GetSmsChannelIdCommand";
 export * from "./GetTelephonyChannelIdCommand";
-export * from "./GetTokenCommand";
 export * from "./GetUploadedFileInfoCommand";
 export * from "./GetWhatsAppChannelIdCommand";
 export * from "./HardDeleteChannelCommand";
@@ -42,10 +41,12 @@ export * from "./PartialUpdateMessageCommand";
 export * from "./PinChannelCommand";
 export * from "./PinMessageCommand";
 export * from "./QueryChannelsCommand";
+export * from "./QueryUsersCommand";
 export * from "./RemoveChannelFromSectionCommand";
 export * from "./RenameSectionCommand";
 export * from "./SearchChannelsCommand";
 export * from "./SearchMessagesCommand";
+export * from "./SearchUsersCommand";
 export * from "./SendGiphyCommand";
 export * from "./SendMessageCommand";
 export * from "./SendMessageReactionCommand";

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

@@ -177,32 +177,6 @@ export declare const GroupChannelCreationEventType: {
  * @public
  */
 export type GroupChannelCreationEventType = (typeof GroupChannelCreationEventType)[keyof typeof GroupChannelCreationEventType];
-/**
- * @public
- * @enum
- */
-export declare const WilmaChatInspectOutcome: {
-    readonly DONE: "done";
-    readonly FAILED: "failed";
-    readonly STOPPED: "stopped";
-};
-/**
- * @public
- */
-export type WilmaChatInspectOutcome = (typeof WilmaChatInspectOutcome)[keyof typeof WilmaChatInspectOutcome];
-/**
- * @public
- * @enum
- */
-export declare const WilmaChatVerbosity: {
-    readonly FULL: "full";
-    readonly NONE: "none";
-    readonly SIMPLE: "simple";
-};
-/**
- * @public
- */
-export type WilmaChatVerbosity = (typeof WilmaChatVerbosity)[keyof typeof WilmaChatVerbosity];
 /**
  * @public
  * @enum
@@ -390,3 +364,33 @@ export declare const SearchSort: {
  * @public
  */
 export type SearchSort = (typeof SearchSort)[keyof typeof SearchSort];
+/**
+ * @public
+ * @enum
+ */
+export declare const UserMatchedOn: {
+    readonly EMAIL: "email";
+    readonly EXACT: "exact";
+    readonly FUZZY: "fuzzy";
+    readonly PHONE: "phone";
+    readonly PHONETIC: "phonetic";
+    readonly PREFIX: "prefix";
+};
+/**
+ * @public
+ */
+export type UserMatchedOn = (typeof UserMatchedOn)[keyof typeof UserMatchedOn];
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchUsersMode: {
+    readonly AUTO: "auto";
+    readonly EMAIL: "email";
+    readonly NAME: "name";
+    readonly PHONE: "phone";
+};
+/**
+ * @public
+ */
+export type SearchUsersMode = (typeof SearchUsersMode)[keyof typeof SearchUsersMode];

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, SectionType, WilmaChatInspectOutcome, WilmaChatVerbosity } 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, SearchUsersMode, SectionType, UserMatchedOn } from "./enums";
 /**
  * @public
  */
@@ -816,44 +816,9 @@ export interface MessageTemplateConfig {
     whatsapp?: TemplateWithParameters | undefined;
 }
 /**
- * Artifact card under a Wilma chat bubble. File bytes stay in the artifacts store; open uses artifactId.
  * @public
  */
-export interface WilmaChatArtifactCard {
-    artifactId: string;
-    title: string;
-    kind: string;
-    size: number;
-    name?: string | undefined;
-}
-/**
- * Inspect caption under a Wilma chat bubble. Tool input and output are not stored here; the client loads them with GetSessionEvents using sessionId.
- * @public
- */
-export interface WilmaChatInspect {
-    outcome: WilmaChatInspectOutcome;
-    durationMs?: number | undefined;
-    toolCount: number;
-    failedCount: number;
-}
-/**
- * Snapshot painted under a Wilma chat agent message: inspect caption and artifact cards, plus ids to open details. Not reply buttons.
- * @public
- */
-export interface WilmaChatElement {
-    sessionId: string;
-    verbosity: WilmaChatVerbosity;
-    /**
-     * Inspect caption under a Wilma chat bubble. Tool input and output are not stored here; the client loads them with GetSessionEvents using sessionId.
-     * @public
-     */
-    inspect?: WilmaChatInspect | undefined;
-    artifacts?: WilmaChatArtifactCard[] | undefined;
-}
-/**
- * @public
- */
-export type Element = Element.ActionsMember | Element.TemplateMember | Element.WilmaMember | Element.$UnknownMember;
+export type Element = Element.ActionsMember | Element.TemplateMember | Element.$UnknownMember;
 /**
  * @public
  */
@@ -861,23 +826,11 @@ export declare namespace Element {
     interface TemplateMember {
         template: MessageTemplateConfig;
         actions?: never;
-        wilma?: never;
         $unknown?: never;
     }
     interface ActionsMember {
         template?: never;
         actions: ActionElement[];
-        wilma?: never;
-        $unknown?: never;
-    }
-    /**
-     * Snapshot painted under a Wilma chat agent message: inspect caption and artifact cards, plus ids to open details. Not reply buttons.
-     * @public
-     */
-    interface WilmaMember {
-        template?: never;
-        actions?: never;
-        wilma: WilmaChatElement;
         $unknown?: never;
     }
     /**
@@ -886,7 +839,6 @@ export declare namespace Element {
     interface $UnknownMember {
         template?: never;
         actions?: never;
-        wilma?: never;
         $unknown: [string, any];
     }
     /**
@@ -896,7 +848,6 @@ export declare namespace Element {
     interface Visitor<T> {
         template: (value: MessageTemplateConfig) => T;
         actions: (value: ActionElement[]) => T;
-        wilma: (value: WilmaChatElement) => T;
         _: (name: string, value: any) => T;
     }
 }
@@ -2413,51 +2364,6 @@ export interface GetTelephonyChannelIdOutput {
      */
     channelId: string;
 }
-/**
- * @public
- */
-export interface GetTokenInput {
-    /**
-     * The unique identifier of the tenant when a service token is used.
-     * @public
-     */
-    companyId?: string | undefined;
-    /**
-     * The unique identifier of the user when a service or PBX token is used.
-     * @public
-     */
-    userId?: string | undefined;
-    /**
-     * Client id used to select and sign the correct token.
-     * @public
-     */
-    clientId?: string | undefined;
-}
-/**
- * @public
- */
-export interface GetTokenOutput {
-    /**
-     * The request ID of the request.
-     * @public
-     */
-    requestId?: string | undefined;
-    /**
-     * The duration of the request in milliseconds.
-     * @public
-     */
-    requestDuration?: number | undefined;
-    /**
-     * Authorization token.
-     * @public
-     */
-    token: string;
-    /**
-     * Token expiration time as Unix epoch seconds.
-     * @public
-     */
-    expires: number;
-}
 /**
  * @public
  */
@@ -3627,6 +3533,138 @@ export interface QueryChannelsOutput {
     requestDuration?: number | undefined;
     channels: InboxChannel[];
 }
+/**
+ * Batch user lookup. At least one of the lists must be given; the lists are alternatives, not filters, so a user that matches any of them is returned.
+ * @public
+ */
+export interface UsersQuery {
+    /**
+     * User ids.
+     * @public
+     */
+    ids?: string[] | undefined;
+    /**
+     * Email addresses.
+     * @public
+     */
+    emails?: string[] | undefined;
+    /**
+     * Phone numbers.
+     * @public
+     */
+    phones?: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface QueryUsersInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * Batch user lookup. At least one of the lists must be given; the lists are alternatives, not filters, so a user that matches any of them is returned.
+     * @public
+     */
+    query: UsersQuery;
+}
+/**
+ * A user of the directory. Every field except `id` and `bot` is present only when the directory holds it.
+ * @public
+ */
+export interface StreamUser {
+    /**
+     * User id.
+     * @public
+     */
+    id: string;
+    /**
+     * Display name.
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * Email address.
+     * @public
+     */
+    email?: string | undefined;
+    /**
+     * Phone number.
+     * @public
+     */
+    phone?: string | undefined;
+    /**
+     * Company the user belongs to.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * Picture URL.
+     * @public
+     */
+    picture?: string | undefined;
+    /**
+     * True when the user is a bot.
+     * @public
+     */
+    bot: boolean;
+    /**
+     * Extension on the PBX the user is linked to.
+     * @public
+     */
+    pbxExtension?: string | undefined;
+    /**
+     * Language of the user's client, as a locale tag.
+     * @public
+     */
+    locale?: string | undefined;
+    /**
+     * IANA time zone of the user.
+     * @public
+     */
+    timeZone?: string | undefined;
+    /**
+     * When the user was deactivated. Absent for an active user.
+     * @public
+     */
+    deactivatedAt?: string | undefined;
+    /**
+     * When the user was created.
+     * @public
+     */
+    createdAt?: string | undefined;
+    /**
+     * When the directory entry of the user was last written.
+     * @public
+     */
+    updatedAt?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface QueryUsersOutput {
+    /**
+     * The request ID of the request.
+     * @public
+     */
+    requestId?: string | undefined;
+    /**
+     * The duration of the request in milliseconds.
+     * @public
+     */
+    requestDuration?: number | undefined;
+    /**
+     * Users that matched, each one once, in no particular order.
+     * @public
+     */
+    users: StreamUser[];
+}
 /**
  * @public
  */
@@ -3909,6 +3947,106 @@ export interface SearchMessagesOutput {
      */
     nextCursor?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface SearchUserHit {
+    /**
+     * A user of the directory. Every field except `id` and `bot` is present only when the directory holds it.
+     * @public
+     */
+    user: StreamUser;
+    /**
+     * Similarity of a query to a name, from 0 (nothing in common) to 1 (the same words). Depends only on the two strings, not on the size of the company.
+     * @public
+     */
+    confidence: number;
+    /**
+     * The kind of match that carried this hit.
+     * @public
+     */
+    matchedOn: UserMatchedOn;
+}
+/**
+ * @public
+ */
+export interface SearchUsersInput {
+    /**
+     * The unique identifier of the tenant when a service token is used.
+     * @public
+     */
+    companyId?: string | undefined;
+    /**
+     * The unique identifier of the user when a service or PBX token is used.
+     * @public
+     */
+    userId?: string | undefined;
+    /**
+     * What to look for: a name as typed or as a speech recognizer heard it, an email address, or a phone number.
+     * @public
+     */
+    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.
+     * @public
+     */
+    mode?: SearchUsersMode | undefined;
+    /**
+     * Page size. Default 20, max 50.
+     * @public
+     */
+    size?: number | undefined;
+    /**
+     * Opaque continuation token from the previous response. Keep `q` and the other parameters unchanged while paging.
+     * @public
+     */
+    cursor?: string | undefined;
+    /**
+     * When true, bots are returned along with people. Default false.
+     * @public
+     */
+    includeBots?: boolean | undefined;
+    /**
+     * When true, returns only users that have an extension on a PBX, so a call can be transferred to them. Default false.
+     * @public
+     */
+    withExtensionOnly?: boolean | undefined;
+    /**
+     * Drops results whose `confidence` is below this value. The default 0.5 cuts the candidates that share little with the query; 0 returns every candidate.
+     * @public
+     */
+    minConfidence?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface SearchUsersOutput {
+    /**
+     * The request ID of the request.
+     * @public
+     */
+    requestId?: string | undefined;
+    /**
+     * The duration of the request in milliseconds.
+     * @public
+     */
+    requestDuration?: number | undefined;
+    /**
+     * Matching users ordered by descending confidence.
+     * @public
+     */
+    results: SearchUserHit[];
+    /**
+     * Cursor for the next page. Absent when there are no more pages.
+     * @public
+     */
+    nextCursor?: string | undefined;
+    /**
+     * Confidence of the first result minus that of the second in this response. Absent when fewer than two results remain. A large margin means the first result stands out; a small one means the answer is ambiguous.
+     * @public
+     */
+    margin?: number | undefined;
+}
 /**
  * @public
  */

package/dist-types/schemas/schemas_0.d.ts

@@ -81,8 +81,6 @@ export declare var GetSmsChannelIdInput$: StaticStructureSchema;
 export declare var GetSmsChannelIdOutput$: StaticStructureSchema;
 export declare var GetTelephonyChannelIdInput$: StaticStructureSchema;
 export declare var GetTelephonyChannelIdOutput$: StaticStructureSchema;
-export declare var GetTokenInput$: StaticStructureSchema;
-export declare var GetTokenOutput$: StaticStructureSchema;
 export declare var GetUploadedFileInfoInput$: StaticStructureSchema;
 export declare var GetUploadedFileInfoOutput$: StaticStructureSchema;
 export declare var GetWhatsAppChannelIdInput$: StaticStructureSchema;
@@ -140,6 +138,8 @@ export declare var PinMessageInput$: StaticStructureSchema;
 export declare var PinMessageOutput$: StaticStructureSchema;
 export declare var QueryChannelsInput$: StaticStructureSchema;
 export declare var QueryChannelsOutput$: StaticStructureSchema;
+export declare var QueryUsersInput$: StaticStructureSchema;
+export declare var QueryUsersOutput$: StaticStructureSchema;
 export declare var Reaction$: StaticStructureSchema;
 export declare var RemoveChannelFromSectionInput$: StaticStructureSchema;
 export declare var RemoveChannelFromSectionOutput$: StaticStructureSchema;
@@ -151,6 +151,9 @@ export declare var SearchChannelsOutput$: StaticStructureSchema;
 export declare var SearchMessageHit$: StaticStructureSchema;
 export declare var SearchMessagesInput$: StaticStructureSchema;
 export declare var SearchMessagesOutput$: StaticStructureSchema;
+export declare var SearchUserHit$: StaticStructureSchema;
+export declare var SearchUsersInput$: StaticStructureSchema;
+export declare var SearchUsersOutput$: StaticStructureSchema;
 export declare var Section$: StaticStructureSchema;
 export declare var SendGiphyInput$: StaticStructureSchema;
 export declare var SendGiphyOutput$: StaticStructureSchema;
@@ -166,6 +169,7 @@ export declare var SendTypingStopInput$: StaticStructureSchema;
 export declare var SendTypingStopOutput$: StaticStructureSchema;
 export declare var ShowChannelInput$: StaticStructureSchema;
 export declare var ShowChannelOutput$: StaticStructureSchema;
+export declare var StreamUser$: StaticStructureSchema;
 export declare var UnmuteChannelInput$: StaticStructureSchema;
 export declare var UnmuteChannelOutput$: StaticStructureSchema;
 export declare var UnpinChannelInput$: StaticStructureSchema;
@@ -180,12 +184,10 @@ export declare var UploadedFileInfo$: StaticStructureSchema;
 export declare var UploadFileInput$: StaticStructureSchema;
 export declare var UploadFileOptions$: StaticStructureSchema;
 export declare var UploadFileOutput$: StaticStructureSchema;
+export declare var UsersQuery$: StaticStructureSchema;
 export declare var UserToInvite$: StaticStructureSchema;
 export declare var WelcomeMessage$: StaticStructureSchema;
 export declare var WhatsAppClosedSystemMessage$: StaticStructureSchema;
-export declare var WilmaChatArtifactCard$: StaticStructureSchema;
-export declare var WilmaChatElement$: StaticStructureSchema;
-export declare var WilmaChatInspect$: StaticStructureSchema;
 export declare var ActionElement$: StaticUnionSchema;
 export declare var AssignChannelAssigneeRequest$: StaticUnionSchema;
 export declare var AssignChannelServiceRequest$: StaticUnionSchema;
@@ -215,7 +217,6 @@ export declare var GetOrCreateTelephonyChannel$: StaticOperationSchema;
 export declare var GetOrCreateWhatsAppChannel$: StaticOperationSchema;
 export declare var GetSmsChannelId$: StaticOperationSchema;
 export declare var GetTelephonyChannelId$: StaticOperationSchema;
-export declare var GetToken$: StaticOperationSchema;
 export declare var GetUploadedFileInfo$: StaticOperationSchema;
 export declare var GetWhatsAppChannelId$: StaticOperationSchema;
 export declare var HardDeleteChannel$: StaticOperationSchema;
@@ -236,10 +237,12 @@ export declare var PartialUpdateMessage$: StaticOperationSchema;
 export declare var PinChannel$: StaticOperationSchema;
 export declare var PinMessage$: StaticOperationSchema;
 export declare var QueryChannels$: StaticOperationSchema;
+export declare var QueryUsers$: StaticOperationSchema;
 export declare var RemoveChannelFromSection$: StaticOperationSchema;
 export declare var RenameSection$: StaticOperationSchema;
 export declare var SearchChannels$: StaticOperationSchema;
 export declare var SearchMessages$: StaticOperationSchema;
+export declare var SearchUsers$: StaticOperationSchema;
 export declare var SendGiphy$: StaticOperationSchema;
 export declare var SendMessage$: StaticOperationSchema;
 export declare var SendMessageReaction$: StaticOperationSchema;

package/package.json

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

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

@@ -1,89 +0,0 @@
-import { Command as $Command } from "@smithy/core/client";
-import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import type { GetTokenInput, GetTokenOutput } from "../models/models_0";
-import type { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
-/**
- * @public
- */
-export type { __MetadataBearer };
-export { $Command };
-/**
- * @public
- *
- * The input for {@link GetTokenCommand}.
- */
-export interface GetTokenCommandInput extends GetTokenInput {
-}
-/**
- * @public
- *
- * The output of {@link GetTokenCommand}.
- */
-export interface GetTokenCommandOutput extends GetTokenOutput, __MetadataBearer {
-}
-declare const GetTokenCommand_base: {
-    new (input: GetTokenCommandInput): import("@smithy/core/client").CommandImpl<GetTokenCommandInput, GetTokenCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (...[input]: [] | [GetTokenCommandInput]): import("@smithy/core/client").CommandImpl<GetTokenCommandInput, GetTokenCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
-};
-/**
- * Returns a short-lived authorization token for the stream chat client.
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { StreamServiceClient, GetTokenCommand } from "@wildix/stream-client"; // ES Modules import
- * // const { StreamServiceClient, GetTokenCommand } = require("@wildix/stream-client"); // CommonJS import
- * // import type { StreamServiceClientConfig } from "@wildix/stream-client";
- * const config = {}; // type is StreamServiceClientConfig
- * const client = new StreamServiceClient(config);
- * const input = { // GetTokenInput
- *   companyId: "STRING_VALUE",
- *   userId: "STRING_VALUE",
- *   clientId: "STRING_VALUE",
- * };
- * const command = new GetTokenCommand(input);
- * const response = await client.send(command);
- * // { // GetTokenOutput
- * //   requestId: "STRING_VALUE",
- * //   requestDuration: Number("int"),
- * //   token: "STRING_VALUE", // required
- * //   expires: Number("long"), // required
- * // };
- *
- * ```
- *
- * @param GetTokenCommandInput - {@link GetTokenCommandInput}
- * @returns {@link GetTokenCommandOutput}
- * @see {@link GetTokenCommandInput} for command's `input` shape.
- * @see {@link GetTokenCommandOutput} for command's `response` shape.
- * @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
- *
- * @throws {@link StreamServiceException} (server fault)
- *
- * @throws {@link UnauthorizedException} (client fault)
- *
- * @throws {@link ForbiddenException} (client fault)
- *
- * @throws {@link ValidationException} (client fault)
- *
- * @throws {@link RateLimitExceededException} (client fault)
- *
- * @throws {@link StreamServiceServiceException}
- * <p>Base exception class for all service exceptions from StreamService service.</p>
- *
- *
- * @public
- */
-export declare class GetTokenCommand extends GetTokenCommand_base {
-    /** @internal type navigation helper, not in runtime. */
-    protected static __types: {
-        api: {
-            input: GetTokenInput;
-            output: GetTokenOutput;
-        };
-        sdk: {
-            input: GetTokenCommandInput;
-            output: GetTokenCommandOutput;
-        };
-    };
-}