@wildix/xbees-conversations-client 1.0.32 → 1.0.34

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.
Files changed (30) hide show
  1. package/dist-cjs/Conversations.js +6 -4
  2. package/dist-cjs/commands/{SendSystemMessageCommand.js → HideChannelCommand.js} +7 -7
  3. package/dist-cjs/commands/ListMessageReactionsCommand.js +41 -0
  4. package/dist-cjs/commands/{GetMessageReactionsCommand.js → ShowChannelCommand.js} +7 -7
  5. package/dist-cjs/commands/index.js +3 -2
  6. package/dist-cjs/protocols/Aws_restJson1.js +138 -135
  7. package/dist-es/Conversations.js +6 -4
  8. package/dist-es/commands/{SendSystemMessageCommand.js → HideChannelCommand.js} +6 -6
  9. package/dist-es/commands/ListMessageReactionsCommand.js +37 -0
  10. package/dist-es/commands/{GetMessageReactionsCommand.js → ShowChannelCommand.js} +6 -6
  11. package/dist-es/commands/index.js +3 -2
  12. package/dist-es/protocols/Aws_restJson1.js +125 -124
  13. package/dist-types/Conversations.d.ts +21 -14
  14. package/dist-types/ConversationsClient.d.ts +5 -4
  15. package/dist-types/commands/AddChannelMemberCommand.d.ts +1 -0
  16. package/dist-types/commands/AddChannelMembersCommand.d.ts +1 -0
  17. package/dist-types/commands/GetMessageCommand.d.ts +29 -47
  18. package/dist-types/commands/HideChannelCommand.d.ts +140 -0
  19. package/dist-types/commands/{GetMessageReactionsCommand.d.ts → ListMessageReactionsCommand.d.ts} +18 -18
  20. package/dist-types/commands/ListMessagesCommand.d.ts +31 -47
  21. package/dist-types/commands/PartialUpdateMessageCommand.d.ts +65 -138
  22. package/dist-types/commands/SendGiphyCommand.d.ts +29 -47
  23. package/dist-types/commands/SendMessageCommand.d.ts +65 -138
  24. package/dist-types/commands/ShowChannelCommand.d.ts +140 -0
  25. package/dist-types/commands/UpdateMessageCommand.d.ts +65 -138
  26. package/dist-types/commands/index.d.ts +3 -2
  27. package/dist-types/models/models_0.d.ts +150 -119
  28. package/dist-types/protocols/Aws_restJson1.d.ts +27 -18
  29. package/package.json +1 -1
  30. package/dist-types/commands/SendSystemMessageCommand.d.ts +0 -213
@@ -36,52 +36,52 @@ export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataB
36
36
  * id: "STRING_VALUE", // required
37
37
  * fsId: "STRING_VALUE", // required
38
38
  * mime: "STRING_VALUE",
39
- * name: "STRING_VALUE",
39
+ * name: "STRING_VALUE", // required
40
40
  * size: Number("int"), // required
41
41
  * width: Number("int"),
42
42
  * height: Number("int"),
43
43
  * thumbnail: "STRING_VALUE",
44
44
  * },
45
45
  * ],
