@wildix/stream-client 0.0.4 → 0.0.6
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/StreamService.js +98 -6
- package/dist-cjs/commands/AddChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/AddChannelMembersCommand.js +21 -0
- package/dist-cjs/commands/AssignChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateGroupChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateKiteChannelCommand.js +21 -0
- package/dist-cjs/commands/CreateSectionCommand.js +21 -0
- package/dist-cjs/commands/DeleteChannelCommand.js +21 -0
- package/dist-cjs/commands/DeleteChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/DeleteMessageReactionCommand.js +21 -0
- package/dist-cjs/commands/DeleteSectionCommand.js +21 -0
- package/dist-cjs/commands/GetChannelCommand.js +21 -0
- package/dist-cjs/commands/GetChannelMemberCommand.js +21 -0
- package/dist-cjs/commands/GetDirectChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetFilePresignedDownloadUrlCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateDirectChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateSmsChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateTelephonyChannelCommand.js +21 -0
- package/dist-cjs/commands/GetOrCreateWhatsAppChannelCommand.js +21 -0
- package/dist-cjs/commands/GetSmsChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetTelephonyChannelIdCommand.js +21 -0
- package/dist-cjs/commands/GetTokenCommand.js +21 -0
- package/dist-cjs/commands/GetUploadedFileInfoCommand.js +21 -0
- package/dist-cjs/commands/GetWhatsAppChannelIdCommand.js +21 -0
- package/dist-cjs/commands/{AddReactionCommand.js → HideChannelCommand.js} +7 -7
- package/dist-cjs/commands/{EditMessageCommand.js → JoinChannelCommand.js} +7 -7
- package/dist-cjs/commands/LeaveChannelCommand.js +21 -0
- package/dist-cjs/commands/ListChannelMembersCommand.js +21 -0
- package/dist-cjs/commands/ListChannelMembersReadStatusCommand.js +21 -0
- package/dist-cjs/commands/MarkReadCommand.js +21 -0
- package/dist-cjs/commands/MarkUnreadCommand.js +21 -0
- package/dist-cjs/commands/MoveChannelToSectionCommand.js +21 -0
- package/dist-cjs/commands/MuteChannelCommand.js +21 -0
- package/dist-cjs/commands/PartialUpdateChannelCommand.js +21 -0
- package/dist-cjs/commands/PartialUpdateMessageCommand.js +21 -0
- package/dist-cjs/commands/PinChannelCommand.js +21 -0
- package/dist-cjs/commands/QueryChannelsCommand.js +21 -0
- package/dist-cjs/commands/RemoveChannelFromSectionCommand.js +21 -0
- package/dist-cjs/commands/RenameSectionCommand.js +21 -0
- package/dist-cjs/commands/SendGiphyCommand.js +21 -0
- package/dist-cjs/commands/SendMessageReactionCommand.js +21 -0
- package/dist-cjs/commands/SendSystemMessageCommand.js +21 -0
- package/dist-cjs/commands/SendTypingStartCommand.js +21 -0
- package/dist-cjs/commands/{RemoveReactionCommand.js → SendTypingStopCommand.js} +7 -7
- package/dist-cjs/commands/ShowChannelCommand.js +21 -0
- package/dist-cjs/commands/UnmuteChannelCommand.js +21 -0
- package/dist-cjs/commands/UnpinChannelCommand.js +21 -0
- package/dist-cjs/commands/UpdateChannelCommand.js +21 -0
- package/dist-cjs/commands/UpdateMessageCommand.js +21 -0
- package/dist-cjs/commands/UploadFileCommand.js +21 -0
- package/dist-cjs/commands/index.js +49 -3
- package/dist-cjs/models/models_0.js +255 -49
- package/dist-cjs/protocols/Aws_restJson1.js +1954 -130
- package/dist-es/StreamService.js +98 -6
- package/dist-es/commands/AddChannelMemberCommand.js +17 -0
- package/dist-es/commands/AddChannelMembersCommand.js +17 -0
- package/dist-es/commands/AssignChannelCommand.js +17 -0
- package/dist-es/commands/CreateGroupChannelCommand.js +17 -0
- package/dist-es/commands/CreateKiteChannelCommand.js +17 -0
- package/dist-es/commands/CreateSectionCommand.js +17 -0
- package/dist-es/commands/DeleteChannelCommand.js +17 -0
- package/dist-es/commands/DeleteChannelMemberCommand.js +17 -0
- package/dist-es/commands/DeleteMessageReactionCommand.js +17 -0
- package/dist-es/commands/DeleteSectionCommand.js +17 -0
- package/dist-es/commands/GetChannelCommand.js +17 -0
- package/dist-es/commands/GetChannelMemberCommand.js +17 -0
- package/dist-es/commands/GetDirectChannelIdCommand.js +17 -0
- package/dist-es/commands/GetFilePresignedDownloadUrlCommand.js +17 -0
- package/dist-es/commands/GetOrCreateDirectChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateSmsChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateTelephonyChannelCommand.js +17 -0
- package/dist-es/commands/GetOrCreateWhatsAppChannelCommand.js +17 -0
- package/dist-es/commands/GetSmsChannelIdCommand.js +17 -0
- package/dist-es/commands/GetTelephonyChannelIdCommand.js +17 -0
- package/dist-es/commands/GetTokenCommand.js +17 -0
- package/dist-es/commands/GetUploadedFileInfoCommand.js +17 -0
- package/dist-es/commands/GetWhatsAppChannelIdCommand.js +17 -0
- package/dist-es/commands/{EditMessageCommand.js → HideChannelCommand.js} +6 -6
- package/dist-es/commands/{AddReactionCommand.js → JoinChannelCommand.js} +6 -6
- package/dist-es/commands/LeaveChannelCommand.js +17 -0
- package/dist-es/commands/ListChannelMembersCommand.js +17 -0
- package/dist-es/commands/ListChannelMembersReadStatusCommand.js +17 -0
- package/dist-es/commands/MarkReadCommand.js +17 -0
- package/dist-es/commands/MarkUnreadCommand.js +17 -0
- package/dist-es/commands/MoveChannelToSectionCommand.js +17 -0
- package/dist-es/commands/MuteChannelCommand.js +17 -0
- package/dist-es/commands/PartialUpdateChannelCommand.js +17 -0
- package/dist-es/commands/PartialUpdateMessageCommand.js +17 -0
- package/dist-es/commands/PinChannelCommand.js +17 -0
- package/dist-es/commands/QueryChannelsCommand.js +17 -0
- package/dist-es/commands/RemoveChannelFromSectionCommand.js +17 -0
- package/dist-es/commands/RenameSectionCommand.js +17 -0
- package/dist-es/commands/SendGiphyCommand.js +17 -0
- package/dist-es/commands/SendMessageReactionCommand.js +17 -0
- package/dist-es/commands/SendSystemMessageCommand.js +17 -0
- package/dist-es/commands/SendTypingStartCommand.js +17 -0
- package/dist-es/commands/{RemoveReactionCommand.js → SendTypingStopCommand.js} +6 -6
- package/dist-es/commands/ShowChannelCommand.js +17 -0
- package/dist-es/commands/UnmuteChannelCommand.js +17 -0
- package/dist-es/commands/UnpinChannelCommand.js +17 -0
- package/dist-es/commands/UpdateChannelCommand.js +17 -0
- package/dist-es/commands/UpdateMessageCommand.js +17 -0
- package/dist-es/commands/UploadFileCommand.js +17 -0
- package/dist-es/commands/index.js +49 -3
- package/dist-es/models/models_0.js +243 -46
- package/dist-es/protocols/Aws_restJson1.js +1842 -112
- package/dist-types/StreamService.d.ts +341 -15
- package/dist-types/StreamServiceClient.d.ts +51 -5
- package/dist-types/commands/AddChannelMemberCommand.d.ts +101 -0
- package/dist-types/commands/AddChannelMembersCommand.d.ts +108 -0
- package/dist-types/commands/AssignChannelCommand.d.ts +96 -0
- package/dist-types/commands/CreateGroupChannelCommand.d.ts +201 -0
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +291 -0
- package/dist-types/commands/CreateSectionCommand.d.ts +96 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +82 -0
- package/dist-types/commands/DeleteChannelMemberCommand.d.ts +88 -0
- package/dist-types/commands/DeleteMessageCommand.d.ts +1 -1
- package/dist-types/commands/{RemoveReactionCommand.d.ts → DeleteMessageReactionCommand.d.ts} +27 -28
- package/dist-types/commands/DeleteSectionCommand.d.ts +84 -0
- package/dist-types/commands/GetChannelCommand.d.ts +150 -0
- package/dist-types/commands/GetChannelMemberCommand.d.ts +93 -0
- package/dist-types/commands/GetDirectChannelIdCommand.d.ts +90 -0
- package/dist-types/commands/GetFilePresignedDownloadUrlCommand.d.ts +94 -0
- package/dist-types/commands/GetInboxCommand.d.ts +35 -35
- package/dist-types/commands/GetMessageCommand.d.ts +5 -6
- package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +154 -0
- package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +150 -0
- package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +151 -0
- package/dist-types/commands/GetSmsChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/GetTelephonyChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/GetTokenCommand.d.ts +85 -0
- package/dist-types/commands/GetUploadedFileInfoCommand.d.ts +98 -0
- package/dist-types/commands/GetWhatsAppChannelIdCommand.d.ts +86 -0
- package/dist-types/commands/HideChannelCommand.d.ts +84 -0
- package/dist-types/commands/JoinChannelCommand.d.ts +151 -0
- package/dist-types/commands/LeaveChannelCommand.d.ts +85 -0
- package/dist-types/commands/ListChannelMembersCommand.d.ts +94 -0
- package/dist-types/commands/ListChannelMembersReadStatusCommand.d.ts +92 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +35 -35
- package/dist-types/commands/ListMentionsCommand.d.ts +6 -7
- package/dist-types/commands/ListMessagesCommand.d.ts +5 -6
- package/dist-types/commands/MarkReadCommand.d.ts +99 -0
- package/dist-types/commands/MarkUnreadCommand.d.ts +103 -0
- package/dist-types/commands/MoveChannelToSectionCommand.d.ts +101 -0
- package/dist-types/commands/MuteChannelCommand.d.ts +99 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +195 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +261 -0
- package/dist-types/commands/PinChannelCommand.d.ts +87 -0
- package/dist-types/commands/PinMessageCommand.d.ts +5 -6
- package/dist-types/commands/QueryChannelsCommand.d.ts +167 -0
- package/dist-types/commands/RemoveChannelFromSectionCommand.d.ts +101 -0
- package/dist-types/commands/RenameSectionCommand.d.ts +98 -0
- package/dist-types/commands/{EditMessageCommand.d.ts → SendGiphyCommand.d.ts} +41 -42
- package/dist-types/commands/SendMessageCommand.d.ts +53 -13
- package/dist-types/commands/{AddReactionCommand.d.ts → SendMessageReactionCommand.d.ts} +28 -29
- package/dist-types/commands/SendSystemMessageCommand.d.ts +199 -0
- package/dist-types/commands/SendTypingStartCommand.d.ts +84 -0
- package/dist-types/commands/SendTypingStopCommand.d.ts +84 -0
- package/dist-types/commands/ShowChannelCommand.d.ts +84 -0
- package/dist-types/commands/UnmuteChannelCommand.d.ts +98 -0
- package/dist-types/commands/UnpinChannelCommand.d.ts +84 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +5 -6
- package/dist-types/commands/UpdateChannelCommand.d.ts +190 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +256 -0
- package/dist-types/commands/UploadFileCommand.d.ts +94 -0
- package/dist-types/commands/index.d.ts +49 -3
- package/dist-types/models/models_0.d.ts +3077 -563
- package/dist-types/protocols/Aws_restJson1.d.ts +429 -15
- package/package.json +1 -1
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { SendSystemMessageInput, SendSystemMessageOutput } 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 SendSystemMessageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendSystemMessageCommandInput extends SendSystemMessageInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendSystemMessageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendSystemMessageCommandOutput extends SendSystemMessageOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendSystemMessageCommand_base: {
|
|
25
|
+
new (input: SendSystemMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendSystemMessageCommandInput, SendSystemMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SendSystemMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendSystemMessageCommandInput, SendSystemMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Persists a backend-generated system message to a channel. Available with S2S authorization only. Each `message` variant maps to a server-side template; optional `event` carries a client rendering hint.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, SendSystemMessageCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, SendSystemMessageCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // SendSystemMessageInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* message: { // SystemMessage Union: only one key present
|
|
42
|
+
* whatsAppClosed: {},
|
|
43
|
+
* multipleMembersJoined: { // MultipleMembersJoinedSystemMessage
|
|
44
|
+
* addedMembers: [ // UserIdList // required
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* },
|
|
48
|
+
* },
|
|
49
|
+
* event: "STRING_VALUE",
|
|
50
|
+
* silent: true || false,
|
|
51
|
+
* };
|
|
52
|
+
* const command = new SendSystemMessageCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* // { // SendSystemMessageOutput
|
|
55
|
+
* // message: { // Message
|
|
56
|
+
* // messageId: "STRING_VALUE", // required
|
|
57
|
+
* // userId: "STRING_VALUE", // required
|
|
58
|
+
* // messageType: "regular" || "system" || "deleted", // required
|
|
59
|
+
* // text: "STRING_VALUE",
|
|
60
|
+
* // attachments: [ // MessageAttachmentList // required
|
|
61
|
+
* // { // MessageAttachment
|
|
62
|
+
* // fsId: "STRING_VALUE", // required
|
|
63
|
+
* // mime: "STRING_VALUE",
|
|
64
|
+
* // name: "STRING_VALUE", // required
|
|
65
|
+
* // size: Number("long"), // required
|
|
66
|
+
* // width: Number("int"),
|
|
67
|
+
* // height: Number("int"),
|
|
68
|
+
* // thumbnail: "STRING_VALUE",
|
|
69
|
+
* // id: "STRING_VALUE", // required
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // mentions: [ // UserIdList // required
|
|
73
|
+
* // "STRING_VALUE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // quote: { // MessageQuote
|
|
76
|
+
* // channelId: "STRING_VALUE", // required
|
|
77
|
+
* // messageId: "STRING_VALUE", // required
|
|
78
|
+
* // userId: "STRING_VALUE", // required
|
|
79
|
+
* // text: "STRING_VALUE",
|
|
80
|
+
* // createdAt: "STRING_VALUE", // required
|
|
81
|
+
* // },
|
|
82
|
+
* // forward: { // MessageForward
|
|
83
|
+
* // channelId: "STRING_VALUE", // required
|
|
84
|
+
* // messageId: "STRING_VALUE", // required
|
|
85
|
+
* // userId: "STRING_VALUE", // required
|
|
86
|
+
* // forwardedAt: "STRING_VALUE", // required
|
|
87
|
+
* // },
|
|
88
|
+
* // reactionCounts: { // ReactionCounts // required
|
|
89
|
+
* // "<keys>": Number("int"),
|
|
90
|
+
* // },
|
|
91
|
+
* // latestReactions: [ // ReactionList
|
|
92
|
+
* // { // Reaction
|
|
93
|
+
* // type: "STRING_VALUE", // required
|
|
94
|
+
* // userId: "STRING_VALUE", // required
|
|
95
|
+
* // messageId: "STRING_VALUE", // required
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // pinned: true || false, // required
|
|
99
|
+
* // pinnedAt: "STRING_VALUE",
|
|
100
|
+
* // pinnedBy: "STRING_VALUE",
|
|
101
|
+
* // system: true || false, // required
|
|
102
|
+
* // timelineSeq: Number("long"), // required
|
|
103
|
+
* // visibleSeq: Number("long"), // required
|
|
104
|
+
* // channelVersion: Number("long"), // required
|
|
105
|
+
* // messageVersion: Number("long"), // required
|
|
106
|
+
* // createdAt: "STRING_VALUE", // required
|
|
107
|
+
* // editedAt: "STRING_VALUE",
|
|
108
|
+
* // deletedAt: "STRING_VALUE",
|
|
109
|
+
* // elements: [ // ElementsList
|
|
110
|
+
* // { // Element Union: only one key present
|
|
111
|
+
* // template: { // MessageTemplateConfig
|
|
112
|
+
* // whatsapp: { // TemplateWithParameters
|
|
113
|
+
* // name: "STRING_VALUE", // required
|
|
114
|
+
* // parameters: [ // ListTemplateParameter
|
|
115
|
+
* // { // TemplateParameter
|
|
116
|
+
* // name: "STRING_VALUE", // required
|
|
117
|
+
* // value: "STRING_VALUE", // required
|
|
118
|
+
* // },
|
|
119
|
+
* // ],
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // actions: [ // ActionsElementsList
|
|
123
|
+
* // { // ActionElement Union: only one key present
|
|
124
|
+
* // button: { // ButtonElement
|
|
125
|
+
* // text: "STRING_VALUE", // required
|
|
126
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
127
|
+
* // link: { // ButtonLinkHandler
|
|
128
|
+
* // url: "STRING_VALUE", // required
|
|
129
|
+
* // },
|
|
130
|
+
* // reply: { // ButtonReplyHandler
|
|
131
|
+
* // text: "STRING_VALUE",
|
|
132
|
+
* // },
|
|
133
|
+
* // action: { // ButtonActionHandler
|
|
134
|
+
* // id: "STRING_VALUE", // required
|
|
135
|
+
* // },
|
|
136
|
+
* // },
|
|
137
|
+
* // variant: "contained" || "outlined",
|
|
138
|
+
* // disabled: true || false,
|
|
139
|
+
* // },
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // },
|
|
143
|
+
* // ],
|
|
144
|
+
* // whatsapp: true || false,
|
|
145
|
+
* // whatsappStatus: "trying" || "sent" || "delivered" || "error",
|
|
146
|
+
* // sms: true || false,
|
|
147
|
+
* // smsStatus: "sent" || "delivered" || "trying" || "error",
|
|
148
|
+
* // markdown: true || false,
|
|
149
|
+
* // giphy: { // MessageGiphy
|
|
150
|
+
* // id: "STRING_VALUE", // required
|
|
151
|
+
* // size: "STRING_VALUE", // required
|
|
152
|
+
* // url: "STRING_VALUE", // required
|
|
153
|
+
* // height: "STRING_VALUE", // required
|
|
154
|
+
* // width: "STRING_VALUE", // required
|
|
155
|
+
* // },
|
|
156
|
+
* // silent: true || false,
|
|
157
|
+
* // event: "STRING_VALUE",
|
|
158
|
+
* // },
|
|
159
|
+
* // };
|
|
160
|
+
*
|
|
161
|
+
* ```
|
|
162
|
+
*
|
|
163
|
+
* @param SendSystemMessageCommandInput - {@link SendSystemMessageCommandInput}
|
|
164
|
+
* @returns {@link SendSystemMessageCommandOutput}
|
|
165
|
+
* @see {@link SendSystemMessageCommandInput} for command's `input` shape.
|
|
166
|
+
* @see {@link SendSystemMessageCommandOutput} for command's `response` shape.
|
|
167
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
168
|
+
*
|
|
169
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
170
|
+
*
|
|
171
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
174
|
+
*
|
|
175
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
176
|
+
*
|
|
177
|
+
* @throws {@link ValidationException} (client fault)
|
|
178
|
+
*
|
|
179
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
180
|
+
*
|
|
181
|
+
* @throws {@link StreamServiceServiceException}
|
|
182
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
183
|
+
*
|
|
184
|
+
*
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
export declare class SendSystemMessageCommand extends SendSystemMessageCommand_base {
|
|
188
|
+
/** @internal type navigation helper, not in runtime. */
|
|
189
|
+
protected static __types: {
|
|
190
|
+
api: {
|
|
191
|
+
input: SendSystemMessageInput;
|
|
192
|
+
output: SendSystemMessageOutput;
|
|
193
|
+
};
|
|
194
|
+
sdk: {
|
|
195
|
+
input: SendSystemMessageCommandInput;
|
|
196
|
+
output: SendSystemMessageCommandOutput;
|
|
197
|
+
};
|
|
198
|
+
};
|
|
199
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { SendTypingStartInput, SendTypingStartOutput } 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 SendTypingStartCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendTypingStartCommandInput extends SendTypingStartInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendTypingStartCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendTypingStartCommandOutput extends SendTypingStartOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendTypingStartCommand_base: {
|
|
25
|
+
new (input: SendTypingStartCommandInput): import("@smithy/smithy-client").CommandImpl<SendTypingStartCommandInput, SendTypingStartCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SendTypingStartCommandInput): import("@smithy/smithy-client").CommandImpl<SendTypingStartCommandInput, SendTypingStartCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Broadcasts a typing-start indicator for the current user in a channel.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, SendTypingStartCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, SendTypingStartCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // SendTypingStartInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new SendTypingStartCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param SendTypingStartCommandInput - {@link SendTypingStartCommandInput}
|
|
49
|
+
* @returns {@link SendTypingStartCommandOutput}
|
|
50
|
+
* @see {@link SendTypingStartCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link SendTypingStartCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link StreamServiceServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class SendTypingStartCommand extends SendTypingStartCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: SendTypingStartInput;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: SendTypingStartCommandInput;
|
|
81
|
+
output: SendTypingStartCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { SendTypingStopInput, SendTypingStopOutput } 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 SendTypingStopCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendTypingStopCommandInput extends SendTypingStopInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendTypingStopCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendTypingStopCommandOutput extends SendTypingStopOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendTypingStopCommand_base: {
|
|
25
|
+
new (input: SendTypingStopCommandInput): import("@smithy/smithy-client").CommandImpl<SendTypingStopCommandInput, SendTypingStopCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SendTypingStopCommandInput): import("@smithy/smithy-client").CommandImpl<SendTypingStopCommandInput, SendTypingStopCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Broadcasts a typing-stop indicator for the current user in a channel.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, SendTypingStopCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, SendTypingStopCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // SendTypingStopInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new SendTypingStopCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param SendTypingStopCommandInput - {@link SendTypingStopCommandInput}
|
|
49
|
+
* @returns {@link SendTypingStopCommandOutput}
|
|
50
|
+
* @see {@link SendTypingStopCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link SendTypingStopCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link StreamServiceServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class SendTypingStopCommand extends SendTypingStopCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: SendTypingStopInput;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: SendTypingStopCommandInput;
|
|
81
|
+
output: SendTypingStopCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { ShowChannelInput, ShowChannelOutput } 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 ShowChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ShowChannelCommandInput extends ShowChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ShowChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ShowChannelCommandOutput extends ShowChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ShowChannelCommand_base: {
|
|
25
|
+
new (input: ShowChannelCommandInput): import("@smithy/smithy-client").CommandImpl<ShowChannelCommandInput, ShowChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ShowChannelCommandInput): import("@smithy/smithy-client").CommandImpl<ShowChannelCommandInput, ShowChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Restores a hidden channel for the current user.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, ShowChannelCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, ShowChannelCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // ShowChannelInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ShowChannelCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param ShowChannelCommandInput - {@link ShowChannelCommandInput}
|
|
49
|
+
* @returns {@link ShowChannelCommandOutput}
|
|
50
|
+
* @see {@link ShowChannelCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link ShowChannelCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link StreamServiceServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class ShowChannelCommand extends ShowChannelCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: ShowChannelInput;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: ShowChannelCommandInput;
|
|
81
|
+
output: ShowChannelCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { UnmuteChannelInput, UnmuteChannelOutput } 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 UnmuteChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UnmuteChannelCommandInput extends UnmuteChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UnmuteChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UnmuteChannelCommandOutput extends UnmuteChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UnmuteChannelCommand_base: {
|
|
25
|
+
new (input: UnmuteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnmuteChannelCommandInput, UnmuteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnmuteChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnmuteChannelCommandInput, UnmuteChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Unmutes a channel for the current user.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, UnmuteChannelCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, UnmuteChannelCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // UnmuteChannelInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UnmuteChannelCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // UnmuteChannelOutput
|
|
45
|
+
* // inbox: { // InboxState
|
|
46
|
+
* // sectionIds: [ // SectionIdList // required
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // unreadCount: Number("int"), // required
|
|
50
|
+
* // mentionUnreadCount: Number("int"), // required
|
|
51
|
+
* // lastReadVisibleSeq: Number("long"),
|
|
52
|
+
* // lastReadAt: "STRING_VALUE",
|
|
53
|
+
* // hidden: true || false, // required
|
|
54
|
+
* // muted: true || false, // required
|
|
55
|
+
* // mutedUntil: "STRING_VALUE",
|
|
56
|
+
* // unreadMarkAt: Number("long"),
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @param UnmuteChannelCommandInput - {@link UnmuteChannelCommandInput}
|
|
63
|
+
* @returns {@link UnmuteChannelCommandOutput}
|
|
64
|
+
* @see {@link UnmuteChannelCommandInput} for command's `input` shape.
|
|
65
|
+
* @see {@link UnmuteChannelCommandOutput} for command's `response` shape.
|
|
66
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link StreamServiceServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class UnmuteChannelCommand extends UnmuteChannelCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: UnmuteChannelInput;
|
|
91
|
+
output: UnmuteChannelOutput;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: UnmuteChannelCommandInput;
|
|
95
|
+
output: UnmuteChannelCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { UnpinChannelInput, UnpinChannelOutput } 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 UnpinChannelCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UnpinChannelCommandInput extends UnpinChannelInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UnpinChannelCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UnpinChannelCommandOutput extends UnpinChannelOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UnpinChannelCommand_base: {
|
|
25
|
+
new (input: UnpinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinChannelCommandInput, UnpinChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnpinChannelCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinChannelCommandInput, UnpinChannelCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Unpins a channel in the current user's inbox.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, UnpinChannelCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, UnpinChannelCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // UnpinChannelInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UnpinChannelCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param UnpinChannelCommandInput - {@link UnpinChannelCommandInput}
|
|
49
|
+
* @returns {@link UnpinChannelCommandOutput}
|
|
50
|
+
* @see {@link UnpinChannelCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link UnpinChannelCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ValidationException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link StreamServiceServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class UnpinChannelCommand extends UnpinChannelCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: UnpinChannelInput;
|
|
77
|
+
output: {};
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: UnpinChannelCommandInput;
|
|
81
|
+
output: UnpinChannelCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -46,7 +46,7 @@ declare const UnpinMessageCommand_base: {
|
|
|
46
46
|
* // message: { // Message
|
|
47
47
|
* // messageId: "STRING_VALUE", // required
|
|
48
48
|
* // userId: "STRING_VALUE", // required
|
|
49
|
-
* // messageType: "regular" || "system", // required
|
|
49
|
+
* // messageType: "regular" || "system" || "deleted", // required
|
|
50
50
|
* // text: "STRING_VALUE",
|
|
51
51
|
* // attachments: [ // MessageAttachmentList // required
|
|
52
52
|
* // { // MessageAttachment
|
|
@@ -81,10 +81,9 @@ declare const UnpinMessageCommand_base: {
|
|
|
81
81
|
* // },
|
|
82
82
|
* // latestReactions: [ // ReactionList
|
|
83
83
|
* // { // Reaction
|
|
84
|
-
* // type: "STRING_VALUE",
|
|
85
|
-
* // userId: "STRING_VALUE",
|
|
86
|
-
* // messageId: "STRING_VALUE",
|
|
87
|
-
* // user: "STRING_VALUE",
|
|
84
|
+
* // type: "STRING_VALUE", // required
|
|
85
|
+
* // userId: "STRING_VALUE", // required
|
|
86
|
+
* // messageId: "STRING_VALUE", // required
|
|
88
87
|
* // },
|
|
89
88
|
* // ],
|
|
90
89
|
* // pinned: true || false, // required
|
|
@@ -162,7 +161,7 @@ declare const UnpinMessageCommand_base: {
|
|
|
162
161
|
*
|
|
163
162
|
* @throws {@link MessageNotFoundException} (client fault)
|
|
164
163
|
*
|
|
165
|
-
* @throws {@link
|
|
164
|
+
* @throws {@link StreamServiceException} (server fault)
|
|
166
165
|
*
|
|
167
166
|
* @throws {@link UnauthorizedException} (client fault)
|
|
168
167
|
*
|