@wildix/stream-client 0.0.1
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 +35 -0
- package/dist-cjs/StreamServiceClient.js +42 -0
- package/dist-cjs/commands/AddReactionCommand.js +21 -0
- package/dist-cjs/commands/DeleteMessageCommand.js +21 -0
- package/dist-cjs/commands/EditMessageCommand.js +21 -0
- package/dist-cjs/commands/GetInboxCommand.js +21 -0
- package/dist-cjs/commands/GetMessageCommand.js +21 -0
- package/dist-cjs/commands/ListChannelsCommand.js +21 -0
- package/dist-cjs/commands/ListMentionsCommand.js +21 -0
- package/dist-cjs/commands/ListMessagesCommand.js +21 -0
- package/dist-cjs/commands/PinMessageCommand.js +21 -0
- package/dist-cjs/commands/RemoveReactionCommand.js +21 -0
- package/dist-cjs/commands/SendMessageCommand.js +21 -0
- package/dist-cjs/commands/UnpinMessageCommand.js +21 -0
- package/dist-cjs/commands/index.js +15 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/StreamServiceServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +123 -0
- package/dist-cjs/protocols/Aws_restJson1.js +579 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +37 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-cjs/runtimeExtensions.js +11 -0
- package/dist-es/StreamService.js +31 -0
- package/dist-es/StreamServiceClient.js +38 -0
- package/dist-es/commands/AddReactionCommand.js +17 -0
- package/dist-es/commands/DeleteMessageCommand.js +17 -0
- package/dist-es/commands/EditMessageCommand.js +17 -0
- package/dist-es/commands/GetInboxCommand.js +17 -0
- package/dist-es/commands/GetMessageCommand.js +17 -0
- package/dist-es/commands/ListChannelsCommand.js +17 -0
- package/dist-es/commands/ListMentionsCommand.js +17 -0
- package/dist-es/commands/ListMessagesCommand.js +17 -0
- package/dist-es/commands/PinMessageCommand.js +17 -0
- package/dist-es/commands/RemoveReactionCommand.js +17 -0
- package/dist-es/commands/SendMessageCommand.js +17 -0
- package/dist-es/commands/UnpinMessageCommand.js +17 -0
- package/dist-es/commands/index.js +12 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/StreamServiceServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +113 -0
- package/dist-es/protocols/Aws_restJson1.js +552 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +32 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-es/runtimeExtensions.js +7 -0
- package/dist-types/StreamService.d.ts +96 -0
- package/dist-types/StreamServiceClient.d.ts +157 -0
- package/dist-types/commands/AddReactionCommand.d.ts +137 -0
- package/dist-types/commands/DeleteMessageCommand.d.ts +87 -0
- package/dist-types/commands/EditMessageCommand.d.ts +151 -0
- package/dist-types/commands/GetInboxCommand.d.ts +129 -0
- package/dist-types/commands/GetMessageCommand.d.ts +136 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +119 -0
- package/dist-types/commands/ListMentionsCommand.d.ts +153 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +137 -0
- package/dist-types/commands/PinMessageCommand.d.ts +136 -0
- package/dist-types/commands/RemoveReactionCommand.d.ts +137 -0
- package/dist-types/commands/SendMessageCommand.d.ts +160 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +136 -0
- package/dist-types/commands/index.d.ts +12 -0
- package/dist-types/extensionConfiguration.d.ts +7 -0
- package/dist-types/index.d.ts +7 -0
- package/dist-types/models/StreamServiceServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1113 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +110 -0
- package/dist-types/runtimeConfig.browser.d.ts +38 -0
- package/dist-types/runtimeConfig.d.ts +38 -0
- package/dist-types/runtimeConfig.native.d.ts +37 -0
- package/dist-types/runtimeConfig.shared.d.ts +15 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +83 -0
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
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, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: PinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<PinMessageCommandInput, PinMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Pins one message at channel scope. Pin is channel-level and not per-user; every member sees the same pin state. Duplicate calls on an already-pinned message are absorbed and do not advance `messageVersion`. Pinning a deleted / tombstoned message is rejected.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, PinMessageCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, PinMessageCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // PinMessageInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* messageId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new PinMessageCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // PinMessageOutput
|
|
46
|
+
* // message: { // Message
|
|
47
|
+
* // messageId: "STRING_VALUE", // required
|
|
48
|
+
* // userId: "STRING_VALUE", // required
|
|
49
|
+
* // messageType: "regular" || "system", // required
|
|
50
|
+
* // text: "STRING_VALUE",
|
|
51
|
+
* // attachments: [ // MessageAttachmentList // required
|
|
52
|
+
* // { // MessageAttachment
|
|
53
|
+
* // fsId: "STRING_VALUE", // required
|
|
54
|
+
* // mime: "STRING_VALUE",
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // size: Number("long"), // required
|
|
57
|
+
* // width: Number("int"),
|
|
58
|
+
* // height: Number("int"),
|
|
59
|
+
* // thumbnail: "STRING_VALUE",
|
|
60
|
+
* // id: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // mentions: [ // UserIdList // required
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // quote: { // MessageQuote
|
|
67
|
+
* // channelId: "STRING_VALUE", // required
|
|
68
|
+
* // messageId: "STRING_VALUE", // required
|
|
69
|
+
* // userId: "STRING_VALUE", // required
|
|
70
|
+
* // text: "STRING_VALUE",
|
|
71
|
+
* // createdAt: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // forward: { // MessageForward
|
|
74
|
+
* // channelId: "STRING_VALUE", // required
|
|
75
|
+
* // messageId: "STRING_VALUE", // required
|
|
76
|
+
* // userId: "STRING_VALUE", // required
|
|
77
|
+
* // forwardedAt: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // reactionCounts: { // ReactionCounts // required
|
|
80
|
+
* // "<keys>": Number("int"),
|
|
81
|
+
* // },
|
|
82
|
+
* // pinned: true || false, // required
|
|
83
|
+
* // pinnedAt: "STRING_VALUE",
|
|
84
|
+
* // pinnedBy: "STRING_VALUE",
|
|
85
|
+
* // system: true || false, // required
|
|
86
|
+
* // timelineSeq: Number("long"), // required
|
|
87
|
+
* // visibleSeq: Number("long"), // required
|
|
88
|
+
* // channelVersion: Number("long"), // required
|
|
89
|
+
* // messageVersion: Number("long"), // required
|
|
90
|
+
* // createdAt: "STRING_VALUE", // required
|
|
91
|
+
* // editedAt: "STRING_VALUE",
|
|
92
|
+
* // deletedAt: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // };
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @param PinMessageCommandInput - {@link PinMessageCommandInput}
|
|
99
|
+
* @returns {@link PinMessageCommandOutput}
|
|
100
|
+
* @see {@link PinMessageCommandInput} for command's `input` shape.
|
|
101
|
+
* @see {@link PinMessageCommandOutput} for command's `response` shape.
|
|
102
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link InternalServerError} (server fault)
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ValidationException} (client fault)
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link StreamServiceServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
120
|
+
*
|
|
121
|
+
*
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export declare class PinMessageCommand extends PinMessageCommand_base {
|
|
125
|
+
/** @internal type navigation helper, not in runtime. */
|
|
126
|
+
protected static __types: {
|
|
127
|
+
api: {
|
|
128
|
+
input: PinMessageInput;
|
|
129
|
+
output: PinMessageOutput;
|
|
130
|
+
};
|
|
131
|
+
sdk: {
|
|
132
|
+
input: PinMessageCommandInput;
|
|
133
|
+
output: PinMessageCommandOutput;
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { RemoveReactionInput, RemoveReactionOutput } 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 RemoveReactionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RemoveReactionCommandInput extends RemoveReactionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RemoveReactionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RemoveReactionCommandOutput extends RemoveReactionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RemoveReactionCommand_base: {
|
|
25
|
+
new (input: RemoveReactionCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveReactionCommandInput, RemoveReactionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: RemoveReactionCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveReactionCommandInput, RemoveReactionCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes the current user's reaction of `<type>` on one message. Duplicate removes are absorbed and only the first apply advances `messageVersion`.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, RemoveReactionCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, RemoveReactionCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // RemoveReactionInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* messageId: "STRING_VALUE", // required
|
|
42
|
+
* type: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new RemoveReactionCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // RemoveReactionOutput
|
|
47
|
+
* // message: { // Message
|
|
48
|
+
* // messageId: "STRING_VALUE", // required
|
|
49
|
+
* // userId: "STRING_VALUE", // required
|
|
50
|
+
* // messageType: "regular" || "system", // required
|
|
51
|
+
* // text: "STRING_VALUE",
|
|
52
|
+
* // attachments: [ // MessageAttachmentList // required
|
|
53
|
+
* // { // MessageAttachment
|
|
54
|
+
* // fsId: "STRING_VALUE", // required
|
|
55
|
+
* // mime: "STRING_VALUE",
|
|
56
|
+
* // name: "STRING_VALUE", // required
|
|
57
|
+
* // size: Number("long"), // required
|
|
58
|
+
* // width: Number("int"),
|
|
59
|
+
* // height: Number("int"),
|
|
60
|
+
* // thumbnail: "STRING_VALUE",
|
|
61
|
+
* // id: "STRING_VALUE", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // mentions: [ // UserIdList // required
|
|
65
|
+
* // "STRING_VALUE",
|
|
66
|
+
* // ],
|
|
67
|
+
* // quote: { // MessageQuote
|
|
68
|
+
* // channelId: "STRING_VALUE", // required
|
|
69
|
+
* // messageId: "STRING_VALUE", // required
|
|
70
|
+
* // userId: "STRING_VALUE", // required
|
|
71
|
+
* // text: "STRING_VALUE",
|
|
72
|
+
* // createdAt: "STRING_VALUE", // required
|
|
73
|
+
* // },
|
|
74
|
+
* // forward: { // MessageForward
|
|
75
|
+
* // channelId: "STRING_VALUE", // required
|
|
76
|
+
* // messageId: "STRING_VALUE", // required
|
|
77
|
+
* // userId: "STRING_VALUE", // required
|
|
78
|
+
* // forwardedAt: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // reactionCounts: { // ReactionCounts // required
|
|
81
|
+
* // "<keys>": Number("int"),
|
|
82
|
+
* // },
|
|
83
|
+
* // pinned: true || false, // required
|
|
84
|
+
* // pinnedAt: "STRING_VALUE",
|
|
85
|
+
* // pinnedBy: "STRING_VALUE",
|
|
86
|
+
* // system: true || false, // required
|
|
87
|
+
* // timelineSeq: Number("long"), // required
|
|
88
|
+
* // visibleSeq: Number("long"), // required
|
|
89
|
+
* // channelVersion: Number("long"), // required
|
|
90
|
+
* // messageVersion: Number("long"), // required
|
|
91
|
+
* // createdAt: "STRING_VALUE", // required
|
|
92
|
+
* // editedAt: "STRING_VALUE",
|
|
93
|
+
* // deletedAt: "STRING_VALUE",
|
|
94
|
+
* // },
|
|
95
|
+
* // };
|
|
96
|
+
*
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
99
|
+
* @param RemoveReactionCommandInput - {@link RemoveReactionCommandInput}
|
|
100
|
+
* @returns {@link RemoveReactionCommandOutput}
|
|
101
|
+
* @see {@link RemoveReactionCommandInput} for command's `input` shape.
|
|
102
|
+
* @see {@link RemoveReactionCommandOutput} for command's `response` shape.
|
|
103
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link InternalServerError} (server fault)
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
114
|
+
*
|
|
115
|
+
* @throws {@link ValidationException} (client fault)
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link StreamServiceServiceException}
|
|
120
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
121
|
+
*
|
|
122
|
+
*
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export declare class RemoveReactionCommand extends RemoveReactionCommand_base {
|
|
126
|
+
/** @internal type navigation helper, not in runtime. */
|
|
127
|
+
protected static __types: {
|
|
128
|
+
api: {
|
|
129
|
+
input: RemoveReactionInput;
|
|
130
|
+
output: RemoveReactionOutput;
|
|
131
|
+
};
|
|
132
|
+
sdk: {
|
|
133
|
+
input: RemoveReactionCommandInput;
|
|
134
|
+
output: RemoveReactionCommandOutput;
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
}
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
2
|
+
import { SendMessageInput, SendMessageOutput } 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 SendMessageCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SendMessageCommandInput extends SendMessageInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SendMessageCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SendMessageCommandOutput extends SendMessageOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SendMessageCommand_base: {
|
|
25
|
+
new (input: SendMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SendMessageCommandInput): import("@smithy/smithy-client").CommandImpl<SendMessageCommandInput, SendMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Persists a new message to a channel. Serves regular messages, replies (`quote`), forwards (`forward`), targeted user mentions (`mentions[]`), and backend-emitted system messages (`system: true`); only the body fields differ. File attachments must be uploaded first to the file service and referenced by `attachments[].fsId`. Returns the full message snapshot in the same shape as one `ListMessages` item.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, SendMessageCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, SendMessageCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // SendMessageInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* messageType: "regular" || "system",
|
|
42
|
+
* text: "STRING_VALUE",
|
|
43
|
+
* attachments: [ // MessageAttachmentRequestList
|
|
44
|
+
* { // MessageAttachmentRequest
|
|
45
|
+
* fsId: "STRING_VALUE", // required
|
|
46
|
+
* mime: "STRING_VALUE",
|
|
47
|
+
* name: "STRING_VALUE", // required
|
|
48
|
+
* size: Number("long"), // required
|
|
49
|
+
* width: Number("int"),
|
|
50
|
+
* height: Number("int"),
|
|
51
|
+
* thumbnail: "STRING_VALUE",
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* mentions: [ // UserIdList
|
|
55
|
+
* "STRING_VALUE",
|
|
56
|
+
* ],
|
|
57
|
+
* quote: { // MessageQuoteRef
|
|
58
|
+
* channelId: "STRING_VALUE", // required
|
|
59
|
+
* messageId: "STRING_VALUE", // required
|
|
60
|
+
* },
|
|
61
|
+
* forward: { // MessageForwardRef
|
|
62
|
+
* channelId: "STRING_VALUE", // required
|
|
63
|
+
* messageId: "STRING_VALUE", // required
|
|
64
|
+
* },
|
|
65
|
+
* system: true || false,
|
|
66
|
+
* };
|
|
67
|
+
* const command = new SendMessageCommand(input);
|
|
68
|
+
* const response = await client.send(command);
|
|
69
|
+
* // { // SendMessageOutput
|
|
70
|
+
* // message: { // Message
|
|
71
|
+
* // messageId: "STRING_VALUE", // required
|
|
72
|
+
* // userId: "STRING_VALUE", // required
|
|
73
|
+
* // messageType: "regular" || "system", // required
|
|
74
|
+
* // text: "STRING_VALUE",
|
|
75
|
+
* // attachments: [ // MessageAttachmentList // required
|
|
76
|
+
* // { // MessageAttachment
|
|
77
|
+
* // fsId: "STRING_VALUE", // required
|
|
78
|
+
* // mime: "STRING_VALUE",
|
|
79
|
+
* // name: "STRING_VALUE", // required
|
|
80
|
+
* // size: Number("long"), // required
|
|
81
|
+
* // width: Number("int"),
|
|
82
|
+
* // height: Number("int"),
|
|
83
|
+
* // thumbnail: "STRING_VALUE",
|
|
84
|
+
* // id: "STRING_VALUE", // required
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // mentions: [ // UserIdList // required
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // quote: { // MessageQuote
|
|
91
|
+
* // channelId: "STRING_VALUE", // required
|
|
92
|
+
* // messageId: "STRING_VALUE", // required
|
|
93
|
+
* // userId: "STRING_VALUE", // required
|
|
94
|
+
* // text: "STRING_VALUE",
|
|
95
|
+
* // createdAt: "STRING_VALUE", // required
|
|
96
|
+
* // },
|
|
97
|
+
* // forward: { // MessageForward
|
|
98
|
+
* // channelId: "STRING_VALUE", // required
|
|
99
|
+
* // messageId: "STRING_VALUE", // required
|
|
100
|
+
* // userId: "STRING_VALUE", // required
|
|
101
|
+
* // forwardedAt: "STRING_VALUE", // required
|
|
102
|
+
* // },
|
|
103
|
+
* // reactionCounts: { // ReactionCounts // required
|
|
104
|
+
* // "<keys>": Number("int"),
|
|
105
|
+
* // },
|
|
106
|
+
* // pinned: true || false, // required
|
|
107
|
+
* // pinnedAt: "STRING_VALUE",
|
|
108
|
+
* // pinnedBy: "STRING_VALUE",
|
|
109
|
+
* // system: true || false, // required
|
|
110
|
+
* // timelineSeq: Number("long"), // required
|
|
111
|
+
* // visibleSeq: Number("long"), // required
|
|
112
|
+
* // channelVersion: Number("long"), // required
|
|
113
|
+
* // messageVersion: Number("long"), // required
|
|
114
|
+
* // createdAt: "STRING_VALUE", // required
|
|
115
|
+
* // editedAt: "STRING_VALUE",
|
|
116
|
+
* // deletedAt: "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // };
|
|
119
|
+
*
|
|
120
|
+
* ```
|
|
121
|
+
*
|
|
122
|
+
* @param SendMessageCommandInput - {@link SendMessageCommandInput}
|
|
123
|
+
* @returns {@link SendMessageCommandOutput}
|
|
124
|
+
* @see {@link SendMessageCommandInput} for command's `input` shape.
|
|
125
|
+
* @see {@link SendMessageCommandOutput} for command's `response` shape.
|
|
126
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
129
|
+
*
|
|
130
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
131
|
+
*
|
|
132
|
+
* @throws {@link InternalServerError} (server fault)
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link ValidationException} (client fault)
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link StreamServiceServiceException}
|
|
143
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
144
|
+
*
|
|
145
|
+
*
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
export declare class SendMessageCommand extends SendMessageCommand_base {
|
|
149
|
+
/** @internal type navigation helper, not in runtime. */
|
|
150
|
+
protected static __types: {
|
|
151
|
+
api: {
|
|
152
|
+
input: SendMessageInput;
|
|
153
|
+
output: SendMessageOutput;
|
|
154
|
+
};
|
|
155
|
+
sdk: {
|
|
156
|
+
input: SendMessageCommandInput;
|
|
157
|
+
output: SendMessageCommandOutput;
|
|
158
|
+
};
|
|
159
|
+
};
|
|
160
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, StreamServiceClientResolvedConfig } from "../StreamServiceClient";
|
|
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, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnpinMessageCommandInput): import("@smithy/smithy-client").CommandImpl<UnpinMessageCommandInput, UnpinMessageCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Unpins one message at channel scope. Duplicate calls on an already-unpinned message are absorbed and do not advance `messageVersion`.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { StreamServiceClient, UnpinMessageCommand } from "@wildix/stream-client"; // ES Modules import
|
|
35
|
+
* // const { StreamServiceClient, UnpinMessageCommand } = require("@wildix/stream-client"); // CommonJS import
|
|
36
|
+
* const client = new StreamServiceClient(config);
|
|
37
|
+
* const input = { // UnpinMessageInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* userId: "STRING_VALUE",
|
|
40
|
+
* channelId: "STRING_VALUE", // required
|
|
41
|
+
* messageId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UnpinMessageCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // UnpinMessageOutput
|
|
46
|
+
* // message: { // Message
|
|
47
|
+
* // messageId: "STRING_VALUE", // required
|
|
48
|
+
* // userId: "STRING_VALUE", // required
|
|
49
|
+
* // messageType: "regular" || "system", // required
|
|
50
|
+
* // text: "STRING_VALUE",
|
|
51
|
+
* // attachments: [ // MessageAttachmentList // required
|
|
52
|
+
* // { // MessageAttachment
|
|
53
|
+
* // fsId: "STRING_VALUE", // required
|
|
54
|
+
* // mime: "STRING_VALUE",
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // size: Number("long"), // required
|
|
57
|
+
* // width: Number("int"),
|
|
58
|
+
* // height: Number("int"),
|
|
59
|
+
* // thumbnail: "STRING_VALUE",
|
|
60
|
+
* // id: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // ],
|
|
63
|
+
* // mentions: [ // UserIdList // required
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // quote: { // MessageQuote
|
|
67
|
+
* // channelId: "STRING_VALUE", // required
|
|
68
|
+
* // messageId: "STRING_VALUE", // required
|
|
69
|
+
* // userId: "STRING_VALUE", // required
|
|
70
|
+
* // text: "STRING_VALUE",
|
|
71
|
+
* // createdAt: "STRING_VALUE", // required
|
|
72
|
+
* // },
|
|
73
|
+
* // forward: { // MessageForward
|
|
74
|
+
* // channelId: "STRING_VALUE", // required
|
|
75
|
+
* // messageId: "STRING_VALUE", // required
|
|
76
|
+
* // userId: "STRING_VALUE", // required
|
|
77
|
+
* // forwardedAt: "STRING_VALUE", // required
|
|
78
|
+
* // },
|
|
79
|
+
* // reactionCounts: { // ReactionCounts // required
|
|
80
|
+
* // "<keys>": Number("int"),
|
|
81
|
+
* // },
|
|
82
|
+
* // pinned: true || false, // required
|
|
83
|
+
* // pinnedAt: "STRING_VALUE",
|
|
84
|
+
* // pinnedBy: "STRING_VALUE",
|
|
85
|
+
* // system: true || false, // required
|
|
86
|
+
* // timelineSeq: Number("long"), // required
|
|
87
|
+
* // visibleSeq: Number("long"), // required
|
|
88
|
+
* // channelVersion: Number("long"), // required
|
|
89
|
+
* // messageVersion: Number("long"), // required
|
|
90
|
+
* // createdAt: "STRING_VALUE", // required
|
|
91
|
+
* // editedAt: "STRING_VALUE",
|
|
92
|
+
* // deletedAt: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // };
|
|
95
|
+
*
|
|
96
|
+
* ```
|
|
97
|
+
*
|
|
98
|
+
* @param UnpinMessageCommandInput - {@link UnpinMessageCommandInput}
|
|
99
|
+
* @returns {@link UnpinMessageCommandOutput}
|
|
100
|
+
* @see {@link UnpinMessageCommandInput} for command's `input` shape.
|
|
101
|
+
* @see {@link UnpinMessageCommandOutput} for command's `response` shape.
|
|
102
|
+
* @see {@link StreamServiceClientResolvedConfig | config} for StreamServiceClient's `config` shape.
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ChannelNotFoundException} (client fault)
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link MessageNotFoundException} (client fault)
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link InternalServerError} (server fault)
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ValidationException} (client fault)
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link RateLimitExceededException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link StreamServiceServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from StreamService service.</p>
|
|
120
|
+
*
|
|
121
|
+
*
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export declare class UnpinMessageCommand extends UnpinMessageCommand_base {
|
|
125
|
+
/** @internal type navigation helper, not in runtime. */
|
|
126
|
+
protected static __types: {
|
|
127
|
+
api: {
|
|
128
|
+
input: UnpinMessageInput;
|
|
129
|
+
output: UnpinMessageOutput;
|
|
130
|
+
};
|
|
131
|
+
sdk: {
|
|
132
|
+
input: UnpinMessageCommandInput;
|
|
133
|
+
output: UnpinMessageCommandOutput;
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export * from "./AddReactionCommand";
|
|
2
|
+
export * from "./DeleteMessageCommand";
|
|
3
|
+
export * from "./EditMessageCommand";
|
|
4
|
+
export * from "./GetInboxCommand";
|
|
5
|
+
export * from "./GetMessageCommand";
|
|
6
|
+
export * from "./ListChannelsCommand";
|
|
7
|
+
export * from "./ListMentionsCommand";
|
|
8
|
+
export * from "./ListMessagesCommand";
|
|
9
|
+
export * from "./PinMessageCommand";
|
|
10
|
+
export * from "./RemoveReactionCommand";
|
|
11
|
+
export * from "./SendMessageCommand";
|
|
12
|
+
export * from "./UnpinMessageCommand";
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
|
|
2
|
+
import { DefaultExtensionConfiguration } from "@smithy/types";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface StreamServiceExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration {
|
|
7
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export * from "./StreamServiceClient";
|
|
2
|
+
export * from "./StreamService";
|
|
3
|
+
export type { RuntimeExtension } from "./runtimeExtensions";
|
|
4
|
+
export type { StreamServiceExtensionConfiguration } from "./extensionConfiguration";
|
|
5
|
+
export * from "./commands";
|
|
6
|
+
export * from "./models";
|
|
7
|
+
export { StreamServiceServiceException } from "./models/StreamServiceServiceException";
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
|
|
2
|
+
export type { __ServiceExceptionOptions };
|
|
3
|
+
export { __ServiceException };
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*
|
|
7
|
+
* Base exception class for all service exceptions from StreamService service.
|
|
8
|
+
*/
|
|
9
|
+
export declare class StreamServiceServiceException extends __ServiceException {
|
|
10
|
+
/**
|
|
11
|
+
* @internal
|
|
12
|
+
*/
|
|
13
|
+
constructor(options: __ServiceExceptionOptions);
|
|
14
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./models_0";
|