46
- * quote: { // Message
46
+ * quote: { // MessageQuote
47
+ * messageId: "STRING_VALUE", // required
48
+ * channelId: "STRING_VALUE", // required
49
+ * user: { // User
50
+ * id: "STRING_VALUE", // required
51
+ * name: "STRING_VALUE",
52
+ * email: "STRING_VALUE",
53
+ * phone: "STRING_VALUE",
54
+ * picture: "STRING_VALUE",
55
+ * company: "STRING_VALUE",
56
+ * pbxDomain: "STRING_VALUE",
57
+ * pbxPort: "STRING_VALUE",
58
+ * pbxExtension: "STRING_VALUE",
59
+ * pbxSerial: "STRING_VALUE",
60
+ * pbxUserId: "STRING_VALUE",
61
+ * createdAt: "STRING_VALUE",
62
+ * updatedAt: "STRING_VALUE",
63
+ * },
47
64
  * text: "STRING_VALUE",
48
65
  * attachments: [
49
66
  * {
50
67
  * id: "STRING_VALUE", // required
51
68
  * fsId: "STRING_VALUE", // required
52
69
  * mime: "STRING_VALUE",
53
- * name: "STRING_VALUE",
70
+ * name: "STRING_VALUE", // required
54
71
  * size: Number("int"), // required
55
72
  * width: Number("int"),
56
73
  * height: Number("int"),
57
74
  * thumbnail: "STRING_VALUE",
58
75
  * },
59
76
  * ],
60
- * quote: {
61
- * text: "STRING_VALUE",
62
- * attachments: "<MessageAttachmentList>",
63
- * quote: "<Message>",
64
- * forward: { // MessageForward
65
- * forwardCompany: "STRING_VALUE",
66
- * forwardDate: "STRING_VALUE", // required
67
- * forwardEmail: "STRING_VALUE",
68
- * forwardName: "STRING_VALUE",
69
- * },
70
- * type: "regular", // required
71
- * giphy: { // MessageGiphy
72
- * id: "STRING_VALUE",
73
- * size: "STRING_VALUE",
74
- * url: "STRING_VALUE",
75
- * height: "STRING_VALUE",
76
- * width: "STRING_VALUE",
77
- * },
78
- * silent: true || false,
79
- * event: "STRING_VALUE",
80
- * sms: true || false,
81
- * smsStatus: "sent" || "delivered" || "trying" || "error",
82
- * messageId: "STRING_VALUE", // required
83
- * channelId: "STRING_VALUE", // required
84
- * user: { // User
77
+ * forward: { // MessageForward
78
+ * forwardCompany: "STRING_VALUE",
79
+ * forwardDate: "STRING_VALUE", // required
80
+ * forwardEmail: "STRING_VALUE",
81
+ * forwardName: "STRING_VALUE",
82
+ * },
83
+ * mentions: [ // UsersList
84
+ * {
85
85
  * id: "STRING_VALUE", // required
86
86
  * name: "STRING_VALUE",
87
87
  * email: "STRING_VALUE",
@@ -96,78 +96,23 @@ export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataB
96
96
  * createdAt: "STRING_VALUE",
97
97
  * updatedAt: "STRING_VALUE",
98
98
  * },
99
- * edit: true || false,
100
- * mentions: [ // UsersList
101
- * {
102
- * id: "STRING_VALUE", // required
103
- * name: "STRING_VALUE",
104
- * email: "STRING_VALUE",
105
- * phone: "STRING_VALUE",
106
- * picture: "STRING_VALUE",
107
- * company: "STRING_VALUE",
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
- * latestReactions: [ // ReactionList
118
- * { // Reaction
119
- * type: "STRING_VALUE",
120
- * userId: "STRING_VALUE",
121
- * messageId: "STRING_VALUE",
122
- * user: "<User>",
123
- * },
124
- * ],
125
- * reactionCounts: { // ReactionCounts
126
- * "<keys>": Number("int"),
127
- * },
128
- * createdAt: "STRING_VALUE", // required
129
- * updatedAt: "STRING_VALUE",
130
- * },
131
- * forward: {
132
- * forwardCompany: "STRING_VALUE",
133
- * forwardDate: "STRING_VALUE", // required
134
- * forwardEmail: "STRING_VALUE",
135
- * forwardName: "STRING_VALUE",
136
- * },
137
- * type: "regular", // required
138
- * giphy: {
99
+ * ],
100
+ * giphy: { // MessageGiphy
139
101
  * id: "STRING_VALUE",
140
102
  * size: "STRING_VALUE",
141
103
  * url: "STRING_VALUE",
142
104
  * height: "STRING_VALUE",
143
105
  * width: "STRING_VALUE",
144
106
  * },
145
- * silent: true || false,
146
- * event: "STRING_VALUE",
147
- * sms: true || false,
148
- * smsStatus: "sent" || "delivered" || "trying" || "error",
149
- * messageId: "STRING_VALUE", // required
150
- * channelId: "STRING_VALUE", // required
151
- * user: "<User>", // required
152
- * edit: true || false,
153
- * mentions: [
154
- * "<User>",
155
- * ],
156
- * latestReactions: [
157
- * {
158
- * type: "STRING_VALUE",
159
- * userId: "STRING_VALUE",
160
- * messageId: "STRING_VALUE",
161
- * user: "<User>",
162
- * },
163
- * ],
164
- * reactionCounts: {
165
- * "<keys>": Number("int"),
166
- * },
167
107
  * createdAt: "STRING_VALUE", // required
168
108
  * updatedAt: "STRING_VALUE",
169
109
  * },
170
- * forward: "<MessageForward>",
110
+ * forward: {
111
+ * forwardCompany: "STRING_VALUE",
112
+ * forwardDate: "STRING_VALUE", // required
113
+ * forwardEmail: "STRING_VALUE",
114
+ * forwardName: "STRING_VALUE",
115
+ * },
171
116
  * channelId: "STRING_VALUE", // required
172
117
  * userId: "STRING_VALUE",
173
118
  * messageId: "STRING_VALUE",
@@ -185,64 +130,50 @@ export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataB
185
130
  * // id: "STRING_VALUE", // required
186
131
  * // fsId: "STRING_VALUE", // required
187
132
  * // mime: "STRING_VALUE",
188
- * // name: "STRING_VALUE",
133
+ * // name: "STRING_VALUE", // required
189
134
  * // size: Number("int"), // required
190
135
  * // width: Number("int"),
191
136
  * // height: Number("int"),
192
137
  * // thumbnail: "STRING_VALUE",
193
138
  * // },
194
139
  * // ],
195
- * // quote: {
140
+ * // quote: { // MessageQuote
141
+ * // messageId: "STRING_VALUE", // required
142
+ * // channelId: "STRING_VALUE", // required
143
+ * // user: { // User
144
+ * // id: "STRING_VALUE", // required
145
+ * // name: "STRING_VALUE",
146
+ * // email: "STRING_VALUE",
147
+ * // phone: "STRING_VALUE",
148
+ * // picture: "STRING_VALUE",
149
+ * // company: "STRING_VALUE",
150
+ * // pbxDomain: "STRING_VALUE",
151
+ * // pbxPort: "STRING_VALUE",
152
+ * // pbxExtension: "STRING_VALUE",
153
+ * // pbxSerial: "STRING_VALUE",
154
+ * // pbxUserId: "STRING_VALUE",
155
+ * // createdAt: "STRING_VALUE",
156
+ * // updatedAt: "STRING_VALUE",
157
+ * // },
196
158
  * // text: "STRING_VALUE",
197
159
  * // attachments: [
198
160
  * // {
199
161
  * // id: "STRING_VALUE", // required
200
162
  * // fsId: "STRING_VALUE", // required
201
163
  * // mime: "STRING_VALUE",
202
- * // name: "STRING_VALUE",
164
+ * // name: "STRING_VALUE", // required
203
165
  * // size: Number("int"), // required
204
166
  * // width: Number("int"),
205
167
  * // height: Number("int"),
206
168
  * // thumbnail: "STRING_VALUE",
207
169
  * // },
208
170
  * // ],
209
- * // quote: "<Message>",
210
171
  * // forward: { // MessageForward
211
172
  * // forwardCompany: "STRING_VALUE",
212
173
  * // forwardDate: "STRING_VALUE", // required
213
174
  * // forwardEmail: "STRING_VALUE",
214
175
  * // forwardName: "STRING_VALUE",
215
176
  * // },
216
- * // type: "regular", // required
217
- * // giphy: { // MessageGiphy
218
- * // id: "STRING_VALUE",
219
- * // size: "STRING_VALUE",
220
- * // url: "STRING_VALUE",
221
- * // height: "STRING_VALUE",
222
- * // width: "STRING_VALUE",
223
- * // },
224
- * // silent: true || false,
225
- * // event: "STRING_VALUE",
226
- * // sms: true || false,
227
- * // smsStatus: "sent" || "delivered" || "trying" || "error",
228
- * // messageId: "STRING_VALUE", // required
229
- * // channelId: "STRING_VALUE", // required
230
- * // user: { // User
231
- * // id: "STRING_VALUE", // required
232
- * // name: "STRING_VALUE",
233
- * // email: "STRING_VALUE",
234
- * // phone: "STRING_VALUE",
235
- * // picture: "STRING_VALUE",
236
- * // company: "STRING_VALUE",
237
- * // pbxDomain: "STRING_VALUE",
238
- * // pbxPort: "STRING_VALUE",
239
- * // pbxExtension: "STRING_VALUE",
240
- * // pbxSerial: "STRING_VALUE",
241
- * // pbxUserId: "STRING_VALUE",
242
- * // createdAt: "STRING_VALUE",
243
- * // updatedAt: "STRING_VALUE",
244
- * // },
245
- * // edit: true || false,
246
177
  * // mentions: [ // UsersList
247
178
  * // {
248
179
  * // id: "STRING_VALUE", // required
@@ -260,16 +191,12 @@ export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataB
260
191
  * // updatedAt: "STRING_VALUE",
261
192
  * // },
262
193
  * // ],
263
- * // latestReactions: [ // ReactionList
264
- * // { // Reaction
265
- * // type: "STRING_VALUE",
266
- * // userId: "STRING_VALUE",
267
- * // messageId: "STRING_VALUE",
268
- * // user: "<User>",
269
- * // },
270
- * // ],
271
- * // reactionCounts: { // ReactionCounts
272
- * // "<keys>": Number("int"),
194
+ * // giphy: { // MessageGiphy
195
+ * // id: "STRING_VALUE",
196
+ * // size: "STRING_VALUE",
197
+ * // url: "STRING_VALUE",
198
+ * // height: "STRING_VALUE",
199
+ * // width: "STRING_VALUE",
273
200
  * // },
274
201
  * // createdAt: "STRING_VALUE", // required
275
202
  * // updatedAt: "STRING_VALUE",
@@ -299,15 +226,15 @@ export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataB
299
226
  * // mentions: [
300
227
  * // "<User>",
301
228
  * // ],
302
- * // latestReactions: [
303
- * // {
229
+ * // latestReactions: [ // ReactionList
230
+ * // { // Reaction
304
231
  * // type: "STRING_VALUE",
305
232
  * // userId: "STRING_VALUE",
306
233
  * // messageId: "STRING_VALUE",
307
234
  * // user: "<User>",
308
235
  * // },
309
236
  * // ],
310
- * // reactionCounts: {
237
+ * // reactionCounts: { // ReactionCounts
311
238
  * // "<keys>": Number("int"),
312
239
  * // },
313
240
  * // createdAt: "STRING_VALUE", // required
@@ -0,0 +1,140 @@
1
+ import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
2
+ import { ShowChannelInput, ShowChannelOutput } 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 ShowChannelCommand}.
13
+ */
14
+ export interface ShowChannelCommandInput extends ShowChannelInput {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ShowChannelCommand}.
20
+ */
21
+ export interface ShowChannelCommandOutput extends ShowChannelOutput, __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, ShowChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
30
+ * // const { ConversationsClient, ShowChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
31
+ * const client = new ConversationsClient(config);
32
+ * const input = { // ShowChannelInput
33
+ * channelId: "STRING_VALUE", // required
34
+ * userId: "STRING_VALUE",
35
+ * };
36
+ * const command = new ShowChannelCommand(input);
37
+ * const response = await client.send(command);
38
+ * // { // ShowChannelOutput
39
+ * // channel: { // Channel
40
+ * // subject: "STRING_VALUE",
41
+ * // description: "STRING_VALUE",
42
+ * // picture: "STRING_VALUE",
43
+ * // pictureColor: "STRING_VALUE",
44
+ * // access: "private" || "public",
45
+ * // company: "STRING_VALUE",
46
+ * // context: { // ChannelContext
47
+ * // source: "kite",
48
+ * // target: "STRING_VALUE",
49
+ * // events: [ // ChannelContextEventList
50
+ * // { // ChannelContextEvent
51
+ * // id: "STRING_VALUE",
52
+ * // owner: "STRING_VALUE",
53
+ * // start: "STRING_VALUE",
54
+ * // end: "STRING_VALUE",
55
+ * // summary: "STRING_VALUE",
56
+ * // attendees: [ // ChannelContextEventAttendeeList
57
+ * // { // ChannelContextEventAttendee
58
+ * // email: "STRING_VALUE", // required
59
+ * // name: "STRING_VALUE",
60
+ * // status: "accepted" || "tentative" || "declined" || "none", // required
61
+ * // },
62
+ * // ],
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // kite: true || false,
67
+ * // kiteTarget: "STRING_VALUE",
68
+ * // kiteVariant: "STRING_VALUE",
69
+ * // kiteAssign: "STRING_VALUE",
70
+ * // kiteServiceName: "STRING_VALUE",
71
+ * // kiteDefaultSubject: "STRING_VALUE",
72
+ * // service: "STRING_VALUE",
73
+ * // serviceTitle: "STRING_VALUE",
74
+ * // serviceRecipient: "STRING_VALUE",
75
+ * // assignee: { // User
76
+ * // id: "STRING_VALUE", // required
77
+ * // name: "STRING_VALUE",
78
+ * // email: "STRING_VALUE",
79
+ * // phone: "STRING_VALUE",
80
+ * // picture: "STRING_VALUE",
81
+ * // company: "STRING_VALUE",
82
+ * // pbxDomain: "STRING_VALUE",
83
+ * // pbxPort: "STRING_VALUE",
84
+ * // pbxExtension: "STRING_VALUE",
85
+ * // pbxSerial: "STRING_VALUE",
86
+ * // pbxUserId: "STRING_VALUE",
87
+ * // createdAt: "STRING_VALUE",
88
+ * // updatedAt: "STRING_VALUE",
89
+ * // },
90
+ * // telephony: true || false,
91
+ * // sms: true || false,
92
+ * // mms: true || false,
93
+ * // broadcast: true || false,
94
+ * // external: true || false,
95
+ * // channelId: "STRING_VALUE", // required
96
+ * // channelType: "direct" || "group", // required
97
+ * // memberCount: Number("int"), // required
98
+ * // createdAt: "STRING_VALUE", // required
99
+ * // createdBy: "STRING_VALUE", // required
100
+ * // updatedAt: "STRING_VALUE",
101
+ * // },
102
+ * // };
103
+ *
104
+ * ```
105
+ *
106
+ * @param ShowChannelCommandInput - {@link ShowChannelCommandInput}
107
+ * @returns {@link ShowChannelCommandOutput}
108
+ * @see {@link ShowChannelCommandInput} for command's `input` shape.
109
+ * @see {@link ShowChannelCommandOutput} for command's `response` shape.
110
+ * @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
111
+ *
112
+ * @throws {@link ChannelNotFoundException} (client fault)
113
+ *
114
+ * @throws {@link ForbiddenException} (client fault)
115
+ *
116
+ * @throws {@link ValidationException} (client fault)
117
+ *
118
+ * @throws {@link ConversationsServiceException}
119
+ * <p>Base exception class for all service exceptions from Conversations service.</p>
120
+ *
121
+ */
122
+ export declare class ShowChannelCommand extends $Command<ShowChannelCommandInput, ShowChannelCommandOutput, ConversationsClientResolvedConfig> {
123
+ readonly input: ShowChannelCommandInput;
124
+ /**
125
+ * @public
126
+ */
127
+ constructor(input: ShowChannelCommandInput);
128
+ /**
129
+ * @internal
130
+ */
131
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConversationsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ShowChannelCommandInput, ShowChannelCommandOutput>;
132
+ /**
133
+ * @internal
134
+ */
135
+ private serialize;
136
+ /**
137
+ * @internal
138
+ */
139
+ private deserialize;
140
+ }