@wildix/xbees-conversations-client 1.0.55 → 1.0.56

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.
@@ -0,0 +1,300 @@
1
+ import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
2
+ import { CreateKiteChannelInput, CreateKiteChannelOutput } 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 CreateKiteChannelCommand}.
14
+ */
15
+ export interface CreateKiteChannelCommandInput extends CreateKiteChannelInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateKiteChannelCommand}.
21
+ */
22
+ export interface CreateKiteChannelCommandOutput extends CreateKiteChannelOutput, __MetadataBearer {
23
+ }
24
+ declare const CreateKiteChannelCommand_base: {
25
+ new (input: CreateKiteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKiteChannelCommandInput, CreateKiteChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateKiteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<CreateKiteChannelCommandInput, CreateKiteChannelCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Creates a new kite channel with specified widget or email.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ConversationsClient, CreateKiteChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
35
+ * // const { ConversationsClient, CreateKiteChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
36
+ * const client = new ConversationsClient(config);
37
+ * const input = { // CreateKiteChannelInput
38
+ * userId: "STRING_VALUE",
39
+ * channelId: "STRING_VALUE",
40
+ * targetId: "STRING_VALUE", // required
41
+ * targetRouteId: "STRING_VALUE",
42
+ * welcomeMessages: [ // WelcomeMessagesList
43
+ * { // WelcomeMessage
44
+ * text: "STRING_VALUE",
45
+ * attachments: [ // MessageAttachmentList
46
+ * { // MessageAttachment
47
+ * id: "STRING_VALUE", // required
48
+ * fsId: "STRING_VALUE", // required
49
+ * mime: "STRING_VALUE",
50
+ * name: "STRING_VALUE", // required
51
+ * size: Number("int"), // required
52
+ * width: Number("int"),
53
+ * height: Number("int"),
54
+ * thumbnail: "STRING_VALUE",
55
+ * },
56
+ * ],
57
+ * quote: { // MessageQuote
58
+ * messageId: "STRING_VALUE", // required
59
+ * channelId: "STRING_VALUE", // required
60
+ * user: { // User
61
+ * id: "STRING_VALUE", // required
62
+ * name: "STRING_VALUE",
63
+ * email: "STRING_VALUE",
64
+ * phone: "STRING_VALUE",
65
+ * picture: "STRING_VALUE",
66
+ * locale: "STRING_VALUE",
67
+ * timeZone: "STRING_VALUE",
68
+ * company: "STRING_VALUE",
69
+ * bot: true || false,
70
+ * pbxDomain: "STRING_VALUE",
71
+ * pbxPort: "STRING_VALUE",
72
+ * pbxExtension: "STRING_VALUE",
73
+ * pbxSerial: "STRING_VALUE",
74
+ * pbxUserId: "STRING_VALUE",
75
+ * createdAt: "STRING_VALUE",
76
+ * updatedAt: "STRING_VALUE",
77
+ * },
78
+ * text: "STRING_VALUE",
79
+ * attachments: [
80
+ * {
81
+ * id: "STRING_VALUE", // required
82
+ * fsId: "STRING_VALUE", // required
83
+ * mime: "STRING_VALUE",
84
+ * name: "STRING_VALUE", // required
85
+ * size: Number("int"), // required
86
+ * width: Number("int"),
87
+ * height: Number("int"),
88
+ * thumbnail: "STRING_VALUE",
89
+ * },
90
+ * ],
91
+ * forward: { // MessageForward
92
+ * forwardCompany: "STRING_VALUE",
93
+ * forwardDate: "STRING_VALUE", // required
94
+ * forwardEmail: "STRING_VALUE",
95
+ * forwardName: "STRING_VALUE",
96
+ * },
97
+ * mentions: [ // UsersList
98
+ * {
99
+ * id: "STRING_VALUE", // required
100
+ * name: "STRING_VALUE",
101
+ * email: "STRING_VALUE",
102
+ * phone: "STRING_VALUE",
103
+ * picture: "STRING_VALUE",
104
+ * locale: "STRING_VALUE",
105
+ * timeZone: "STRING_VALUE",
106
+ * company: "STRING_VALUE",
107
+ * bot: true || false,
108
+ * pbxDomain: "STRING_VALUE",
109
+ * pbxPort: "STRING_VALUE",
110
+ * pbxExtension: "STRING_VALUE",
111
+ * pbxSerial: "STRING_VALUE",
112
+ * pbxUserId: "STRING_VALUE",
113
+ * createdAt: "STRING_VALUE",
114
+ * updatedAt: "STRING_VALUE",
115
+ * },
116
+ * ],
117
+ * giphy: { // MessageGiphy
118
+ * id: "STRING_VALUE", // required
119
+ * size: "STRING_VALUE", // required
120
+ * url: "STRING_VALUE", // required
121
+ * height: "STRING_VALUE", // required
122
+ * width: "STRING_VALUE", // required
123
+ * },
124
+ * createdAt: "STRING_VALUE", // required
125
+ * updatedAt: "STRING_VALUE",
126
+ * },
127
+ * forward: {
128
+ * forwardCompany: "STRING_VALUE",
129
+ * forwardDate: "STRING_VALUE", // required
130
+ * forwardEmail: "STRING_VALUE",
131
+ * forwardName: "STRING_VALUE",
132
+ * },
133
+ * predefinedReplies: [ // MessagePredefinedRepliesList
134
+ * { // MessagePredefinedReply
135
+ * text: "STRING_VALUE", // required
136
+ * label: "STRING_VALUE",
137
+ * },
138
+ * ],
139
+ * type: "regular" || "system", // required
140
+ * giphy: {
141
+ * id: "STRING_VALUE", // required
142
+ * size: "STRING_VALUE", // required
143
+ * url: "STRING_VALUE", // required
144
+ * height: "STRING_VALUE", // required
145
+ * width: "STRING_VALUE", // required
146
+ * },
147
+ * silent: true || false,
148
+ * event: "STRING_VALUE",
149
+ * sms: true || false,
150
+ * smsStatus: "sent" || "delivered" || "trying" || "error",
151
+ * whatsapp: true || false,
152
+ * whatsappStatus: "trying" || "sent" || "delivered" || "error",
153
+ * messageId: "STRING_VALUE", // required
154
+ * user: "<User>", // required
155
+ * },
156
+ * ],
157
+ * initialMessage: { // InitialMessage
158
+ * text: "STRING_VALUE",
159
+ * attachments: "<MessageAttachmentList>",
160
+ * quote: {
161
+ * messageId: "STRING_VALUE", // required
162
+ * channelId: "STRING_VALUE", // required
163
+ * user: "<User>", // required
164
+ * text: "STRING_VALUE",
165
+ * attachments: "<MessageAttachmentList>",
166
+ * forward: {
167
+ * forwardCompany: "STRING_VALUE",
168
+ * forwardDate: "STRING_VALUE", // required
169
+ * forwardEmail: "STRING_VALUE",
170
+ * forwardName: "STRING_VALUE",
171
+ * },
172
+ * mentions: [
173
+ * "<User>",
174
+ * ],
175
+ * giphy: {
176
+ * id: "STRING_VALUE", // required
177
+ * size: "STRING_VALUE", // required
178
+ * url: "STRING_VALUE", // required
179
+ * height: "STRING_VALUE", // required
180
+ * width: "STRING_VALUE", // required
181
+ * },
182
+ * createdAt: "STRING_VALUE", // required
183
+ * updatedAt: "STRING_VALUE",
184
+ * },
185
+ * forward: "<MessageForward>",
186
+ * predefinedReplies: [
187
+ * {
188
+ * text: "STRING_VALUE", // required
189
+ * label: "STRING_VALUE",
190
+ * },
191
+ * ],
192
+ * type: "regular" || "system", // required
193
+ * giphy: "<MessageGiphy>",
194
+ * silent: true || false,
195
+ * event: "STRING_VALUE",
196
+ * sms: true || false,
197
+ * smsStatus: "sent" || "delivered" || "trying" || "error",
198
+ * whatsapp: true || false,
199
+ * whatsappStatus: "trying" || "sent" || "delivered" || "error",
200
+ * messageId: "STRING_VALUE", // required
201
+ * },
202
+ * };
203
+ * const command = new CreateKiteChannelCommand(input);
204
+ * const response = await client.send(command);
205
+ * // { // CreateKiteChannelOutput
206
+ * // channel: { // Channel
207
+ * // subject: "STRING_VALUE",
208
+ * // description: "STRING_VALUE",
209
+ * // picture: "STRING_VALUE",
210
+ * // pictureColor: "STRING_VALUE",
211
+ * // access: "private" || "public",
212
+ * // company: "STRING_VALUE",
213
+ * // context: { // ChannelContext
214
+ * // source: "kite",
215
+ * // target: "STRING_VALUE",
216
+ * // events: [ // ChannelContextEventList
217
+ * // { // ChannelContextEvent
218
+ * // id: "STRING_VALUE",
219
+ * // owner: "STRING_VALUE",
220
+ * // start: "STRING_VALUE",
221
+ * // end: "STRING_VALUE",
222
+ * // summary: "STRING_VALUE",
223
+ * // attendees: [ // ChannelContextEventAttendeeList
224
+ * // { // ChannelContextEventAttendee
225
+ * // email: "STRING_VALUE", // required
226
+ * // name: "STRING_VALUE",
227
+ * // status: "accepted" || "tentative" || "declined" || "none", // required
228
+ * // },
229
+ * // ],
230
+ * // },
231
+ * // ],
232
+ * // },
233
+ * // kite: true || false,
234
+ * // kiteTarget: "STRING_VALUE",
235
+ * // kiteVariant: "STRING_VALUE",
236
+ * // kiteAssign: "STRING_VALUE",
237
+ * // kiteServiceName: "STRING_VALUE",
238
+ * // kiteDefaultSubject: "STRING_VALUE",
239
+ * // service: "STRING_VALUE",
240
+ * // serviceTitle: "STRING_VALUE",
241
+ * // serviceRecipient: "STRING_VALUE",
242
+ * // assignee: { // User
243
+ * // id: "STRING_VALUE", // required
244
+ * // name: "STRING_VALUE",
245
+ * // email: "STRING_VALUE",
246
+ * // phone: "STRING_VALUE",
247
+ * // picture: "STRING_VALUE",
248
+ * // locale: "STRING_VALUE",
249
+ * // timeZone: "STRING_VALUE",
250
+ * // company: "STRING_VALUE",
251
+ * // bot: true || false,
252
+ * // pbxDomain: "STRING_VALUE",
253
+ * // pbxPort: "STRING_VALUE",
254
+ * // pbxExtension: "STRING_VALUE",
255
+ * // pbxSerial: "STRING_VALUE",
256
+ * // pbxUserId: "STRING_VALUE",
257
+ * // createdAt: "STRING_VALUE",
258
+ * // updatedAt: "STRING_VALUE",
259
+ * // },
260
+ * // telephony: true || false,
261
+ * // sms: true || false,
262
+ * // mms: true || false,
263
+ * // whatsapp: true || false,
264
+ * // whatsappStatus: "24h_channel_closed",
265
+ * // broadcast: true || false,
266
+ * // external: true || false,
267
+ * // channelId: "STRING_VALUE", // required
268
+ * // channelType: "direct" || "group", // required
269
+ * // memberCount: Number("int"), // required
270
+ * // createdAt: "STRING_VALUE", // required
271
+ * // createdBy: "STRING_VALUE", // required
272
+ * // updatedAt: "STRING_VALUE",
273
+ * // },
274
+ * // };
275
+ *
276
+ * ```
277
+ *
278
+ * @param CreateKiteChannelCommandInput - {@link CreateKiteChannelCommandInput}
279
+ * @returns {@link CreateKiteChannelCommandOutput}
280
+ * @see {@link CreateKiteChannelCommandInput} for command's `input` shape.
281
+ * @see {@link CreateKiteChannelCommandOutput} for command's `response` shape.
282
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
283
+ *
284
+ * @throws {@link TargetNotFoundException} (client fault)
285
+ *
286
+ * @throws {@link TargetNotEligibleException} (client fault)
287
+ *
288
+ * @throws {@link ValidationException} (client fault)
289
+ *
290
+ * @throws {@link ForbiddenException} (client fault)
291
+ *
292
+ * @throws {@link RateLimitExceededException} (client fault)
293
+ *
294
+ * @throws {@link ConversationsServiceException}
295
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
296
+ *
297
+ * @public
298
+ */
299
+ export declare class CreateKiteChannelCommand extends CreateKiteChannelCommand_base {
300
+ }
@@ -525,6 +525,12 @@ declare const DescribeEventCommand_base: {
525
525
  * // forwardEmail: "STRING_VALUE",
526
526
  * // forwardName: "STRING_VALUE",
527
527
  * // },
528
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
529
+ * // { // MessagePredefinedReply
530
+ * // text: "STRING_VALUE", // required
531
+ * // label: "STRING_VALUE",
532
+ * // },
533
+ * // ],
528
534
  * // type: "regular" || "system", // required
529
535
  * // giphy: {
530
536
  * // id: "STRING_VALUE", // required
@@ -623,6 +629,12 @@ declare const DescribeEventCommand_base: {
623
629
  * // forwardEmail: "STRING_VALUE",
624
630
  * // forwardName: "STRING_VALUE",
625
631
  * // },
632
+ * // predefinedReplies: [
633
+ * // {
634
+ * // text: "STRING_VALUE", // required
635
+ * // label: "STRING_VALUE",
636
+ * // },
637
+ * // ],
626
638
  * // type: "regular" || "system", // required
627
639
  * // giphy: {
628
640
  * // id: "STRING_VALUE", // required
@@ -705,6 +717,12 @@ declare const DescribeEventCommand_base: {
705
717
  * // updatedAt: "STRING_VALUE",
706
718
  * // },
707
719
  * // forward: "<MessageForward>",
720
+ * // predefinedReplies: [
721
+ * // {
722
+ * // text: "STRING_VALUE", // required
723
+ * // label: "STRING_VALUE",
724
+ * // },
725
+ * // ],
708
726
  * // type: "regular" || "system", // required
709
727
  * // giphy: "<MessageGiphy>",
710
728
  * // silent: true || false,
@@ -759,6 +777,12 @@ declare const DescribeEventCommand_base: {
759
777
  * // updatedAt: "STRING_VALUE",
760
778
  * // },
761
779
  * // forward: "<MessageForward>",
780
+ * // predefinedReplies: [
781
+ * // {
782
+ * // text: "STRING_VALUE", // required
783
+ * // label: "STRING_VALUE",
784
+ * // },
785
+ * // ],
762
786
  * // type: "regular" || "system", // required
763
787
  * // giphy: "<MessageGiphy>",
764
788
  * // silent: true || false,
@@ -819,6 +843,12 @@ declare const DescribeEventCommand_base: {
819
843
  * // updatedAt: "STRING_VALUE",
820
844
  * // },
821
845
  * // forward: "<MessageForward>",
846
+ * // predefinedReplies: [
847
+ * // {
848
+ * // text: "STRING_VALUE", // required
849
+ * // label: "STRING_VALUE",
850
+ * // },
851
+ * // ],
822
852
  * // type: "regular" || "system", // required
823
853
  * // giphy: "<MessageGiphy>",
824
854
  * // silent: true || false,
@@ -131,6 +131,12 @@ declare const GetMessageCommand_base: {
131
131
  * // forwardEmail: "STRING_VALUE",
132
132
  * // forwardName: "STRING_VALUE",
133
133
  * // },
134
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
135
+ * // { // MessagePredefinedReply
136
+ * // text: "STRING_VALUE", // required
137
+ * // label: "STRING_VALUE",
138
+ * // },
139
+ * // ],
134
140
  * // type: "regular" || "system", // required
135
141
  * // giphy: {
136
142
  * // id: "STRING_VALUE", // required
@@ -133,6 +133,12 @@ declare const ListMessagesCommand_base: {
133
133
  * // forwardEmail: "STRING_VALUE",
134
134
  * // forwardName: "STRING_VALUE",
135
135
  * // },
136
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
137
+ * // { // MessagePredefinedReply
138
+ * // text: "STRING_VALUE", // required
139
+ * // label: "STRING_VALUE",
140
+ * // },
141
+ * // ],
136
142
  * // type: "regular" || "system", // required
137
143
  * // giphy: {
138
144
  * // id: "STRING_VALUE", // required
@@ -128,6 +128,12 @@ declare const PartialUpdateMessageCommand_base: {
128
128
  * forwardEmail: "STRING_VALUE",
129
129
  * forwardName: "STRING_VALUE",
130
130
  * },
131
+ * predefinedReplies: [ // MessagePredefinedRepliesList
132
+ * { // MessagePredefinedReply
133
+ * text: "STRING_VALUE", // required
134
+ * label: "STRING_VALUE",
135
+ * },
136
+ * ],
131
137
  * },
132
138
  * unset: [ // MessageUnsetFieldsList
133
139
  * "text" || "attachments" || "quote" || "forward",
@@ -226,6 +232,12 @@ declare const PartialUpdateMessageCommand_base: {
226
232
  * // forwardEmail: "STRING_VALUE",
227
233
  * // forwardName: "STRING_VALUE",
228
234
  * // },
235
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
236
+ * // { // MessagePredefinedReply
237
+ * // text: "STRING_VALUE", // required
238
+ * // label: "STRING_VALUE",
239
+ * // },
240
+ * // ],
229
241
  * // type: "regular" || "system", // required
230
242
  * // giphy: {
231
243
  * // id: "STRING_VALUE", // required
@@ -139,6 +139,12 @@ declare const SendGiphyCommand_base: {
139
139
  * // forwardEmail: "STRING_VALUE",
140
140
  * // forwardName: "STRING_VALUE",
141
141
  * // },
142
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
143
+ * // { // MessagePredefinedReply
144
+ * // text: "STRING_VALUE", // required
145
+ * // label: "STRING_VALUE",
146
+ * // },
147
+ * // ],
142
148
  * // type: "regular" || "system", // required
143
149
  * // giphy: {
144
150
  * // id: "STRING_VALUE", // required
@@ -124,6 +124,12 @@ declare const SendMessageCommand_base: {
124
124
  * forwardEmail: "STRING_VALUE",
125
125
  * forwardName: "STRING_VALUE",
126
126
  * },
127
+ * predefinedReplies: [ // MessagePredefinedRepliesList
128
+ * { // MessagePredefinedReply
129
+ * text: "STRING_VALUE", // required
130
+ * label: "STRING_VALUE",
131
+ * },
132
+ * ],
127
133
  * channelId: "STRING_VALUE", // required
128
134
  * userId: "STRING_VALUE",
129
135
  * messageId: "STRING_VALUE",
@@ -224,6 +230,12 @@ declare const SendMessageCommand_base: {
224
230
  * // forwardEmail: "STRING_VALUE",
225
231
  * // forwardName: "STRING_VALUE",
226
232
  * // },
233
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
234
+ * // { // MessagePredefinedReply
235
+ * // text: "STRING_VALUE", // required
236
+ * // label: "STRING_VALUE",
237
+ * // },
238
+ * // ],
227
239
  * // type: "regular" || "system", // required
228
240
  * // giphy: {
229
241
  * // id: "STRING_VALUE", // required
@@ -124,6 +124,12 @@ declare const UpdateMessageCommand_base: {
124
124
  * forwardEmail: "STRING_VALUE",
125
125
  * forwardName: "STRING_VALUE",
126
126
  * },
127
+ * predefinedReplies: [ // MessagePredefinedRepliesList
128
+ * { // MessagePredefinedReply
129
+ * text: "STRING_VALUE", // required
130
+ * label: "STRING_VALUE",
131
+ * },
132
+ * ],
127
133
  * channelId: "STRING_VALUE", // required
128
134
  * messageId: "STRING_VALUE", // required
129
135
  * userId: "STRING_VALUE",
@@ -224,6 +230,12 @@ declare const UpdateMessageCommand_base: {
224
230
  * // forwardEmail: "STRING_VALUE",
225
231
  * // forwardName: "STRING_VALUE",
226
232
  * // },
233
+ * // predefinedReplies: [ // MessagePredefinedRepliesList
234
+ * // { // MessagePredefinedReply
235
+ * // text: "STRING_VALUE", // required
236
+ * // label: "STRING_VALUE",
237
+ * // },
238
+ * // ],
227
239
  * // type: "regular" || "system", // required
228
240
  * // giphy: {
229
241
  * // id: "STRING_VALUE", // required
@@ -1,6 +1,7 @@
1
1
  export * from "./AddChannelMemberCommand";
2
2
  export * from "./AddChannelMembersCommand";
3
3
  export * from "./CreateGroupChannelCommand";
4
+ export * from "./CreateKiteChannelCommand";
4
5
  export * from "./DeleteChannelCommand";
5
6
  export * from "./DeleteChannelMemberCommand";
6
7
  export * from "./DeleteMessageCommand";