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