@wildix/xbees-conversations-client 1.1.0 → 1.1.2
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 +14 -0
- package/dist-cjs/commands/CreateKiteChannelCommand.js +21 -0
- package/dist-cjs/commands/GetActionTriggerResultCommand.js +21 -0
- package/dist-cjs/commands/ListPinnedMessagesCommand.js +21 -0
- package/dist-cjs/commands/PinMessageCommand.js +21 -0
- package/dist-cjs/commands/SendActionTriggerResultCommand.js +21 -0
- package/dist-cjs/commands/TriggerMessageActionCommand.js +21 -0
- package/dist-cjs/commands/UnpinMessageCommand.js +21 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +107 -12
- package/dist-cjs/protocols/Aws_restJson1.js +302 -2
- package/dist-es/Conversations.js +14 -0
- package/dist-es/commands/CreateKiteChannelCommand.js +17 -0
- package/dist-es/commands/GetActionTriggerResultCommand.js +17 -0
- package/dist-es/commands/ListPinnedMessagesCommand.js +17 -0
- package/dist-es/commands/PinMessageCommand.js +17 -0
- package/dist-es/commands/SendActionTriggerResultCommand.js +17 -0
- package/dist-es/commands/TriggerMessageActionCommand.js +17 -0
- package/dist-es/commands/UnpinMessageCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +102 -11
- package/dist-es/protocols/Aws_restJson1.js +286 -1
- package/dist-types/Conversations.d.ts +49 -0
- package/dist-types/ConversationsClient.d.ts +9 -2
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +240 -0
- package/dist-types/commands/DescribeEventCommand.d.ts +144 -9
- package/dist-types/commands/GetActionTriggerResultCommand.d.ts +70 -0
- package/dist-types/commands/GetMessageCommand.d.ts +24 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +24 -0
- package/dist-types/commands/ListPinnedMessagesCommand.d.ts +224 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +53 -1
- package/dist-types/commands/PinMessageCommand.d.ts +73 -0
- package/dist-types/commands/SendActionTriggerResultCommand.d.ts +68 -0
- package/dist-types/commands/SendGiphyCommand.d.ts +24 -0
- package/dist-types/commands/SendMessageCommand.d.ts +48 -0
- package/dist-types/commands/TriggerMessageActionCommand.d.ts +75 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +71 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +49 -0
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +578 -102
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -0
- package/dist-types/runtimeConfig.d.ts +1 -0
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/package.json +1 -1
|
@@ -40,6 +40,30 @@ declare const PartialUpdateMessageCommand_base: {
|
|
|
40
40
|
* userId: "STRING_VALUE",
|
|
41
41
|
* set: { // PartialUpdateMessageSetInput
|
|
42
42
|
* text: "STRING_VALUE",
|
|
43
|
+
* elements: [ // ElementsList
|
|
44
|
+
* { // Element Union: only one key present
|
|
45
|
+
* actions: [ // ActionsElementsList
|
|
46
|
+
* { // ActionElement Union: only one key present
|
|
47
|
+
* button: { // ButtonElement
|
|
48
|
+
* text: "STRING_VALUE", // required
|
|
49
|
+
* variant: "contained" || "outlined",
|
|
50
|
+
* disabled: true || false,
|
|
51
|
+
* handler: { // ButtonHandler Union: only one key present
|
|
52
|
+
* link: { // ButtonLinkHandler
|
|
53
|
+
* url: "STRING_VALUE", // required
|
|
54
|
+
* },
|
|
55
|
+
* reply: { // ButtonReplyHandler
|
|
56
|
+
* text: "STRING_VALUE",
|
|
57
|
+
* },
|
|
58
|
+
* action: { // ButtonActionHandler
|
|
59
|
+
* id: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
61
|
+
* },
|
|
62
|
+
* },
|
|
63
|
+
* },
|
|
64
|
+
* ],
|
|
65
|
+
* },
|
|
66
|
+
* ],
|
|
43
67
|
* attachments: [ // MessageAttachmentList
|
|
44
68
|
* { // MessageAttachment
|
|
45
69
|
* id: "STRING_VALUE", // required
|
|
@@ -132,16 +156,44 @@ declare const PartialUpdateMessageCommand_base: {
|
|
|
132
156
|
* messageId: "STRING_VALUE", // required
|
|
133
157
|
* channelId: "STRING_VALUE", // required
|
|
134
158
|
* },
|
|
159
|
+
* mentions: [ // UsersIdList
|
|
160
|
+
* "STRING_VALUE",
|
|
161
|
+
* ],
|
|
135
162
|
* },
|
|
136
163
|
* unset: [ // MessageUnsetFieldsList
|
|
137
|
-
* "text" || "attachments" || "quote" || "forward",
|
|
164
|
+
* "text" || "mentions" || "elements" || "attachments" || "quote" || "forward",
|
|
138
165
|
* ],
|
|
166
|
+
* silent: true || false,
|
|
139
167
|
* };
|
|
140
168
|
* const command = new PartialUpdateMessageCommand(input);
|
|
141
169
|
* const response = await client.send(command);
|
|
142
170
|
* // { // PartialUpdateMessageOutput
|
|
143
171
|
* // message: { // Message
|
|
144
172
|
* // text: "STRING_VALUE",
|
|
173
|
+
* // elements: [ // ElementsList
|
|
174
|
+
* // { // Element Union: only one key present
|
|
175
|
+
* // actions: [ // ActionsElementsList
|
|
176
|
+
* // { // ActionElement Union: only one key present
|
|
177
|
+
* // button: { // ButtonElement
|
|
178
|
+
* // text: "STRING_VALUE", // required
|
|
179
|
+
* // variant: "contained" || "outlined",
|
|
180
|
+
* // disabled: true || false,
|
|
181
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
182
|
+
* // link: { // ButtonLinkHandler
|
|
183
|
+
* // url: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // reply: { // ButtonReplyHandler
|
|
186
|
+
* // text: "STRING_VALUE",
|
|
187
|
+
* // },
|
|
188
|
+
* // action: { // ButtonActionHandler
|
|
189
|
+
* // id: "STRING_VALUE", // required
|
|
190
|
+
* // },
|
|
191
|
+
* // },
|
|
192
|
+
* // },
|
|
193
|
+
* // },
|
|
194
|
+
* // ],
|
|
195
|
+
* // },
|
|
196
|
+
* // ],
|
|
145
197
|
* // attachments: [ // MessageAttachmentList
|
|
146
198
|
* // { // MessageAttachment
|
|
147
199
|
* // id: "STRING_VALUE", // required
|
|
@@ -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
|
+
* expiresAt: "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,68 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { SendActionTriggerResultInput, SendActionTriggerResultOutput } 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 SendActionTriggerResultCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendActionTriggerResultCommandInput extends SendActionTriggerResultInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendActionTriggerResultCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendActionTriggerResultCommandOutput extends SendActionTriggerResultOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendActionTriggerResultCommand_base: {
|
|
25
|
+
new (input: SendActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<SendActionTriggerResultCommandInput, SendActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SendActionTriggerResultCommandInput): import("@smithy/smithy-client").CommandImpl<SendActionTriggerResultCommandInput, SendActionTriggerResultCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Send result of the triggered action.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, SendActionTriggerResultCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, SendActionTriggerResultCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // SendActionTriggerResultInput
|
|
38
|
+
* triggerId: "STRING_VALUE", // required
|
|
39
|
+
* status: "completed" || "pending", // required
|
|
40
|
+
* result: {},
|
|
41
|
+
* };
|
|
42
|
+
* const command = new SendActionTriggerResultCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param SendActionTriggerResultCommandInput - {@link SendActionTriggerResultCommandInput}
|
|
49
|
+
* @returns {@link SendActionTriggerResultCommandOutput}
|
|
50
|
+
* @see {@link SendActionTriggerResultCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link SendActionTriggerResultCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link ConversationsClientResolvedConfig | config} for ConversationsClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link TriggerNotFoundException} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ValidationException} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ConversationsServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export declare class SendActionTriggerResultCommand extends SendActionTriggerResultCommand_base {
|
|
68
|
+
}
|
|
@@ -51,6 +51,30 @@ declare const SendGiphyCommand_base: {
|
|
|
51
51
|
* // { // SendGiphyOutput
|
|
52
52
|
* // message: { // Message
|
|
53
53
|
* // text: "STRING_VALUE",
|
|
54
|
+
* // elements: [ // ElementsList
|
|
55
|
+
* // { // Element Union: only one key present
|
|
56
|
+
* // actions: [ // ActionsElementsList
|
|
57
|
+
* // { // ActionElement Union: only one key present
|
|
58
|
+
* // button: { // ButtonElement
|
|
59
|
+
* // text: "STRING_VALUE", // required
|
|
60
|
+
* // variant: "contained" || "outlined",
|
|
61
|
+
* // disabled: true || false,
|
|
62
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
63
|
+
* // link: { // ButtonLinkHandler
|
|
64
|
+
* // url: "STRING_VALUE", // required
|
|
65
|
+
* // },
|
|
66
|
+
* // reply: { // ButtonReplyHandler
|
|
67
|
+
* // text: "STRING_VALUE",
|
|
68
|
+
* // },
|
|
69
|
+
* // action: { // ButtonActionHandler
|
|
70
|
+
* // id: "STRING_VALUE", // required
|
|
71
|
+
* // },
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
54
78
|
* // attachments: [ // MessageAttachmentList
|
|
55
79
|
* // { // MessageAttachment
|
|
56
80
|
* // id: "STRING_VALUE", // required
|
|
@@ -36,6 +36,30 @@ declare const SendMessageCommand_base: {
|
|
|
36
36
|
* const client = new ConversationsClient(config);
|
|
37
37
|
* const input = { // SendMessageInput
|
|
38
38
|
* text: "STRING_VALUE",
|
|
39
|
+
* elements: [ // ElementsList
|
|
40
|
+
* { // Element Union: only one key present
|
|
41
|
+
* actions: [ // ActionsElementsList
|
|
42
|
+
* { // ActionElement Union: only one key present
|
|
43
|
+
* button: { // ButtonElement
|
|
44
|
+
* text: "STRING_VALUE", // required
|
|
45
|
+
* variant: "contained" || "outlined",
|
|
46
|
+
* disabled: true || false,
|
|
47
|
+
* handler: { // ButtonHandler Union: only one key present
|
|
48
|
+
* link: { // ButtonLinkHandler
|
|
49
|
+
* url: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* reply: { // ButtonReplyHandler
|
|
52
|
+
* text: "STRING_VALUE",
|
|
53
|
+
* },
|
|
54
|
+
* action: { // ButtonActionHandler
|
|
55
|
+
* id: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
39
63
|
* attachments: [ // MessageAttachmentList
|
|
40
64
|
* { // MessageAttachment
|
|
41
65
|
* id: "STRING_VALUE", // required
|
|
@@ -140,6 +164,30 @@ declare const SendMessageCommand_base: {
|
|
|
140
164
|
* // { // SendMessageOutput
|
|
141
165
|
* // message: { // Message
|
|
142
166
|
* // text: "STRING_VALUE",
|
|
167
|
+
* // elements: [ // ElementsList
|
|
168
|
+
* // { // Element Union: only one key present
|
|
169
|
+
* // actions: [ // ActionsElementsList
|
|
170
|
+
* // { // ActionElement Union: only one key present
|
|
171
|
+
* // button: { // ButtonElement
|
|
172
|
+
* // text: "STRING_VALUE", // required
|
|
173
|
+
* // variant: "contained" || "outlined",
|
|
174
|
+
* // disabled: true || false,
|
|
175
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
176
|
+
* // link: { // ButtonLinkHandler
|
|
177
|
+
* // url: "STRING_VALUE", // required
|
|
178
|
+
* // },
|
|
179
|
+
* // reply: { // ButtonReplyHandler
|
|
180
|
+
* // text: "STRING_VALUE",
|
|
181
|
+
* // },
|
|
182
|
+
* // action: { // ButtonActionHandler
|
|
183
|
+
* // id: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // },
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // ],
|
|
189
|
+
* // },
|
|
190
|
+
* // ],
|
|
143
191
|
* // attachments: [ // MessageAttachmentList
|
|
144
192
|
* // { // MessageAttachment
|
|
145
193
|
* // id: "STRING_VALUE", // required
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConversationsClient";
|
|
2
|
+
import { TriggerMessageActionInput, TriggerMessageActionOutput } 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 TriggerMessageActionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface TriggerMessageActionCommandInput extends TriggerMessageActionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link TriggerMessageActionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface TriggerMessageActionCommandOutput extends TriggerMessageActionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const TriggerMessageActionCommand_base: {
|
|
25
|
+
new (input: TriggerMessageActionCommandInput): import("@smithy/smithy-client").CommandImpl<TriggerMessageActionCommandInput, TriggerMessageActionCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: TriggerMessageActionCommandInput): import("@smithy/smithy-client").CommandImpl<TriggerMessageActionCommandInput, TriggerMessageActionCommandOutput, ConversationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Sends a trigger for specific action for specified message. This operation requires the message to be accessible to the user.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConversationsClient, TriggerMessageActionCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
|
|
35
|
+
* // const { ConversationsClient, TriggerMessageActionCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
|
|
36
|
+
* const client = new ConversationsClient(config);
|
|
37
|
+
* const input = { // TriggerMessageActionInput
|
|
38
|
+
* channelId: "STRING_VALUE", // required
|
|
39
|
+
* messageId: "STRING_VALUE", // required
|
|
40
|
+
* actionId: "STRING_VALUE", // required
|
|
41
|
+
* userId: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new TriggerMessageActionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // TriggerMessageActionOutput
|
|
46
|
+
* // triggerId: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param TriggerMessageActionCommandInput - {@link TriggerMessageActionCommandInput}
|
|
52
|
+
* @returns {@link TriggerMessageActionCommandOutput}
|
|
53
|
+
* @see {@link TriggerMessageActionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link TriggerMessageActionCommandOutput} 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 MessageActionNotFoundException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ConversationsServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Conversations service.</p>
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export declare class TriggerMessageActionCommand extends TriggerMessageActionCommand_base {
|
|
75
|
+
}
|
|
@@ -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
|
+
}
|
|
@@ -36,6 +36,30 @@ declare const UpdateMessageCommand_base: {
|
|
|
36
36
|
* const client = new ConversationsClient(config);
|
|
37
37
|
* const input = { // UpdateMessageInput
|
|
38
38
|
* text: "STRING_VALUE",
|
|
39
|
+
* elements: [ // ElementsList
|
|
40
|
+
* { // Element Union: only one key present
|
|
41
|
+
* actions: [ // ActionsElementsList
|
|
42
|
+
* { // ActionElement Union: only one key present
|
|
43
|
+
* button: { // ButtonElement
|
|
44
|
+
* text: "STRING_VALUE", // required
|
|
45
|
+
* variant: "contained" || "outlined",
|
|
46
|
+
* disabled: true || false,
|
|
47
|
+
* handler: { // ButtonHandler Union: only one key present
|
|
48
|
+
* link: { // ButtonLinkHandler
|
|
49
|
+
* url: "STRING_VALUE", // required
|
|
50
|
+
* },
|
|
51
|
+
* reply: { // ButtonReplyHandler
|
|
52
|
+
* text: "STRING_VALUE",
|
|
53
|
+
* },
|
|
54
|
+
* action: { // ButtonActionHandler
|
|
55
|
+
* id: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* },
|
|
58
|
+
* },
|
|
59
|
+
* },
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
39
63
|
* attachments: [ // MessageAttachmentList
|
|
40
64
|
* { // MessageAttachment
|
|
41
65
|
* id: "STRING_VALUE", // required
|
|
@@ -134,12 +158,37 @@ declare const UpdateMessageCommand_base: {
|
|
|
134
158
|
* mentions: [ // UsersIdList
|
|
135
159
|
* "STRING_VALUE",
|
|
136
160
|
* ],
|
|
161
|
+
* silent: true || false,
|
|
137
162
|
* };
|
|
138
163
|
* const command = new UpdateMessageCommand(input);
|
|
139
164
|
* const response = await client.send(command);
|
|
140
165
|
* // { // UpdateMessageOutput
|
|
141
166
|
* // message: { // Message
|
|
142
167
|
* // text: "STRING_VALUE",
|
|
168
|
+
* // elements: [ // ElementsList
|
|
169
|
+
* // { // Element Union: only one key present
|
|
170
|
+
* // actions: [ // ActionsElementsList
|
|
171
|
+
* // { // ActionElement Union: only one key present
|
|
172
|
+
* // button: { // ButtonElement
|
|
173
|
+
* // text: "STRING_VALUE", // required
|
|
174
|
+
* // variant: "contained" || "outlined",
|
|
175
|
+
* // disabled: true || false,
|
|
176
|
+
* // handler: { // ButtonHandler Union: only one key present
|
|
177
|
+
* // link: { // ButtonLinkHandler
|
|
178
|
+
* // url: "STRING_VALUE", // required
|
|
179
|
+
* // },
|
|
180
|
+
* // reply: { // ButtonReplyHandler
|
|
181
|
+
* // text: "STRING_VALUE",
|
|
182
|
+
* // },
|
|
183
|
+
* // action: { // ButtonActionHandler
|
|
184
|
+
* // id: "STRING_VALUE", // required
|
|
185
|
+
* // },
|
|
186
|
+
* // },
|
|
187
|
+
* // },
|
|
188
|
+
* // },
|
|
189
|
+
* // ],
|
|
190
|
+
* // },
|
|
191
|
+
* // ],
|
|
143
192
|
* // attachments: [ // MessageAttachmentList
|
|
144
193
|
* // { // MessageAttachment
|
|
145
194
|
* // id: "STRING_VALUE", // required
|
|
@@ -2,12 +2,14 @@ export * from "./AddChannelMemberCommand";
|
|
|
2
2
|
export * from "./AddChannelMembersCommand";
|
|
3
3
|
export * from "./CreateGroupChannelCommand";
|
|
4
4
|
export * from "./CreateInboxTagCommand";
|
|
5
|
+
export * from "./CreateKiteChannelCommand";
|
|
5
6
|
export * from "./DeleteChannelCommand";
|
|
6
7
|
export * from "./DeleteChannelMemberCommand";
|
|
7
8
|
export * from "./DeleteInboxTagCommand";
|
|
8
9
|
export * from "./DeleteMessageCommand";
|
|
9
10
|
export * from "./DeleteMessageReactionCommand";
|
|
10
11
|
export * from "./DescribeEventCommand";
|
|
12
|
+
export * from "./GetActionTriggerResultCommand";
|
|
11
13
|
export * from "./GetChannelCommand";
|
|
12
14
|
export * from "./GetChannelMemberCommand";
|
|
13
15
|
export * from "./GetDirectChannelIdCommand";
|
|
@@ -26,12 +28,15 @@ export * from "./ListInboxTaggedChannelsCommand";
|
|
|
26
28
|
export * from "./ListInboxTagsCommand";
|
|
27
29
|
export * from "./ListMessageReactionsCommand";
|
|
28
30
|
export * from "./ListMessagesCommand";
|
|
31
|
+
export * from "./ListPinnedMessagesCommand";
|
|
29
32
|
export * from "./MarkReadCommand";
|
|
30
33
|
export * from "./MarkUnreadCommand";
|
|
31
34
|
export * from "./PartialUpdateChannelCommand";
|
|
32
35
|
export * from "./PartialUpdateMessageCommand";
|
|
33
36
|
export * from "./PinChannelCommand";
|
|
37
|
+
export * from "./PinMessageCommand";
|
|
34
38
|
export * from "./ScheduleExternalFlagAdjustmentJobCommand";
|
|
39
|
+
export * from "./SendActionTriggerResultCommand";
|
|
35
40
|
export * from "./SendGiphyCommand";
|
|
36
41
|
export * from "./SendMessageCommand";
|
|
37
42
|
export * from "./SendMessageReactionCommand";
|
|
@@ -39,7 +44,9 @@ export * from "./SendTypingStartCommand";
|
|
|
39
44
|
export * from "./SendTypingStopCommand";
|
|
40
45
|
export * from "./ShowChannelCommand";
|
|
41
46
|
export * from "./TagChannelCommand";
|
|
47
|
+
export * from "./TriggerMessageActionCommand";
|
|
42
48
|
export * from "./UnpinChannelCommand";
|
|
49
|
+
export * from "./UnpinMessageCommand";
|
|
43
50
|
export * from "./UntagChannelCommand";
|
|
44
51
|
export * from "./UpdateChannelCommand";
|
|
45
52
|
export * from "./UpdateInboxTagCommand";
|