@wildix/xbees-conversations-client 1.0.63 → 1.0.64
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 +6 -0
- package/dist-cjs/commands/ListPinnedMessagesCommand.js +21 -0
- package/dist-cjs/commands/PinMessageCommand.js +21 -0
- package/dist-cjs/commands/UnpinMessageCommand.js +21 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +101 -2
- package/dist-es/Conversations.js +6 -0
- package/dist-es/commands/ListPinnedMessagesCommand.js +17 -0
- package/dist-es/commands/PinMessageCommand.js +17 -0
- package/dist-es/commands/UnpinMessageCommand.js +17 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +92 -0
- package/dist-types/Conversations.d.ts +21 -0
- package/dist-types/ConversationsClient.d.ts +5 -2
- package/dist-types/commands/ListPinnedMessagesCommand.d.ts +261 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +1 -0
- package/dist-types/commands/PinMessageCommand.d.ts +73 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +71 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +1 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +103 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/package.json +1 -1
|
@@ -27,11 +27,13 @@ import { ListInboxTaggedChannelsCommandInput, ListInboxTaggedChannelsCommandOutp
|
|
|
27
27
|
import { ListInboxTagsCommandInput, ListInboxTagsCommandOutput } from "./commands/ListInboxTagsCommand";
|
|
28
28
|
import { ListMessageReactionsCommandInput, ListMessageReactionsCommandOutput } from "./commands/ListMessageReactionsCommand";
|
|
29
29
|
import { ListMessagesCommandInput, ListMessagesCommandOutput } from "./commands/ListMessagesCommand";
|
|
30
|
+
import { ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput } from "./commands/ListPinnedMessagesCommand";
|
|
30
31
|
import { MarkReadCommandInput, MarkReadCommandOutput } from "./commands/MarkReadCommand";
|
|
31
32
|
import { MarkUnreadCommandInput, MarkUnreadCommandOutput } from "./commands/MarkUnreadCommand";
|
|
32
33
|
import { PartialUpdateChannelCommandInput, PartialUpdateChannelCommandOutput } from "./commands/PartialUpdateChannelCommand";
|
|
33
34
|
import { PartialUpdateMessageCommandInput, PartialUpdateMessageCommandOutput } from "./commands/PartialUpdateMessageCommand";
|
|
34
35
|
import { PinChannelCommandInput, PinChannelCommandOutput } from "./commands/PinChannelCommand";
|
|
36
|
+
import { PinMessageCommandInput, PinMessageCommandOutput } from "./commands/PinMessageCommand";
|
|
35
37
|
import { ScheduleExternalFlagAdjustmentJobCommandInput, ScheduleExternalFlagAdjustmentJobCommandOutput } from "./commands/ScheduleExternalFlagAdjustmentJobCommand";
|
|
36
38
|
import { SendActionTriggerResultCommandInput, SendActionTriggerResultCommandOutput } from "./commands/SendActionTriggerResultCommand";
|
|
37
39
|
import { SendGiphyCommandInput, SendGiphyCommandOutput } from "./commands/SendGiphyCommand";
|
|
@@ -43,6 +45,7 @@ import { ShowChannelCommandInput, ShowChannelCommandOutput } from "./commands/Sh
|
|
|
43
45
|
import { TagChannelCommandInput, TagChannelCommandOutput } from "./commands/TagChannelCommand";
|
|
44
46
|
import { TriggerMessageActionCommandInput, TriggerMessageActionCommandOutput } from "./commands/TriggerMessageActionCommand";
|
|
45
47
|
import { UnpinChannelCommandInput, UnpinChannelCommandOutput } from "./commands/UnpinChannelCommand";
|
|
48
|
+
import { UnpinMessageCommandInput, UnpinMessageCommandOutput } from "./commands/UnpinMessageCommand";
|
|
46
49
|
import { UntagChannelCommandInput, UntagChannelCommandOutput } from "./commands/UntagChannelCommand";
|
|
47
50
|
import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
|
|
48
51
|
import { UpdateInboxTagCommandInput, UpdateInboxTagCommandOutput } from "./commands/UpdateInboxTagCommand";
|
|
@@ -59,11 +62,11 @@ export { __Client };
|
|
|
59
62
|
/**
|
|
60
63
|
* @public
|
|
61
64
|
*/
|
|
62
|
-
export type ServiceInputTypes = AddChannelMemberCommandInput | AddChannelMembersCommandInput | CreateGroupChannelCommandInput | CreateInboxTagCommandInput | DeleteChannelCommandInput | DeleteChannelMemberCommandInput | DeleteInboxTagCommandInput | DeleteMessageCommandInput | DeleteMessageReactionCommandInput | DescribeEventCommandInput | GetActionTriggerResultCommandInput | GetChannelCommandInput | GetChannelMemberCommandInput | GetDirectChannelIdCommandInput | GetFilePresignedDownloadUrlCommandInput | GetInboxStateCommandInput | GetMessageCommandInput | GetOrCreateDirectChannelCommandInput | GetUploadedFileInfoCommandInput | HideChannelCommandInput | InviteCommandInput | JoinChannelCommandInput | LeaveChannelCommandInput | ListChannelMembersCommandInput | ListChannelsCommandInput | ListInboxTaggedChannelsCommandInput | ListInboxTagsCommandInput | ListMessageReactionsCommandInput | ListMessagesCommandInput | MarkReadCommandInput | MarkUnreadCommandInput | PartialUpdateChannelCommandInput | PartialUpdateMessageCommandInput | PinChannelCommandInput | ScheduleExternalFlagAdjustmentJobCommandInput | SendActionTriggerResultCommandInput | SendGiphyCommandInput | SendMessageCommandInput | SendMessageReactionCommandInput | SendTypingStartCommandInput | SendTypingStopCommandInput | ShowChannelCommandInput | TagChannelCommandInput | TriggerMessageActionCommandInput | UnpinChannelCommandInput | UntagChannelCommandInput | UpdateChannelCommandInput | UpdateInboxTagCommandInput | UpdateMessageCommandInput | UploadFileCommandInput;
|
|
65
|
+
export type ServiceInputTypes = AddChannelMemberCommandInput | AddChannelMembersCommandInput | CreateGroupChannelCommandInput | CreateInboxTagCommandInput | DeleteChannelCommandInput | DeleteChannelMemberCommandInput | DeleteInboxTagCommandInput | DeleteMessageCommandInput | DeleteMessageReactionCommandInput | DescribeEventCommandInput | GetActionTriggerResultCommandInput | GetChannelCommandInput | GetChannelMemberCommandInput | GetDirectChannelIdCommandInput | GetFilePresignedDownloadUrlCommandInput | GetInboxStateCommandInput | GetMessageCommandInput | GetOrCreateDirectChannelCommandInput | GetUploadedFileInfoCommandInput | HideChannelCommandInput | InviteCommandInput | JoinChannelCommandInput | LeaveChannelCommandInput | ListChannelMembersCommandInput | ListChannelsCommandInput | ListInboxTaggedChannelsCommandInput | ListInboxTagsCommandInput | ListMessageReactionsCommandInput | ListMessagesCommandInput | ListPinnedMessagesCommandInput | MarkReadCommandInput | MarkUnreadCommandInput | PartialUpdateChannelCommandInput | PartialUpdateMessageCommandInput | PinChannelCommandInput | PinMessageCommandInput | ScheduleExternalFlagAdjustmentJobCommandInput | SendActionTriggerResultCommandInput | SendGiphyCommandInput | SendMessageCommandInput | SendMessageReactionCommandInput | SendTypingStartCommandInput | SendTypingStopCommandInput | ShowChannelCommandInput | TagChannelCommandInput | TriggerMessageActionCommandInput | UnpinChannelCommandInput | UnpinMessageCommandInput | UntagChannelCommandInput | UpdateChannelCommandInput | UpdateInboxTagCommandInput | UpdateMessageCommandInput | UploadFileCommandInput;
|
|
63
66
|
/**
|
|
64
67
|
* @public
|
|
65
68
|
*/
|
|
66
|
-
export type ServiceOutputTypes = AddChannelMemberCommandOutput | AddChannelMembersCommandOutput | CreateGroupChannelCommandOutput | CreateInboxTagCommandOutput | DeleteChannelCommandOutput | DeleteChannelMemberCommandOutput | DeleteInboxTagCommandOutput | DeleteMessageCommandOutput | DeleteMessageReactionCommandOutput | DescribeEventCommandOutput | GetActionTriggerResultCommandOutput | GetChannelCommandOutput | GetChannelMemberCommandOutput | GetDirectChannelIdCommandOutput | GetFilePresignedDownloadUrlCommandOutput | GetInboxStateCommandOutput | GetMessageCommandOutput | GetOrCreateDirectChannelCommandOutput | GetUploadedFileInfoCommandOutput | HideChannelCommandOutput | InviteCommandOutput | JoinChannelCommandOutput | LeaveChannelCommandOutput | ListChannelMembersCommandOutput | ListChannelsCommandOutput | ListInboxTaggedChannelsCommandOutput | ListInboxTagsCommandOutput | ListMessageReactionsCommandOutput | ListMessagesCommandOutput | MarkReadCommandOutput | MarkUnreadCommandOutput | PartialUpdateChannelCommandOutput | PartialUpdateMessageCommandOutput | PinChannelCommandOutput | ScheduleExternalFlagAdjustmentJobCommandOutput | SendActionTriggerResultCommandOutput | SendGiphyCommandOutput | SendMessageCommandOutput | SendMessageReactionCommandOutput | SendTypingStartCommandOutput | SendTypingStopCommandOutput | ShowChannelCommandOutput | TagChannelCommandOutput | TriggerMessageActionCommandOutput | UnpinChannelCommandOutput | UntagChannelCommandOutput | UpdateChannelCommandOutput | UpdateInboxTagCommandOutput | UpdateMessageCommandOutput | UploadFileCommandOutput;
|
|
69
|
+
export type ServiceOutputTypes = AddChannelMemberCommandOutput | AddChannelMembersCommandOutput | CreateGroupChannelCommandOutput | CreateInboxTagCommandOutput | DeleteChannelCommandOutput | DeleteChannelMemberCommandOutput | DeleteInboxTagCommandOutput | DeleteMessageCommandOutput | DeleteMessageReactionCommandOutput | DescribeEventCommandOutput | GetActionTriggerResultCommandOutput | GetChannelCommandOutput | GetChannelMemberCommandOutput | GetDirectChannelIdCommandOutput | GetFilePresignedDownloadUrlCommandOutput | GetInboxStateCommandOutput | GetMessageCommandOutput | GetOrCreateDirectChannelCommandOutput | GetUploadedFileInfoCommandOutput | HideChannelCommandOutput | InviteCommandOutput | JoinChannelCommandOutput | LeaveChannelCommandOutput | ListChannelMembersCommandOutput | ListChannelsCommandOutput | ListInboxTaggedChannelsCommandOutput | ListInboxTagsCommandOutput | ListMessageReactionsCommandOutput | ListMessagesCommandOutput | ListPinnedMessagesCommandOutput | MarkReadCommandOutput | MarkUnreadCommandOutput | PartialUpdateChannelCommandOutput | PartialUpdateMessageCommandOutput | PinChannelCommandOutput | PinMessageCommandOutput | ScheduleExternalFlagAdjustmentJobCommandOutput | SendActionTriggerResultCommandOutput | SendGiphyCommandOutput | SendMessageCommandOutput | SendMessageReactionCommandOutput | SendTypingStartCommandOutput | SendTypingStopCommandOutput | ShowChannelCommandOutput | TagChannelCommandOutput | TriggerMessageActionCommandOutput | UnpinChannelCommandOutput | UnpinMessageCommandOutput | UntagChannelCommandOutput | UpdateChannelCommandOutput | UpdateInboxTagCommandOutput | UpdateMessageCommandOutput | UploadFileCommandOutput;
|
|
67
70
|
/**
|
|
68
71
|
* @public
|
|
69
72
|
*/
|
|
@@ -0,0 +1,261 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { ListPinnedMessagesInput, ListPinnedMessagesOutput } 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 ListPinnedMessagesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListPinnedMessagesCommandInput extends ListPinnedMessagesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListPinnedMessagesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListPinnedMessagesCommandOutput extends ListPinnedMessagesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListPinnedMessagesCommand_base: {
|
|
25
|
+
new (input: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListPinnedMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPinnedMessagesCommandInput, ListPinnedMessagesCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves a list of pinned messages from a specified channel. Supports pagination through limit and offset parameters.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, ListPinnedMessagesCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, ListPinnedMessagesCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // ListPinnedMessagesInput
|
|
38
|
+
* channelId: "STRING_VALUE", // required
|
|
39
|
+
* limit: Number("int"),
|
|
40
|
+
* offset: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListPinnedMessagesCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListPinnedMessagesOutput
|
|
45
|
+
* // messages: [ // MessagesList // required
|
|
46
|
+
* // { // Message
|
|
47
|
+
* // text: "STRING_VALUE",
|
|
48
|
+
* // elements: [ // ElementsList
|
|
49
|
+
* // { // Element Union: only one key present
|
|
50
|
+
* // text: { // TextElement
|
|
51
|
+
* // value: "STRING_VALUE", // required
|
|
52
|
+
* // style: { // TextStyle
|
|
53
|
+
* // italic: true || false,
|
|
54
|
+
* // bold: true || false,
|
|
55
|
+
* // strike: true || false,
|
|
56
|
+
* // code: true || false,
|
|
57
|
+
* // },
|
|
58
|
+
* // },
|
|
59
|
+
* // link: { // LinkElement
|
|
60
|
+
* // url: "STRING_VALUE", // required
|
|
61
|
+
* // text: "STRING_VALUE",
|
|
62
|
+
* // style: {
|
|
63
|
+
* // italic: true || false,
|
|
64
|
+
* // bold: true || false,
|
|
65
|
+
* // strike: true || false,
|
|
66
|
+
* // code: true || false,
|
|
67
|
+
* // },
|
|
68
|
+
* // },
|
|
69
|
+
* // email: { // EmailElement
|
|
70
|
+
* // value: "STRING_VALUE", // required
|
|
71
|
+
* // style: {
|
|
72
|
+
* // italic: true || false,
|
|
73
|
+
* // bold: true || false,
|
|
74
|
+
* // strike: true || false,
|
|
75
|
+
* // code: true || false,
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // phone: { // PhoneElement
|
|
79
|
+
* // value: "STRING_VALUE", // required
|
|
80
|
+
* // style: {
|
|
81
|
+
* // italic: true || false,
|
|
82
|
+
* // bold: true || false,
|
|
83
|
+
* // strike: true || false,
|
|
84
|
+
* // code: true || false,
|
|
85
|
+
* // },
|
|
86
|
+
* // },
|
|
87
|
+
* // mention: { // MentionElement
|
|
88
|
+
* // text: "STRING_VALUE", // required
|
|
89
|
+
* // user: { // User
|
|
90
|
+
* // id: "STRING_VALUE", // required
|
|
91
|
+
* // name: "STRING_VALUE",
|
|
92
|
+
* // email: "STRING_VALUE",
|
|
93
|
+
* // phone: "STRING_VALUE",
|
|
94
|
+
* // picture: "STRING_VALUE",
|
|
95
|
+
* // locale: "STRING_VALUE",
|
|
96
|
+
* // timeZone: "STRING_VALUE",
|
|
97
|
+
* // company: "STRING_VALUE",
|
|
98
|
+
* // bot: true || false,
|
|
99
|
+
* // pbxDomain: "STRING_VALUE",
|
|
100
|
+
* // pbxPort: "STRING_VALUE",
|
|
101
|
+
* // pbxExtension: "STRING_VALUE",
|
|
102
|
+
* // pbxSerial: "STRING_VALUE",
|
|
103
|
+
* // pbxUserId: "STRING_VALUE",
|
|
104
|
+
* // createdAt: "STRING_VALUE",
|
|
105
|
+
* // updatedAt: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // actions: [ // ActionsElementsList
|
|
109
|
+
* // { // ActionElement Union: only one key present
|
|
110
|
+
* // button: { // ButtonElement
|
|
111
|
+
* // text: "STRING_VALUE", // required
|
|
112
|
+
* // variant: "contained" || "outlined",
|
|
113
|
+
* // disabled: true || false,
|
|
114
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
115
|
+
* // link: { // ButtonLinkHandler
|
|
116
|
+
* // url: "STRING_VALUE", // required
|
|
117
|
+
* // },
|
|
118
|
+
* // reply: { // ButtonReplyHandler
|
|
119
|
+
* // text: "STRING_VALUE",
|
|
120
|
+
* // },
|
|
121
|
+
* // action: { // ButtonActionHandler
|
|
122
|
+
* // id: "STRING_VALUE", // required
|
|
123
|
+
* // },
|
|
124
|
+
* // },
|
|
125
|
+
* // },
|
|
126
|
+
* // },
|
|
127
|
+
* // ],
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // attachments: [ // MessageAttachmentList
|
|
131
|
+
* // { // MessageAttachment
|
|
132
|
+
* // id: "STRING_VALUE", // required
|
|
133
|
+
* // fsId: "STRING_VALUE", // required
|
|
134
|
+
* // mime: "STRING_VALUE",
|
|
135
|
+
* // name: "STRING_VALUE", // required
|
|
136
|
+
* // size: Number("int"), // required
|
|
137
|
+
* // width: Number("int"),
|
|
138
|
+
* // height: Number("int"),
|
|
139
|
+
* // thumbnail: "STRING_VALUE",
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // quote: { // MessageQuote
|
|
143
|
+
* // messageId: "STRING_VALUE", // required
|
|
144
|
+
* // channelId: "STRING_VALUE", // required
|
|
145
|
+
* // user: {
|
|
146
|
+
* // id: "STRING_VALUE", // required
|
|
147
|
+
* // name: "STRING_VALUE",
|
|
148
|
+
* // email: "STRING_VALUE",
|
|
149
|
+
* // phone: "STRING_VALUE",
|
|
150
|
+
* // picture: "STRING_VALUE",
|
|
151
|
+
* // locale: "STRING_VALUE",
|
|
152
|
+
* // timeZone: "STRING_VALUE",
|
|
153
|
+
* // company: "STRING_VALUE",
|
|
154
|
+
* // bot: true || false,
|
|
155
|
+
* // pbxDomain: "STRING_VALUE",
|
|
156
|
+
* // pbxPort: "STRING_VALUE",
|
|
157
|
+
* // pbxExtension: "STRING_VALUE",
|
|
158
|
+
* // pbxSerial: "STRING_VALUE",
|
|
159
|
+
* // pbxUserId: "STRING_VALUE",
|
|
160
|
+
* // createdAt: "STRING_VALUE",
|
|
161
|
+
* // updatedAt: "STRING_VALUE",
|
|
162
|
+
* // },
|
|
163
|
+
* // text: "STRING_VALUE",
|
|
164
|
+
* // attachments: [
|
|
165
|
+
* // {
|
|
166
|
+
* // id: "STRING_VALUE", // required
|
|
167
|
+
* // fsId: "STRING_VALUE", // required
|
|
168
|
+
* // mime: "STRING_VALUE",
|
|
169
|
+
* // name: "STRING_VALUE", // required
|
|
170
|
+
* // size: Number("int"), // required
|
|
171
|
+
* // width: Number("int"),
|
|
172
|
+
* // height: Number("int"),
|
|
173
|
+
* // thumbnail: "STRING_VALUE",
|
|
174
|
+
* // },
|
|
175
|
+
* // ],
|
|
176
|
+
* // forward: { // MessageForward
|
|
177
|
+
* // forwardCompany: "STRING_VALUE",
|
|
178
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
179
|
+
* // forwardEmail: "STRING_VALUE",
|
|
180
|
+
* // forwardName: "STRING_VALUE",
|
|
181
|
+
* // },
|
|
182
|
+
* // mentions: [ // UsersList
|
|
183
|
+
* // "<User>",
|
|
184
|
+
* // ],
|
|
185
|
+
* // giphy: { // MessageGiphy
|
|
186
|
+
* // id: "STRING_VALUE", // required
|
|
187
|
+
* // size: "STRING_VALUE", // required
|
|
188
|
+
* // url: "STRING_VALUE", // required
|
|
189
|
+
* // height: "STRING_VALUE", // required
|
|
190
|
+
* // width: "STRING_VALUE", // required
|
|
191
|
+
* // },
|
|
192
|
+
* // createdAt: "STRING_VALUE", // required
|
|
193
|
+
* // updatedAt: "STRING_VALUE",
|
|
194
|
+
* // },
|
|
195
|
+
* // forward: {
|
|
196
|
+
* // forwardCompany: "STRING_VALUE",
|
|
197
|
+
* // forwardDate: "STRING_VALUE", // required
|
|
198
|
+
* // forwardEmail: "STRING_VALUE",
|
|
199
|
+
* // forwardName: "STRING_VALUE",
|
|
200
|
+
* // },
|
|
201
|
+
* // type: "regular" || "system", // required
|
|
202
|
+
* // giphy: {
|
|
203
|
+
* // id: "STRING_VALUE", // required
|
|
204
|
+
* // size: "STRING_VALUE", // required
|
|
205
|
+
* // url: "STRING_VALUE", // required
|
|
206
|
+
* // height: "STRING_VALUE", // required
|
|
207
|
+
* // width: "STRING_VALUE", // required
|
|
208
|
+
* // },
|
|
209
|
+
* // silent: true || false,
|
|
210
|
+
* // event: "STRING_VALUE",
|
|
211
|
+
* // sms: true || false,
|
|
212
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
213
|
+
* // whatsapp: true || false,
|
|
214
|
+
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
215
|
+
* // messageId: "STRING_VALUE", // required
|
|
216
|
+
* // channelId: "STRING_VALUE", // required
|
|
217
|
+
* // user: "<User>", // required
|
|
218
|
+
* // edit: true || false,
|
|
219
|
+
* // mentions: [
|
|
220
|
+
* // "<User>",
|
|
221
|
+
* // ],
|
|
222
|
+
* // latestReactions: [ // ReactionList
|
|
223
|
+
* // { // Reaction
|
|
224
|
+
* // type: "STRING_VALUE",
|
|
225
|
+
* // userId: "STRING_VALUE",
|
|
226
|
+
* // messageId: "STRING_VALUE",
|
|
227
|
+
* // user: "<User>",
|
|
228
|
+
* // },
|
|
229
|
+
* // ],
|
|
230
|
+
* // reactionCounts: { // ReactionCounts
|
|
231
|
+
* // "<keys>": Number("int"),
|
|
232
|
+
* // },
|
|
233
|
+
* // createdAt: "STRING_VALUE", // required
|
|
234
|
+
* // updatedAt: "STRING_VALUE",
|
|
235
|
+
* // },
|
|
236
|
+
* // ],
|
|
237
|
+
* // };
|
|
238
|
+
*
|
|
239
|
+
* ```
|
|
240
|
+
*
|
|
241
|
+
* @param ListPinnedMessagesCommandInput - {@link ListPinnedMessagesCommandInput}
|
|
242
|
+
* @returns {@link ListPinnedMessagesCommandOutput}
|
|
243
|
+
* @see {@link ListPinnedMessagesCommandInput} for command's `input` shape.
|
|
244
|
+
* @see {@link ListPinnedMessagesCommandOutput} for command's `response` shape.
|
|
245
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
246
|
+
*
|
|
247
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
248
|
+
*
|
|
249
|
+
* @throws {@link ValidationException} (client fault)
|
|
250
|
+
*
|
|
251
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
252
|
+
*
|
|
253
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
254
|
+
*
|
|
255
|
+
* @throws {@link ConversationsServiceException}
|
|
256
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
257
|
+
*
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
export declare class ListPinnedMessagesCommand extends ListPinnedMessagesCommand_base {
|
|
261
|
+
}
|
|
@@ -197,6 +197,7 @@ declare const PartialUpdateMessageCommand_base: {
|
|
|
197
197
|
* unset: [ // MessageUnsetFieldsList
|
|
198
198
|
* "text" || "attachments" || "quote" || "forward",
|
|
199
199
|
* ],
|
|
200
|
+
* silent: true || false,
|
|
200
201
|
* };
|
|
201
202
|
* const command = new PartialUpdateMessageCommand(input);
|
|
202
203
|
* const response = await client.send(command);
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { PinMessageInput, PinMessageOutput } 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 PinMessageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PinMessageCommandInput extends PinMessageInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PinMessageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PinMessageCommandOutput extends PinMessageOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PinMessageCommand_base: {
|
|
25
|
+
new (input: PinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<PinMessageCommandInput, PinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: PinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<PinMessageCommandInput, PinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Pins specified message in the message. This operation is idempotent, meaning that if the message is already pinned, no error will be thrown.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, PinMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, PinMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // PinMessageInput
|
|
38
|
+
* channelId: "STRING_VALUE", // required
|
|
39
|
+
* messageId: "STRING_VALUE", // required
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* expiresAfter: Number("int"),
|
|
42
|
+
* expiresTill: "STRING_VALUE",
|
|
43
|
+
* silent: true || false,
|
|
44
|
+
* };
|
|
45
|
+
* const command = new PinMessageCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // {};
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param PinMessageCommandInput - {@link PinMessageCommandInput}
|
|
52
|
+
* @returns {@link PinMessageCommandOutput}
|
|
53
|
+
* @see {@link PinMessageCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link PinMessageCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ValidationException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ConversationsServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class PinMessageCommand extends PinMessageCommand_base {
|
|
73
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { UnpinMessageInput, UnpinMessageOutput } 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 UnpinMessageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UnpinMessageCommandInput extends UnpinMessageInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UnpinMessageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UnpinMessageCommandOutput extends UnpinMessageOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UnpinMessageCommand_base: {
|
|
25
|
+
new (input: UnpinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinMessageCommandInput, UnpinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnpinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinMessageCommandInput, UnpinMessageCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Unpins the message that was previously pinned. This operation is idempotent, meaning that if the message is not pinned, no error will be thrown.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, UnpinMessageCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, UnpinMessageCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // UnpinMessageInput
|
|
38
|
+
* channelId: "STRING_VALUE", // required
|
|
39
|
+
* messageId: "STRING_VALUE", // required
|
|
40
|
+
* userId: "STRING_VALUE",
|
|
41
|
+
* silent: true || false,
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UnpinMessageCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // {};
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param UnpinMessageCommandInput - {@link UnpinMessageCommandInput}
|
|
50
|
+
* @returns {@link UnpinMessageCommandOutput}
|
|
51
|
+
* @see {@link UnpinMessageCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link UnpinMessageCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ConversationsServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
67
|
+
*
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
export declare class UnpinMessageCommand extends UnpinMessageCommand_base {
|
|
71
|
+
}
|
|
@@ -27,11 +27,13 @@ export * from "./ListInboxTaggedChannelsCommand";
|
|
|
27
27
|
export * from "./ListInboxTagsCommand";
|
|
28
28
|
export * from "./ListMessageReactionsCommand";
|
|
29
29
|
export * from "./ListMessagesCommand";
|
|
30
|
+
export * from "./ListPinnedMessagesCommand";
|
|
30
31
|
export * from "./MarkReadCommand";
|
|
31
32
|
export * from "./MarkUnreadCommand";
|
|
32
33
|
export * from "./PartialUpdateChannelCommand";
|
|
33
34
|
export * from "./PartialUpdateMessageCommand";
|
|
34
35
|
export * from "./PinChannelCommand";
|
|
36
|
+
export * from "./PinMessageCommand";
|
|
35
37
|
export * from "./ScheduleExternalFlagAdjustmentJobCommand";
|
|
36
38
|
export * from "./SendActionTriggerResultCommand";
|
|
37
39
|
export * from "./SendGiphyCommand";
|
|
@@ -43,6 +45,7 @@ export * from "./ShowChannelCommand";
|
|
|
43
45
|
export * from "./TagChannelCommand";
|
|
44
46
|
export * from "./TriggerMessageActionCommand";
|
|
45
47
|
export * from "./UnpinChannelCommand";
|
|
48
|
+
export * from "./UnpinMessageCommand";
|
|
46
49
|
export * from "./UntagChannelCommand";
|
|
47
50
|
export * from "./UpdateChannelCommand";
|
|
48
51
|
export * from "./UpdateInboxTagCommand";
|
|
@@ -1536,7 +1536,7 @@ export interface GetUploadedFileInfoInput {
|
|
|
1536
1536
|
* @public
|
|
1537
1537
|
*/
|
|
1538
1538
|
export interface GetUploadedFileInfoOutput {
|
|
1539
|
-
file
|
|
1539
|
+
file: MessageAttachment;
|
|
1540
1540
|
}
|
|
1541
1541
|
/**
|
|
1542
1542
|
* @public
|
|
@@ -1807,6 +1807,36 @@ export interface ListMessagesOutput {
|
|
|
1807
1807
|
*/
|
|
1808
1808
|
messages: (Message)[];
|
|
1809
1809
|
}
|
|
1810
|
+
/**
|
|
1811
|
+
* @public
|
|
1812
|
+
*/
|
|
1813
|
+
export interface ListPinnedMessagesInput {
|
|
1814
|
+
/**
|
|
1815
|
+
* The unique identifier of the channel from which to list messages.
|
|
1816
|
+
* @public
|
|
1817
|
+
*/
|
|
1818
|
+
channelId: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* The maximum number of pinned messages to return. The value must be between 1 and 100.
|
|
1821
|
+
* @public
|
|
1822
|
+
*/
|
|
1823
|
+
limit?: number;
|
|
1824
|
+
/**
|
|
1825
|
+
* The offset from which to start listing pinned messages. The value must be between 0 and 1000.
|
|
1826
|
+
* @public
|
|
1827
|
+
*/
|
|
1828
|
+
offset?: number;
|
|
1829
|
+
}
|
|
1830
|
+
/**
|
|
1831
|
+
* @public
|
|
1832
|
+
*/
|
|
1833
|
+
export interface ListPinnedMessagesOutput {
|
|
1834
|
+
/**
|
|
1835
|
+
* A list of pinned messages in the channel.
|
|
1836
|
+
* @public
|
|
1837
|
+
*/
|
|
1838
|
+
messages: (Message)[];
|
|
1839
|
+
}
|
|
1810
1840
|
/**
|
|
1811
1841
|
* @public
|
|
1812
1842
|
*/
|
|
@@ -2008,6 +2038,11 @@ export interface PartialUpdateMessageInput {
|
|
|
2008
2038
|
* @public
|
|
2009
2039
|
*/
|
|
2010
2040
|
unset?: (MessageUnsetFields)[];
|
|
2041
|
+
/**
|
|
2042
|
+
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2043
|
+
* @public
|
|
2044
|
+
*/
|
|
2045
|
+
silent?: boolean;
|
|
2011
2046
|
}
|
|
2012
2047
|
/**
|
|
2013
2048
|
* @public
|
|
@@ -2051,6 +2086,42 @@ export declare class PinnedChannelsLimitReachedException extends __BaseException
|
|
|
2051
2086
|
*/
|
|
2052
2087
|
constructor(opts: __ExceptionOptionType<PinnedChannelsLimitReachedException, __BaseException>);
|
|
2053
2088
|
}
|
|
2089
|
+
/**
|
|
2090
|
+
* @public
|
|
2091
|
+
*/
|
|
2092
|
+
export interface PinMessageInput {
|
|
2093
|
+
channelId: string;
|
|
2094
|
+
/**
|
|
2095
|
+
* The unique identifier of the message which should be pinned.
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
messageId: string;
|
|
2099
|
+
/**
|
|
2100
|
+
* The unique identifier of the user when a service token is used.
|
|
2101
|
+
* @public
|
|
2102
|
+
*/
|
|
2103
|
+
userId?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* The duration in seconds after which the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresTill` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresTill` will result in a validation error.
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
expiresAfter?: number;
|
|
2109
|
+
/**
|
|
2110
|
+
* The specific date and time (in ISO 8601 format) when the pinned message will be automatically unpinned. If neither `expiresAfter` nor `expiresTill` is provided, the message will remain pinned indefinitely. Providing both `expiresAfter` and `expiresTill` will result in a validation error.
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
expiresTill?: string;
|
|
2114
|
+
/**
|
|
2115
|
+
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2116
|
+
* @public
|
|
2117
|
+
*/
|
|
2118
|
+
silent?: boolean;
|
|
2119
|
+
}
|
|
2120
|
+
/**
|
|
2121
|
+
* @public
|
|
2122
|
+
*/
|
|
2123
|
+
export interface PinMessageOutput {
|
|
2124
|
+
}
|
|
2054
2125
|
/**
|
|
2055
2126
|
* @public
|
|
2056
2127
|
*/
|
|
@@ -2354,6 +2425,32 @@ export interface UnpinChannelInput {
|
|
|
2354
2425
|
*/
|
|
2355
2426
|
export interface UnpinChannelOutput {
|
|
2356
2427
|
}
|
|
2428
|
+
/**
|
|
2429
|
+
* @public
|
|
2430
|
+
*/
|
|
2431
|
+
export interface UnpinMessageInput {
|
|
2432
|
+
channelId: string;
|
|
2433
|
+
/**
|
|
2434
|
+
* The unique identifier of the message which should be unpinned.
|
|
2435
|
+
* @public
|
|
2436
|
+
*/
|
|
2437
|
+
messageId: string;
|
|
2438
|
+
/**
|
|
2439
|
+
* The unique identifier of the user when a service token is used.
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
userId?: string;
|
|
2443
|
+
/**
|
|
2444
|
+
* Set to true to suppress system messages generated by this operation. Defaults to false.
|
|
2445
|
+
* @public
|
|
2446
|
+
*/
|
|
2447
|
+
silent?: boolean;
|
|
2448
|
+
}
|
|
2449
|
+
/**
|
|
2450
|
+
* @public
|
|
2451
|
+
*/
|
|
2452
|
+
export interface UnpinMessageOutput {
|
|
2453
|
+
}
|
|
2357
2454
|
/**
|
|
2358
2455
|
* @public
|
|
2359
2456
|
*/
|
|
@@ -2490,6 +2587,11 @@ export interface UpdateMessageInput {
|
|
|
2490
2587
|
* @public
|
|
2491
2588
|
*/
|
|
2492
2589
|
mentions?: (string)[];
|
|
2590
|
+
/**
|
|
2591
|
+
* Set to true to suppress the updated indicator. Defaults to false.
|
|
2592
|
+
* @public
|
|
2593
|
+
*/
|
|
2594
|
+
silent?: boolean;
|
|
2493
2595
|
}
|
|
2494
2596
|
/**
|
|
2495
2597
|
* @public
|