@wildix/stream-client 4.1.11 → 4.2.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/StreamService.js +4 -2
- package/dist-cjs/commands/{GetTokenCommand.js → QueryUsersCommand.js} +6 -6
- package/dist-cjs/commands/SearchUsersCommand.js +20 -0
- package/dist-cjs/commands/index.js +2 -1
- package/dist-cjs/models/enums.js +15 -11
- package/dist-cjs/schemas/schemas_0.js +87 -62
- package/dist-es/StreamService.js +4 -2
- package/dist-es/commands/{GetTokenCommand.js → QueryUsersCommand.js} +5 -5
- package/dist-es/commands/SearchUsersCommand.js +16 -0
- package/dist-es/commands/index.js +2 -1
- package/dist-es/models/enums.js +14 -10
- package/dist-es/schemas/schemas_0.js +82 -58
- package/dist-types/StreamService.d.ts +14 -8
- package/dist-types/StreamServiceClient.d.ts +4 -3
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +0 -38
- package/dist-types/commands/DeleteMessageReactionCommand.d.ts +0 -19
- package/dist-types/commands/GetMessageCommand.d.ts +0 -19
- package/dist-types/commands/ListMentionsCommand.d.ts +0 -19
- package/dist-types/commands/ListMessagesCommand.d.ts +0 -19
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +0 -38
- package/dist-types/commands/PinMessageCommand.d.ts +0 -19
- package/dist-types/commands/QueryUsersCommand.d.ts +114 -0
- package/dist-types/commands/SearchMessagesCommand.d.ts +0 -19
- package/dist-types/commands/SearchUsersCommand.d.ts +116 -0
- package/dist-types/commands/SendGiphyCommand.d.ts +0 -19
- package/dist-types/commands/SendMessageCommand.d.ts +0 -38
- package/dist-types/commands/SendMessageReactionCommand.d.ts +0 -19
- package/dist-types/commands/SendSystemMessageCommand.d.ts +0 -19
- package/dist-types/commands/UnpinMessageCommand.d.ts +0 -19
- package/dist-types/commands/UpdateMessageCommand.d.ts +0 -38
- package/dist-types/commands/index.d.ts +2 -1
- package/dist-types/models/enums.d.ts +30 -26
- package/dist-types/models/models_0.d.ts +234 -96
- package/dist-types/schemas/schemas_0.d.ts +9 -6
- package/package.json +1 -1
- package/dist-types/commands/GetTokenCommand.d.ts +0 -89
|
@@ -134,25 +134,6 @@ declare const DeleteMessageReactionCommand_base: {
|
|
|
134
134
|
* // },
|
|
135
135
|
* // },
|
|
136
136
|
* // ],
|
|
137
|
-
* // wilma: { // WilmaChatElement
|
|
138
|
-
* // sessionId: "STRING_VALUE", // required
|
|
139
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
140
|
-
* // inspect: { // WilmaChatInspect
|
|
141
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
142
|
-
* // durationMs: Number("int"),
|
|
143
|
-
* // toolCount: Number("int"), // required
|
|
144
|
-
* // failedCount: Number("int"), // required
|
|
145
|
-
* // },
|
|
146
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
147
|
-
* // { // WilmaChatArtifactCard
|
|
148
|
-
* // artifactId: "STRING_VALUE", // required
|
|
149
|
-
* // title: "STRING_VALUE", // required
|
|
150
|
-
* // kind: "STRING_VALUE", // required
|
|
151
|
-
* // size: Number("long"), // required
|
|
152
|
-
* // name: "STRING_VALUE",
|
|
153
|
-
* // },
|
|
154
|
-
* // ],
|
|
155
|
-
* // },
|
|
156
137
|
* // },
|
|
157
138
|
* // ],
|
|
158
139
|
* // whatsapp: true || false,
|
|
@@ -135,25 +135,6 @@ declare const GetMessageCommand_base: {
|
|
|
135
135
|
* // },
|
|
136
136
|
* // },
|
|
137
137
|
* // ],
|
|
138
|
-
* // wilma: { // WilmaChatElement
|
|
139
|
-
* // sessionId: "STRING_VALUE", // required
|
|
140
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
141
|
-
* // inspect: { // WilmaChatInspect
|
|
142
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
143
|
-
* // durationMs: Number("int"),
|
|
144
|
-
* // toolCount: Number("int"), // required
|
|
145
|
-
* // failedCount: Number("int"), // required
|
|
146
|
-
* // },
|
|
147
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
148
|
-
* // { // WilmaChatArtifactCard
|
|
149
|
-
* // artifactId: "STRING_VALUE", // required
|
|
150
|
-
* // title: "STRING_VALUE", // required
|
|
151
|
-
* // kind: "STRING_VALUE", // required
|
|
152
|
-
* // size: Number("long"), // required
|
|
153
|
-
* // name: "STRING_VALUE",
|
|
154
|
-
* // },
|
|
155
|
-
* // ],
|
|
156
|
-
* // },
|
|
157
138
|
* // },
|
|
158
139
|
* // ],
|
|
159
140
|
* // whatsapp: true || false,
|
|
@@ -144,25 +144,6 @@ declare const ListMentionsCommand_base: {
|
|
|
144
144
|
* // },
|
|
145
145
|
* // },
|
|
146
146
|
* // ],
|
|
147
|
-
* // wilma: { // WilmaChatElement
|
|
148
|
-
* // sessionId: "STRING_VALUE", // required
|
|
149
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
150
|
-
* // inspect: { // WilmaChatInspect
|
|
151
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
152
|
-
* // durationMs: Number("int"),
|
|
153
|
-
* // toolCount: Number("int"), // required
|
|
154
|
-
* // failedCount: Number("int"), // required
|
|
155
|
-
* // },
|
|
156
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
157
|
-
* // { // WilmaChatArtifactCard
|
|
158
|
-
* // artifactId: "STRING_VALUE", // required
|
|
159
|
-
* // title: "STRING_VALUE", // required
|
|
160
|
-
* // kind: "STRING_VALUE", // required
|
|
161
|
-
* // size: Number("long"), // required
|
|
162
|
-
* // name: "STRING_VALUE",
|
|
163
|
-
* // },
|
|
164
|
-
* // ],
|
|
165
|
-
* // },
|
|
166
147
|
* // },
|
|
167
148
|
* // ],
|
|
168
149
|
* // whatsapp: true || false,
|
|
@@ -138,25 +138,6 @@ declare const ListMessagesCommand_base: {
|
|
|
138
138
|
* // },
|
|
139
139
|
* // },
|
|
140
140
|
* // ],
|
|
141
|
-
* // wilma: { // WilmaChatElement
|
|
142
|
-
* // sessionId: "STRING_VALUE", // required
|
|
143
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
144
|
-
* // inspect: { // WilmaChatInspect
|
|
145
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
146
|
-
* // durationMs: Number("int"),
|
|
147
|
-
* // toolCount: Number("int"), // required
|
|
148
|
-
* // failedCount: Number("int"), // required
|
|
149
|
-
* // },
|
|
150
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
151
|
-
* // { // WilmaChatArtifactCard
|
|
152
|
-
* // artifactId: "STRING_VALUE", // required
|
|
153
|
-
* // title: "STRING_VALUE", // required
|
|
154
|
-
* // kind: "STRING_VALUE", // required
|
|
155
|
-
* // size: Number("long"), // required
|
|
156
|
-
* // name: "STRING_VALUE",
|
|
157
|
-
* // },
|
|
158
|
-
* // ],
|
|
159
|
-
* // },
|
|
160
141
|
* // },
|
|
161
142
|
* // ],
|
|
162
143
|
* // whatsapp: true || false,
|
|
@@ -76,25 +76,6 @@ declare const PartialUpdateMessageCommand_base: {
|
|
|
76
76
|
* },
|
|
77
77
|
* },
|
|
78
78
|
* ],
|
|
79
|
-
* wilma: { // WilmaChatElement
|
|
80
|
-
* sessionId: "STRING_VALUE", // required
|
|
81
|
-
* verbosity: "none" || "simple" || "full", // required
|
|
82
|
-
* inspect: { // WilmaChatInspect
|
|
83
|
-
* outcome: "done" || "stopped" || "failed", // required
|
|
84
|
-
* durationMs: Number("int"),
|
|
85
|
-
* toolCount: Number("int"), // required
|
|
86
|
-
* failedCount: Number("int"), // required
|
|
87
|
-
* },
|
|
88
|
-
* artifacts: [ // WilmaChatArtifactCardList
|
|
89
|
-
* { // WilmaChatArtifactCard
|
|
90
|
-
* artifactId: "STRING_VALUE", // required
|
|
91
|
-
* title: "STRING_VALUE", // required
|
|
92
|
-
* kind: "STRING_VALUE", // required
|
|
93
|
-
* size: Number("long"), // required
|
|
94
|
-
* name: "STRING_VALUE",
|
|
95
|
-
* },
|
|
96
|
-
* ],
|
|
97
|
-
* },
|
|
98
79
|
* },
|
|
99
80
|
* ],
|
|
100
81
|
* attachments: [ // MessageAttachmentRequestList
|
|
@@ -223,25 +204,6 @@ declare const PartialUpdateMessageCommand_base: {
|
|
|
223
204
|
* // },
|
|
224
205
|
* // },
|
|
225
206
|
* // ],
|
|
226
|
-
* // wilma: { // WilmaChatElement
|
|
227
|
-
* // sessionId: "STRING_VALUE", // required
|
|
228
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
229
|
-
* // inspect: { // WilmaChatInspect
|
|
230
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
231
|
-
* // durationMs: Number("int"),
|
|
232
|
-
* // toolCount: Number("int"), // required
|
|
233
|
-
* // failedCount: Number("int"), // required
|
|
234
|
-
* // },
|
|
235
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
236
|
-
* // { // WilmaChatArtifactCard
|
|
237
|
-
* // artifactId: "STRING_VALUE", // required
|
|
238
|
-
* // title: "STRING_VALUE", // required
|
|
239
|
-
* // kind: "STRING_VALUE", // required
|
|
240
|
-
* // size: Number("long"), // required
|
|
241
|
-
* // name: "STRING_VALUE",
|
|
242
|
-
* // },
|
|
243
|
-
* // ],
|
|
244
|
-
* // },
|
|
245
207
|
* // },
|
|
246
208
|
* // ],
|
|
247
209
|
* // whatsapp: true || false,
|
|
@@ -133,25 +133,6 @@ declare const PinMessageCommand_base: {
|
|
|
133
133
|
* // },
|
|
134
134
|
* // },
|
|
135
135
|
* // ],
|
|
136
|
-
* // wilma: { // WilmaChatElement
|
|
137
|
-
* // sessionId: "STRING_VALUE", // required
|
|
138
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
139
|
-
* // inspect: { // WilmaChatInspect
|
|
140
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
141
|
-
* // durationMs: Number("int"),
|
|
142
|
-
* // toolCount: Number("int"), // required
|
|
143
|
-
* // failedCount: Number("int"), // required
|
|
144
|
-
* // },
|
|
145
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
146
|
-
* // { // WilmaChatArtifactCard
|
|
147
|
-
* // artifactId: "STRING_VALUE", // required
|
|
148
|
-
* // title: "STRING_VALUE", // required
|
|
149
|
-
* // kind: "STRING_VALUE", // required
|
|
150
|
-
* // size: Number("long"), // required
|
|
151
|
-
* // name: "STRING_VALUE",
|
|
152
|
-
* // },
|
|
153
|
-
* // ],
|
|
154
|
-
* // },
|
|
155
136
|
* // },
|
|
156
137
|
* // ],
|
|
157
138
|
* // whatsapp: true || false,
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { QueryUsersInput, QueryUsersOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link QueryUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface QueryUsersCommandInput extends QueryUsersInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link QueryUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface QueryUsersCommandOutput extends QueryUsersOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const QueryUsersCommand_base: {
|
|
25
|
+
new (input: QueryUsersCommandInput): import("@smithy/core/client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: QueryUsersCommandInput): import("@smithy/core/client").CommandImpl<QueryUsersCommandInput, QueryUsersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Returns the users that match a batch query by ids, emails and phones. Only users that exist and are visible in the caller's scope are returned, each one once; an email or phone that several users share returns all of them. A service token without a company reads the whole directory; any other token is limited to its own company.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, QueryUsersCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, QueryUsersCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* // import type { StreamServiceClientConfig } from "@wildix/stream-client";
|
|
37
|
+
* const config = {}; // type is StreamServiceClientConfig
|
|
38
|
+
* const client = new StreamServiceClient(config);
|
|
39
|
+
* const input = { // QueryUsersInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* userId: "STRING_VALUE",
|
|
42
|
+
* query: { // UsersQuery
|
|
43
|
+
* ids: [ // QueryUserIdList
|
|
44
|
+
* "STRING_VALUE",
|
|
45
|
+
* ],
|
|
46
|
+
* emails: [ // UserEmailList
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* phones: [ // UserPhoneList
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* },
|
|
53
|
+
* };
|
|
54
|
+
* const command = new QueryUsersCommand(input);
|
|
55
|
+
* const response = await client.send(command);
|
|
56
|
+
* // { // QueryUsersOutput
|
|
57
|
+
* // requestId: "STRING_VALUE",
|
|
58
|
+
* // requestDuration: Number("int"),
|
|
59
|
+
* // users: [ // StreamUserList // required
|
|
60
|
+
* // { // StreamUser
|
|
61
|
+
* // id: "STRING_VALUE", // required
|
|
62
|
+
* // name: "STRING_VALUE",
|
|
63
|
+
* // email: "STRING_VALUE",
|
|
64
|
+
* // phone: "STRING_VALUE",
|
|
65
|
+
* // companyId: "STRING_VALUE",
|
|
66
|
+
* // picture: "STRING_VALUE",
|
|
67
|
+
* // bot: true || false, // required
|
|
68
|
+
* // pbxExtension: "STRING_VALUE",
|
|
69
|
+
* // locale: "STRING_VALUE",
|
|
70
|
+
* // timeZone: "STRING_VALUE",
|
|
71
|
+
* // deactivatedAt: "STRING_VALUE",
|
|
72
|
+
* // createdAt: "STRING_VALUE",
|
|
73
|
+
* // updatedAt: "STRING_VALUE",
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // };
|
|
77
|
+
*
|
|
78
|
+
* ```
|
|
79
|
+
*
|
|
80
|
+
* @param QueryUsersCommandInput - {@link QueryUsersCommandInput}
|
|
81
|
+
* @returns {@link QueryUsersCommandOutput}
|
|
82
|
+
* @see {@link QueryUsersCommandInput} for command's `input` shape.
|
|
83
|
+
* @see {@link QueryUsersCommandOutput} for command's `response` shape.
|
|
84
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ValidationException} (client fault)
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link StreamServiceServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
98
|
+
*
|
|
99
|
+
*
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
export declare class QueryUsersCommand extends QueryUsersCommand_base {
|
|
103
|
+
/** @internal type navigation helper, not in runtime. */
|
|
104
|
+
protected static __types: {
|
|
105
|
+
api: {
|
|
106
|
+
input: QueryUsersInput;
|
|
107
|
+
output: QueryUsersOutput;
|
|
108
|
+
};
|
|
109
|
+
sdk: {
|
|
110
|
+
input: QueryUsersCommandInput;
|
|
111
|
+
output: QueryUsersCommandOutput;
|
|
112
|
+
};
|
|
113
|
+
};
|
|
114
|
+
}
|
|
@@ -152,25 +152,6 @@ declare const SearchMessagesCommand_base: {
|
|
|
152
152
|
* // },
|
|
153
153
|
* // },
|
|
154
154
|
* // ],
|
|
155
|
-
* // wilma: { // WilmaChatElement
|
|
156
|
-
* // sessionId: "STRING_VALUE", // required
|
|
157
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
158
|
-
* // inspect: { // WilmaChatInspect
|
|
159
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
160
|
-
* // durationMs: Number("int"),
|
|
161
|
-
* // toolCount: Number("int"), // required
|
|
162
|
-
* // failedCount: Number("int"), // required
|
|
163
|
-
* // },
|
|
164
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
165
|
-
* // { // WilmaChatArtifactCard
|
|
166
|
-
* // artifactId: "STRING_VALUE", // required
|
|
167
|
-
* // title: "STRING_VALUE", // required
|
|
168
|
-
* // kind: "STRING_VALUE", // required
|
|
169
|
-
* // size: Number("long"), // required
|
|
170
|
-
* // name: "STRING_VALUE",
|
|
171
|
-
* // },
|
|
172
|
-
* // ],
|
|
173
|
-
* // },
|
|
174
155
|
* // },
|
|
175
156
|
* // ],
|
|
176
157
|
* // whatsapp: true || false,
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { SearchUsersInput, SearchUsersOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SearchUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchUsersCommandInput extends SearchUsersInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchUsersCommandOutput extends SearchUsersOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchUsersCommand_base: {
|
|
25
|
+
new (input: SearchUsersCommandInput): import("@smithy/core/client").CommandImpl<SearchUsersCommandInput, SearchUsersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SearchUsersCommandInput): import("@smithy/core/client").CommandImpl<SearchUsersCommandInput, SearchUsersCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Search over the directory of users by name, email address or phone number. By name it is fuzzy: any word of the name, typos, similar sounding names and any script (a Cyrillic name finds its Latin spelling and the reverse). An email address or a phone number is looked up exactly. Each result carries a `confidence`, the similarity of the query to the name computed from the strings alone; it is a measure of likeness, not the probability that this is the right person. A service token without a company searches the whole directory; any other token is limited to its own company, and naming another company is rejected.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, SearchUsersCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, SearchUsersCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* // import type { StreamServiceClientConfig } from "@wildix/stream-client";
|
|
37
|
+
* const config = {}; // type is StreamServiceClientConfig
|
|
38
|
+
* const client = new StreamServiceClient(config);
|
|
39
|
+
* const input = { // SearchUsersInput
|
|
40
|
+
* companyId: "STRING_VALUE",
|
|
41
|
+
* userId: "STRING_VALUE",
|
|
42
|
+
* q: "STRING_VALUE", // required
|
|
43
|
+
* mode: "auto" || "name" || "email" || "phone",
|
|
44
|
+
* size: Number("int"),
|
|
45
|
+
* cursor: "STRING_VALUE",
|
|
46
|
+
* includeBots: true || false,
|
|
47
|
+
* withExtensionOnly: true || false,
|
|
48
|
+
* minConfidence: Number("double"),
|
|
49
|
+
* };
|
|
50
|
+
* const command = new SearchUsersCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // SearchUsersOutput
|
|
53
|
+
* // requestId: "STRING_VALUE",
|
|
54
|
+
* // requestDuration: Number("int"),
|
|
55
|
+
* // results: [ // SearchUserHitList // required
|
|
56
|
+
* // { // SearchUserHit
|
|
57
|
+
* // user: { // StreamUser
|
|
58
|
+
* // id: "STRING_VALUE", // required
|
|
59
|
+
* // name: "STRING_VALUE",
|
|
60
|
+
* // email: "STRING_VALUE",
|
|
61
|
+
* // phone: "STRING_VALUE",
|
|
62
|
+
* // companyId: "STRING_VALUE",
|
|
63
|
+
* // picture: "STRING_VALUE",
|
|
64
|
+
* // bot: true || false, // required
|
|
65
|
+
* // pbxExtension: "STRING_VALUE",
|
|
66
|
+
* // locale: "STRING_VALUE",
|
|
67
|
+
* // timeZone: "STRING_VALUE",
|
|
68
|
+
* // deactivatedAt: "STRING_VALUE",
|
|
69
|
+
* // createdAt: "STRING_VALUE",
|
|
70
|
+
* // updatedAt: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // confidence: Number("double"), // required
|
|
73
|
+
* // matchedOn: "exact" || "phonetic" || "prefix" || "fuzzy" || "email" || "phone", // required
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // nextCursor: "STRING_VALUE",
|
|
77
|
+
* // margin: Number("double"),
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
80
|
+
* ```
|
|
81
|
+
*
|
|
82
|
+
* @param SearchUsersCommandInput - {@link SearchUsersCommandInput}
|
|
83
|
+
* @returns {@link SearchUsersCommandOutput}
|
|
84
|
+
* @see {@link SearchUsersCommandInput} for command's `input` shape.
|
|
85
|
+
* @see {@link SearchUsersCommandOutput} for command's `response` shape.
|
|
86
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ValidationException} (client fault)
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link StreamServiceServiceException}
|
|
99
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
100
|
+
*
|
|
101
|
+
*
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
export declare class SearchUsersCommand extends SearchUsersCommand_base {
|
|
105
|
+
/** @internal type navigation helper, not in runtime. */
|
|
106
|
+
protected static __types: {
|
|
107
|
+
api: {
|
|
108
|
+
input: SearchUsersInput;
|
|
109
|
+
output: SearchUsersOutput;
|
|
110
|
+
};
|
|
111
|
+
sdk: {
|
|
112
|
+
input: SearchUsersCommandInput;
|
|
113
|
+
output: SearchUsersCommandOutput;
|
|
114
|
+
};
|
|
115
|
+
};
|
|
116
|
+
}
|
|
@@ -148,25 +148,6 @@ declare const SendGiphyCommand_base: {
|
|
|
148
148
|
* // },
|
|
149
149
|
* // },
|
|
150
150
|
* // ],
|
|
151
|
-
* // wilma: { // WilmaChatElement
|
|
152
|
-
* // sessionId: "STRING_VALUE", // required
|
|
153
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
154
|
-
* // inspect: { // WilmaChatInspect
|
|
155
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
156
|
-
* // durationMs: Number("int"),
|
|
157
|
-
* // toolCount: Number("int"), // required
|
|
158
|
-
* // failedCount: Number("int"), // required
|
|
159
|
-
* // },
|
|
160
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
161
|
-
* // { // WilmaChatArtifactCard
|
|
162
|
-
* // artifactId: "STRING_VALUE", // required
|
|
163
|
-
* // title: "STRING_VALUE", // required
|
|
164
|
-
* // kind: "STRING_VALUE", // required
|
|
165
|
-
* // size: Number("long"), // required
|
|
166
|
-
* // name: "STRING_VALUE",
|
|
167
|
-
* // },
|
|
168
|
-
* // ],
|
|
169
|
-
* // },
|
|
170
151
|
* // },
|
|
171
152
|
* // ],
|
|
172
153
|
* // whatsapp: true || false,
|
|
@@ -73,25 +73,6 @@ declare const SendMessageCommand_base: {
|
|
|
73
73
|
* },
|
|
74
74
|
* },
|
|
75
75
|
* ],
|
|
76
|
-
* wilma: { // WilmaChatElement
|
|
77
|
-
* sessionId: "STRING_VALUE", // required
|
|
78
|
-
* verbosity: "none" || "simple" || "full", // required
|
|
79
|
-
* inspect: { // WilmaChatInspect
|
|
80
|
-
* outcome: "done" || "stopped" || "failed", // required
|
|
81
|
-
* durationMs: Number("int"),
|
|
82
|
-
* toolCount: Number("int"), // required
|
|
83
|
-
* failedCount: Number("int"), // required
|
|
84
|
-
* },
|
|
85
|
-
* artifacts: [ // WilmaChatArtifactCardList
|
|
86
|
-
* { // WilmaChatArtifactCard
|
|
87
|
-
* artifactId: "STRING_VALUE", // required
|
|
88
|
-
* title: "STRING_VALUE", // required
|
|
89
|
-
* kind: "STRING_VALUE", // required
|
|
90
|
-
* size: Number("long"), // required
|
|
91
|
-
* name: "STRING_VALUE",
|
|
92
|
-
* },
|
|
93
|
-
* ],
|
|
94
|
-
* },
|
|
95
76
|
* },
|
|
96
77
|
* ],
|
|
97
78
|
* attachments: [ // MessageAttachmentRequestList
|
|
@@ -219,25 +200,6 @@ declare const SendMessageCommand_base: {
|
|
|
219
200
|
* // },
|
|
220
201
|
* // },
|
|
221
202
|
* // ],
|
|
222
|
-
* // wilma: { // WilmaChatElement
|
|
223
|
-
* // sessionId: "STRING_VALUE", // required
|
|
224
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
225
|
-
* // inspect: { // WilmaChatInspect
|
|
226
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
227
|
-
* // durationMs: Number("int"),
|
|
228
|
-
* // toolCount: Number("int"), // required
|
|
229
|
-
* // failedCount: Number("int"), // required
|
|
230
|
-
* // },
|
|
231
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
232
|
-
* // { // WilmaChatArtifactCard
|
|
233
|
-
* // artifactId: "STRING_VALUE", // required
|
|
234
|
-
* // title: "STRING_VALUE", // required
|
|
235
|
-
* // kind: "STRING_VALUE", // required
|
|
236
|
-
* // size: Number("long"), // required
|
|
237
|
-
* // name: "STRING_VALUE",
|
|
238
|
-
* // },
|
|
239
|
-
* // ],
|
|
240
|
-
* // },
|
|
241
203
|
* // },
|
|
242
204
|
* // ],
|
|
243
205
|
* // whatsapp: true || false,
|
|
@@ -134,25 +134,6 @@ declare const SendMessageReactionCommand_base: {
|
|
|
134
134
|
* // },
|
|
135
135
|
* // },
|
|
136
136
|
* // ],
|
|
137
|
-
* // wilma: { // WilmaChatElement
|
|
138
|
-
* // sessionId: "STRING_VALUE", // required
|
|
139
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
140
|
-
* // inspect: { // WilmaChatInspect
|
|
141
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
142
|
-
* // durationMs: Number("int"),
|
|
143
|
-
* // toolCount: Number("int"), // required
|
|
144
|
-
* // failedCount: Number("int"), // required
|
|
145
|
-
* // },
|
|
146
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
147
|
-
* // { // WilmaChatArtifactCard
|
|
148
|
-
* // artifactId: "STRING_VALUE", // required
|
|
149
|
-
* // title: "STRING_VALUE", // required
|
|
150
|
-
* // kind: "STRING_VALUE", // required
|
|
151
|
-
* // size: Number("long"), // required
|
|
152
|
-
* // name: "STRING_VALUE",
|
|
153
|
-
* // },
|
|
154
|
-
* // ],
|
|
155
|
-
* // },
|
|
156
137
|
* // },
|
|
157
138
|
* // ],
|
|
158
139
|
* // whatsapp: true || false,
|
|
@@ -142,25 +142,6 @@ declare const SendSystemMessageCommand_base: {
|
|
|
142
142
|
* // },
|
|
143
143
|
* // },
|
|
144
144
|
* // ],
|
|
145
|
-
* // wilma: { // WilmaChatElement
|
|
146
|
-
* // sessionId: "STRING_VALUE", // required
|
|
147
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
148
|
-
* // inspect: { // WilmaChatInspect
|
|
149
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
150
|
-
* // durationMs: Number("int"),
|
|
151
|
-
* // toolCount: Number("int"), // required
|
|
152
|
-
* // failedCount: Number("int"), // required
|
|
153
|
-
* // },
|
|
154
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
155
|
-
* // { // WilmaChatArtifactCard
|
|
156
|
-
* // artifactId: "STRING_VALUE", // required
|
|
157
|
-
* // title: "STRING_VALUE", // required
|
|
158
|
-
* // kind: "STRING_VALUE", // required
|
|
159
|
-
* // size: Number("long"), // required
|
|
160
|
-
* // name: "STRING_VALUE",
|
|
161
|
-
* // },
|
|
162
|
-
* // ],
|
|
163
|
-
* // },
|
|
164
145
|
* // },
|
|
165
146
|
* // ],
|
|
166
147
|
* // whatsapp: true || false,
|
|
@@ -133,25 +133,6 @@ declare const UnpinMessageCommand_base: {
|
|
|
133
133
|
* // },
|
|
134
134
|
* // },
|
|
135
135
|
* // ],
|
|
136
|
-
* // wilma: { // WilmaChatElement
|
|
137
|
-
* // sessionId: "STRING_VALUE", // required
|
|
138
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
139
|
-
* // inspect: { // WilmaChatInspect
|
|
140
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
141
|
-
* // durationMs: Number("int"),
|
|
142
|
-
* // toolCount: Number("int"), // required
|
|
143
|
-
* // failedCount: Number("int"), // required
|
|
144
|
-
* // },
|
|
145
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
146
|
-
* // { // WilmaChatArtifactCard
|
|
147
|
-
* // artifactId: "STRING_VALUE", // required
|
|
148
|
-
* // title: "STRING_VALUE", // required
|
|
149
|
-
* // kind: "STRING_VALUE", // required
|
|
150
|
-
* // size: Number("long"), // required
|
|
151
|
-
* // name: "STRING_VALUE",
|
|
152
|
-
* // },
|
|
153
|
-
* // ],
|
|
154
|
-
* // },
|
|
155
136
|
* // },
|
|
156
137
|
* // ],
|
|
157
138
|
* // whatsapp: true || false,
|
|
@@ -73,25 +73,6 @@ declare const UpdateMessageCommand_base: {
|
|
|
73
73
|
* },
|
|
74
74
|
* },
|
|
75
75
|
* ],
|
|
76
|
-
* wilma: { // WilmaChatElement
|
|
77
|
-
* sessionId: "STRING_VALUE", // required
|
|
78
|
-
* verbosity: "none" || "simple" || "full", // required
|
|
79
|
-
* inspect: { // WilmaChatInspect
|
|
80
|
-
* outcome: "done" || "stopped" || "failed", // required
|
|
81
|
-
* durationMs: Number("int"),
|
|
82
|
-
* toolCount: Number("int"), // required
|
|
83
|
-
* failedCount: Number("int"), // required
|
|
84
|
-
* },
|
|
85
|
-
* artifacts: [ // WilmaChatArtifactCardList
|
|
86
|
-
* { // WilmaChatArtifactCard
|
|
87
|
-
* artifactId: "STRING_VALUE", // required
|
|
88
|
-
* title: "STRING_VALUE", // required
|
|
89
|
-
* kind: "STRING_VALUE", // required
|
|
90
|
-
* size: Number("long"), // required
|
|
91
|
-
* name: "STRING_VALUE",
|
|
92
|
-
* },
|
|
93
|
-
* ],
|
|
94
|
-
* },
|
|
95
76
|
* },
|
|
96
77
|
* ],
|
|
97
78
|
* attachments: [ // MessageAttachmentRequestList
|
|
@@ -218,25 +199,6 @@ declare const UpdateMessageCommand_base: {
|
|
|
218
199
|
* // },
|
|
219
200
|
* // },
|
|
220
201
|
* // ],
|
|
221
|
-
* // wilma: { // WilmaChatElement
|
|
222
|
-
* // sessionId: "STRING_VALUE", // required
|
|
223
|
-
* // verbosity: "none" || "simple" || "full", // required
|
|
224
|
-
* // inspect: { // WilmaChatInspect
|
|
225
|
-
* // outcome: "done" || "stopped" || "failed", // required
|
|
226
|
-
* // durationMs: Number("int"),
|
|
227
|
-
* // toolCount: Number("int"), // required
|
|
228
|
-
* // failedCount: Number("int"), // required
|
|
229
|
-
* // },
|
|
230
|
-
* // artifacts: [ // WilmaChatArtifactCardList
|
|
231
|
-
* // { // WilmaChatArtifactCard
|
|
232
|
-
* // artifactId: "STRING_VALUE", // required
|
|
233
|
-
* // title: "STRING_VALUE", // required
|
|
234
|
-
* // kind: "STRING_VALUE", // required
|
|
235
|
-
* // size: Number("long"), // required
|
|
236
|
-
* // name: "STRING_VALUE",
|
|
237
|
-
* // },
|
|
238
|
-
* // ],
|
|
239
|
-
* // },
|
|
240
202
|
* // },
|
|
241
203
|
* // ],
|
|
242
204
|
* // whatsapp: true || false,
|