@wildix/xbees-conversations-client 1.0.28 → 1.0.30
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/Conversations.js +10 -0
- package/dist-cjs/commands/DeleteMessageCommand.js +41 -0
- package/dist-cjs/commands/ListChannelsCommand.js +41 -0
- package/dist-cjs/commands/ListMessagesCommand.js +41 -0
- package/dist-cjs/commands/PartialUpdateMessageCommand.js +41 -0
- package/dist-cjs/commands/UpdateMessageCommand.js +41 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/models_0.js +32 -11
- package/dist-cjs/protocols/Aws_restJson1.js +353 -3
- package/dist-es/Conversations.js +10 -0
- package/dist-es/commands/DeleteMessageCommand.js +37 -0
- package/dist-es/commands/ListChannelsCommand.js +37 -0
- package/dist-es/commands/ListMessagesCommand.js +37 -0
- package/dist-es/commands/PartialUpdateMessageCommand.js +37 -0
- package/dist-es/commands/UpdateMessageCommand.js +37 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +28 -8
- package/dist-es/protocols/Aws_restJson1.js +343 -3
- package/dist-types/Conversations.d.ts +35 -0
- package/dist-types/ConversationsClient.d.ts +7 -2
- package/dist-types/commands/CreateChannelCommand.d.ts +1 -0
- package/dist-types/commands/CreateMessageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageCommand.d.ts +76 -0
- package/dist-types/commands/GetMessageCommand.d.ts +1 -0
- package/dist-types/commands/JoinChannelCommand.d.ts +1 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +139 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +211 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +1 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +365 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +1 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +362 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +124 -7
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/package.json +2 -2
|
@@ -0,0 +1,365 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { PartialUpdateMessageInput, PartialUpdateMessageOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link PartialUpdateMessageCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface PartialUpdateMessageCommandInput extends PartialUpdateMessageInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link PartialUpdateMessageCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface PartialUpdateMessageCommandOutput extends PartialUpdateMessageOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { ConversationsClient, PartialUpdateMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
30
|
+
* // const { ConversationsClient, PartialUpdateMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
31
|
+
* const client = new ConversationsClient(config);
|
|
32
|
+
* const input = { // PartialUpdateMessageInput
|
|
33
|
+
* channelId: "STRING_VALUE", // required
|
|
34
|
+
* messageId: "STRING_VALUE", // required
|
|
35
|
+
* userId: "STRING_VALUE",
|
|
36
|
+
* set: { // MessageUpdateFields
|
|
37
|
+
* type: "regular", // required
|
|
38
|
+
* text: "STRING_VALUE",
|
|
39
|
+
* silent: true || false,
|
|
40
|
+
* event: "STRING_VALUE",
|
|
41
|
+
* attachments: [ // MessageAttachmentList
|
|
42
|
+
* { // MessageAttachment
|
|
43
|
+
* id: "STRING_VALUE", // required
|
|
44
|
+
* fsId: "STRING_VALUE", // required
|
|
45
|
+
* mime: "STRING_VALUE",
|
|
46
|
+
* name: "STRING_VALUE",
|
|
47
|
+
* size: Number("int"), // required
|
|
48
|
+
* width: Number("int"),
|
|
49
|
+
* height: Number("int"),
|
|
50
|
+
* thumbnail: "STRING_VALUE",
|
|
51
|
+
* },
|
|
52
|
+
* ],
|
|
53
|
+
* giphy: { // MessageGiphy
|
|
54
|
+
* id: "STRING_VALUE",
|
|
55
|
+
* size: "STRING_VALUE",
|
|
56
|
+
* url: "STRING_VALUE",
|
|
57
|
+
* height: "STRING_VALUE",
|
|
58
|
+
* width: "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* quote: { // Message
|
|
61
|
+
* type: "regular", // required
|
|
62
|
+
* text: "STRING_VALUE",
|
|
63
|
+
* silent: true || false,
|
|
64
|
+
* event: "STRING_VALUE",
|
|
65
|
+
* attachments: [
|
|
66
|
+
* {
|
|
67
|
+
* id: "STRING_VALUE", // required
|
|
68
|
+
* fsId: "STRING_VALUE", // required
|
|
69
|
+
* mime: "STRING_VALUE",
|
|
70
|
+
* name: "STRING_VALUE",
|
|
71
|
+
* size: Number("int"), // required
|
|
72
|
+
* width: Number("int"),
|
|
73
|
+
* height: Number("int"),
|
|
74
|
+
* thumbnail: "STRING_VALUE",
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* giphy: {
|
|
78
|
+
* id: "STRING_VALUE",
|
|
79
|
+
* size: "STRING_VALUE",
|
|
80
|
+
* url: "STRING_VALUE",
|
|
81
|
+
* height: "STRING_VALUE",
|
|
82
|
+
* width: "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* quote: {
|
|
85
|
+
* type: "regular", // required
|
|
86
|
+
* text: "STRING_VALUE",
|
|
87
|
+
* silent: true || false,
|
|
88
|
+
* event: "STRING_VALUE",
|
|
89
|
+
* attachments: "<MessageAttachmentList>",
|
|
90
|
+
* giphy: "<MessageGiphy>",
|
|
91
|
+
* quote: "<Message>",
|
|
92
|
+
* forward: { // MessageForward
|
|
93
|
+
* forwardCompany: "STRING_VALUE",
|
|
94
|
+
* forwardDate: "STRING_VALUE", // required
|
|
95
|
+
* forwardEmail: "STRING_VALUE",
|
|
96
|
+
* forwardName: "STRING_VALUE",
|
|
97
|
+
* },
|
|
98
|
+
* sms: true || false,
|
|
99
|
+
* smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
100
|
+
* messageId: "STRING_VALUE", // required
|
|
101
|
+
* channelId: "STRING_VALUE", // required
|
|
102
|
+
* user: { // User
|
|
103
|
+
* id: "STRING_VALUE", // required
|
|
104
|
+
* name: "STRING_VALUE",
|
|
105
|
+
* email: "STRING_VALUE",
|
|
106
|
+
* phone: "STRING_VALUE",
|
|
107
|
+
* picture: "STRING_VALUE",
|
|
108
|
+
* company: "STRING_VALUE",
|
|
109
|
+
* pbxDomain: "STRING_VALUE",
|
|
110
|
+
* pbxPort: "STRING_VALUE",
|
|
111
|
+
* pbxExtension: "STRING_VALUE",
|
|
112
|
+
* pbxSerial: "STRING_VALUE",
|
|
113
|
+
* pbxUserId: "STRING_VALUE",
|
|
114
|
+
* createdAt: "STRING_VALUE",
|
|
115
|
+
* updatedAt: "STRING_VALUE",
|
|
116
|
+
* },
|
|
117
|
+
* edit: true || false,
|
|
118
|
+
* mentions: [ // UserList
|
|
119
|
+
* {
|
|
120
|
+
* id: "STRING_VALUE", // required
|
|
121
|
+
* name: "STRING_VALUE",
|
|
122
|
+
* email: "STRING_VALUE",
|
|
123
|
+
* phone: "STRING_VALUE",
|
|
124
|
+
* picture: "STRING_VALUE",
|
|
125
|
+
* company: "STRING_VALUE",
|
|
126
|
+
* pbxDomain: "STRING_VALUE",
|
|
127
|
+
* pbxPort: "STRING_VALUE",
|
|
128
|
+
* pbxExtension: "STRING_VALUE",
|
|
129
|
+
* pbxSerial: "STRING_VALUE",
|
|
130
|
+
* pbxUserId: "STRING_VALUE",
|
|
131
|
+
* createdAt: "STRING_VALUE",
|
|
132
|
+
* updatedAt: "STRING_VALUE",
|
|
133
|
+
* },
|
|
134
|
+
* ],
|
|
135
|
+
* latestReactions: [ // ReactionList
|
|
136
|
+
* { // Reaction
|
|
137
|
+
* type: "STRING_VALUE",
|
|
138
|
+
* userId: "STRING_VALUE",
|
|
139
|
+
* messageId: "STRING_VALUE",
|
|
140
|
+
* user: "<User>",
|
|
141
|
+
* },
|
|
142
|
+
* ],
|
|
143
|
+
* reactionCounts: { // ReactionCounts
|
|
144
|
+
* "<keys>": Number("int"),
|
|
145
|
+
* },
|
|
146
|
+
* createdAt: "STRING_VALUE", // required
|
|
147
|
+
* updatedAt: "STRING_VALUE",
|
|
148
|
+
* },
|
|
149
|
+
* forward: {
|
|
150
|
+
* forwardCompany: "STRING_VALUE",
|
|
151
|
+
* forwardDate: "STRING_VALUE", // required
|
|
152
|
+
* forwardEmail: "STRING_VALUE",
|
|
153
|
+
* forwardName: "STRING_VALUE",
|
|
154
|
+
* },
|
|
155
|
+
* sms: true || false,
|
|
156
|
+
* smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
157
|
+
* messageId: "STRING_VALUE", // required
|
|
158
|
+
* channelId: "STRING_VALUE", // required
|
|
159
|
+
* user: "<User>", // required
|
|
160
|
+
* edit: true || false,
|
|
161
|
+
* mentions: [
|
|
162
|
+
* "<User>",
|
|
163
|
+
* ],
|
|
164
|
+
* latestReactions: [
|
|
165
|
+
* {
|
|
166
|
+
* type: "STRING_VALUE",
|
|
167
|
+
* userId: "STRING_VALUE",
|
|
168
|
+
* messageId: "STRING_VALUE",
|
|
169
|
+
* user: "<User>",
|
|
170
|
+
* },
|
|
171
|
+
* ],
|
|
172
|
+
* reactionCounts: {
|
|
173
|
+
* "<keys>": Number("int"),
|
|
174
|
+
* },
|
|
175
|
+
* createdAt: "STRING_VALUE", // required
|
|
176
|
+
* updatedAt: "STRING_VALUE",
|
|
177
|
+
* },
|
|
178
|
+
* forward: "<MessageForward>",
|
|
179
|
+
* sms: true || false,
|
|
180
|
+
* smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
181
|
+
* mentions: [ // MessageCreateMentionsList
|
|
182
|
+
* "STRING_VALUE",
|
|
183
|
+
* ],
|
|
184
|
+
* },
|
|
185
|
+
* unset: [ // MessageUnsetFieldsList
|
|
186
|
+
* "event" || "attachments" || "quote" || "forward" || "sms" || "smsStatus",
|
|
187
|
+
* ],
|
|
188
|
+
* };
|
|
189
|
+
* const command = new PartialUpdateMessageCommand(input);
|
|
190
|
+
* const response = await client.send(command);
|
|
191
|
+
* // { // PartialUpdateMessageOutput
|
|
192
|
+
* // message: { // Message
|
|
193
|
+
* // type: "regular", // required
|
|
194
|
+
* // text: "STRING_VALUE",
|
|
195
|
+
* // silent: true || false,
|
|
196
|
+
* // event: "STRING_VALUE",
|
|
197
|
+
* // attachments: [ // MessageAttachmentList
|
|
198
|
+
* // { // MessageAttachment
|
|
199
|
+
* // id: "STRING_VALUE", // required
|
|
200
|
+
* // fsId: "STRING_VALUE", // required
|
|
201
|
+
* // mime: "STRING_VALUE",
|
|
202
|
+
* // name: "STRING_VALUE",
|
|
203
|
+
* // size: Number("int"), // required
|
|
204
|
+
* // width: Number("int"),
|
|
205
|
+
* // height: Number("int"),
|
|
206
|
+
* // thumbnail: "STRING_VALUE",
|
|
207
|
+
* // },
|
|
208
|
+
* // ],
|
|
209
|
+
* // giphy: { // MessageGiphy
|
|
210
|
+
* // id: "STRING_VALUE",
|
|
211
|
+
* // size: "STRING_VALUE",
|
|
212
|
+
* // url: "STRING_VALUE",
|
|
213
|
+
* // height: "STRING_VALUE",
|
|
214
|
+
* // width: "STRING_VALUE",
|
|
215
|
+
* // },
|
|
216
|
+
* // quote: {
|
|
217
|
+
* // type: "regular", // required
|
|
218
|
+
* // text: "STRING_VALUE",
|
|
219
|
+
* // silent: true || false,
|
|
220
|
+
* // event: "STRING_VALUE",
|
|
221
|
+
* // attachments: [
|
|
222
|
+
* // {
|
|
223
|
+
* // id: "STRING_VALUE", // required
|
|
224
|
+
* // fsId: "STRING_VALUE", // required
|
|
225
|
+
* // mime: "STRING_VALUE",
|
|
226
|
+
* // name: "STRING_VALUE",
|
|
227
|
+
* // size: Number("int"), // required
|
|
228
|
+
* // width: Number("int"),
|
|
229
|
+
* // height: Number("int"),
|
|
230
|
+
* // thumbnail: "STRING_VALUE",
|
|
231
|
+
* // },
|
|
232
|
+
* // ],
|
|
233
|
+
* // giphy: {
|
|
234
|
+
* // id: "STRING_VALUE",
|
|
235
|
+
* // size: "STRING_VALUE",
|
|
236
|
+
* // url: "STRING_VALUE",
|
|
237
|
+
* // height: "STRING_VALUE",
|
|
238
|
+
* // width: "STRING_VALUE",
|
|
239
|
+
* // },
|
|
240
|
+
* // quote: "<Message>",
|
|
241
|
+
* // forward: { // MessageForward
|
|
242
|
+
* // forwardCompany: "STRING_VALUE",
|
|
243
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
244
|
+
* // forwardEmail: "STRING_VALUE",
|
|
245
|
+
* // forwardName: "STRING_VALUE",
|
|
246
|
+
* // },
|
|
247
|
+
* // sms: true || false,
|
|
248
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
249
|
+
* // messageId: "STRING_VALUE", // required
|
|
250
|
+
* // channelId: "STRING_VALUE", // required
|
|
251
|
+
* // user: { // User
|
|
252
|
+
* // id: "STRING_VALUE", // required
|
|
253
|
+
* // name: "STRING_VALUE",
|
|
254
|
+
* // email: "STRING_VALUE",
|
|
255
|
+
* // phone: "STRING_VALUE",
|
|
256
|
+
* // picture: "STRING_VALUE",
|
|
257
|
+
* // company: "STRING_VALUE",
|
|
258
|
+
* // pbxDomain: "STRING_VALUE",
|
|
259
|
+
* // pbxPort: "STRING_VALUE",
|
|
260
|
+
* // pbxExtension: "STRING_VALUE",
|
|
261
|
+
* // pbxSerial: "STRING_VALUE",
|
|
262
|
+
* // pbxUserId: "STRING_VALUE",
|
|
263
|
+
* // createdAt: "STRING_VALUE",
|
|
264
|
+
* // updatedAt: "STRING_VALUE",
|
|
265
|
+
* // },
|
|
266
|
+
* // edit: true || false,
|
|
267
|
+
* // mentions: [ // UserList
|
|
268
|
+
* // {
|
|
269
|
+
* // id: "STRING_VALUE", // required
|
|
270
|
+
* // name: "STRING_VALUE",
|
|
271
|
+
* // email: "STRING_VALUE",
|
|
272
|
+
* // phone: "STRING_VALUE",
|
|
273
|
+
* // picture: "STRING_VALUE",
|
|
274
|
+
* // company: "STRING_VALUE",
|
|
275
|
+
* // pbxDomain: "STRING_VALUE",
|
|
276
|
+
* // pbxPort: "STRING_VALUE",
|
|
277
|
+
* // pbxExtension: "STRING_VALUE",
|
|
278
|
+
* // pbxSerial: "STRING_VALUE",
|
|
279
|
+
* // pbxUserId: "STRING_VALUE",
|
|
280
|
+
* // createdAt: "STRING_VALUE",
|
|
281
|
+
* // updatedAt: "STRING_VALUE",
|
|
282
|
+
* // },
|
|
283
|
+
* // ],
|
|
284
|
+
* // latestReactions: [ // ReactionList
|
|
285
|
+
* // { // Reaction
|
|
286
|
+
* // type: "STRING_VALUE",
|
|
287
|
+
* // userId: "STRING_VALUE",
|
|
288
|
+
* // messageId: "STRING_VALUE",
|
|
289
|
+
* // user: "<User>",
|
|
290
|
+
* // },
|
|
291
|
+
* // ],
|
|
292
|
+
* // reactionCounts: { // ReactionCounts
|
|
293
|
+
* // "<keys>": Number("int"),
|
|
294
|
+
* // },
|
|
295
|
+
* // createdAt: "STRING_VALUE", // required
|
|
296
|
+
* // updatedAt: "STRING_VALUE",
|
|
297
|
+
* // },
|
|
298
|
+
* // forward: {
|
|
299
|
+
* // forwardCompany: "STRING_VALUE",
|
|
300
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
301
|
+
* // forwardEmail: "STRING_VALUE",
|
|
302
|
+
* // forwardName: "STRING_VALUE",
|
|
303
|
+
* // },
|
|
304
|
+
* // sms: true || false,
|
|
305
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
306
|
+
* // messageId: "STRING_VALUE", // required
|
|
307
|
+
* // channelId: "STRING_VALUE", // required
|
|
308
|
+
* // user: "<User>", // required
|
|
309
|
+
* // edit: true || false,
|
|
310
|
+
* // mentions: [
|
|
311
|
+
* // "<User>",
|
|
312
|
+
* // ],
|
|
313
|
+
* // latestReactions: [
|
|
314
|
+
* // {
|
|
315
|
+
* // type: "STRING_VALUE",
|
|
316
|
+
* // userId: "STRING_VALUE",
|
|
317
|
+
* // messageId: "STRING_VALUE",
|
|
318
|
+
* // user: "<User>",
|
|
319
|
+
* // },
|
|
320
|
+
* // ],
|
|
321
|
+
* // reactionCounts: {
|
|
322
|
+
* // "<keys>": Number("int"),
|
|
323
|
+
* // },
|
|
324
|
+
* // createdAt: "STRING_VALUE", // required
|
|
325
|
+
* // updatedAt: "STRING_VALUE",
|
|
326
|
+
* // },
|
|
327
|
+
* // };
|
|
328
|
+
*
|
|
329
|
+
* ```
|
|
330
|
+
*
|
|
331
|
+
* @param PartialUpdateMessageCommandInput - {@link PartialUpdateMessageCommandInput}
|
|
332
|
+
* @returns {@link PartialUpdateMessageCommandOutput}
|
|
333
|
+
* @see {@link PartialUpdateMessageCommandInput} for command's `input` shape.
|
|
334
|
+
* @see {@link PartialUpdateMessageCommandOutput} for command's `response` shape.
|
|
335
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
336
|
+
*
|
|
337
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
338
|
+
*
|
|
339
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
340
|
+
*
|
|
341
|
+
* @throws {@link ValidationException} (client fault)
|
|
342
|
+
*
|
|
343
|
+
* @throws {@link ConversationsServiceException}
|
|
344
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
export declare class PartialUpdateMessageCommand extends $Command<PartialUpdateMessageCommandInput, PartialUpdateMessageCommandOutput, ConversationsClientResolvedConfig> {
|
|
348
|
+
readonly input: PartialUpdateMessageCommandInput;
|
|
349
|
+
/**
|
|
350
|
+
* @public
|
|
351
|
+
*/
|
|
352
|
+
constructor(input: PartialUpdateMessageCommandInput);
|
|
353
|
+
/**
|
|
354
|
+
* @internal
|
|
355
|
+
*/
|
|
356
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PartialUpdateMessageCommandInput, PartialUpdateMessageCommandOutput>;
|
|
357
|
+
/**
|
|
358
|
+
* @internal
|
|
359
|
+
*/
|
|
360
|
+
private serialize;
|
|
361
|
+
/**
|
|
362
|
+
* @internal
|
|
363
|
+
*/
|
|
364
|
+
private deserialize;
|
|
365
|
+
}
|
|
@@ -31,6 +31,7 @@ export interface UpdateChannelCommandOutput extends UpdateChannelOutput, __Metad
|
|
|
31
31
|
* const client = new ConversationsClient(config);
|
|
32
32
|
* const input = { // UpdateChannelInput
|
|
33
33
|
* channelId: "STRING_VALUE", // required
|
|
34
|
+
* userId: "STRING_VALUE",
|
|
34
35
|
* channel: { // ChannelUpdateFields
|
|
35
36
|
* subject: "STRING_VALUE",
|
|
36
37
|
* description: "STRING_VALUE",
|