@aws-sdk/client-chime-sdk-messaging 3.354.0 → 3.358.0
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/README.md +2 -2
- package/dist-cjs/protocols/Aws_restJson1.js +15 -18
- package/dist-es/protocols/Aws_restJson1.js +4 -7
- package/dist-types/ChimeSDKMessaging.d.ts +2 -2
- package/dist-types/ChimeSDKMessagingClient.d.ts +3 -3
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +1 -1
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +2 -2
- package/dist-types/commands/GetChannelMessageCommand.d.ts +5 -0
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +5 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +2 -2
- package/dist-types/commands/SendChannelMessageCommand.d.ts +9 -2
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +66 -13
- package/dist-types/ts3.4/models/models_0.d.ts +6 -0
- package/package.json +28 -28
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript ChimeSDKMessaging Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>The Amazon Chime SDK
|
|
9
|
+
<p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
|
|
10
10
|
and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
11
|
-
provided by the Amazon Chime SDK
|
|
11
|
+
provided by the Amazon Chime SDK identity APIs. For more information about the messaging
|
|
12
12
|
APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
|
|
13
13
|
|
|
14
14
|
## Installing
|
|
@@ -1061,6 +1061,7 @@ const se_SendChannelMessageCommand = async (input, context) => {
|
|
|
1061
1061
|
Persistence: [],
|
|
1062
1062
|
PushNotification: (_) => (0, smithy_client_1._json)(_),
|
|
1063
1063
|
SubChannelId: [],
|
|
1064
|
+
Target: (_) => (0, smithy_client_1._json)(_),
|
|
1064
1065
|
Type: [],
|
|
1065
1066
|
}));
|
|
1066
1067
|
return new protocol_http_1.HttpRequest({
|
|
@@ -1228,7 +1229,7 @@ const de_AssociateChannelFlowCommand = async (output, context) => {
|
|
|
1228
1229
|
const contents = (0, smithy_client_1.map)({
|
|
1229
1230
|
$metadata: deserializeMetadata(output),
|
|
1230
1231
|
});
|
|
1231
|
-
await collectBody(output.body, context);
|
|
1232
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1232
1233
|
return contents;
|
|
1233
1234
|
};
|
|
1234
1235
|
exports.de_AssociateChannelFlowCommand = de_AssociateChannelFlowCommand;
|
|
@@ -1670,7 +1671,7 @@ const de_DeleteChannelCommand = async (output, context) => {
|
|
|
1670
1671
|
const contents = (0, smithy_client_1.map)({
|
|
1671
1672
|
$metadata: deserializeMetadata(output),
|
|
1672
1673
|
});
|
|
1673
|
-
await collectBody(output.body, context);
|
|
1674
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1674
1675
|
return contents;
|
|
1675
1676
|
};
|
|
1676
1677
|
exports.de_DeleteChannelCommand = de_DeleteChannelCommand;
|
|
@@ -1718,7 +1719,7 @@ const de_DeleteChannelBanCommand = async (output, context) => {
|
|
|
1718
1719
|
const contents = (0, smithy_client_1.map)({
|
|
1719
1720
|
$metadata: deserializeMetadata(output),
|
|
1720
1721
|
});
|
|
1721
|
-
await collectBody(output.body, context);
|
|
1722
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1722
1723
|
return contents;
|
|
1723
1724
|
};
|
|
1724
1725
|
exports.de_DeleteChannelBanCommand = de_DeleteChannelBanCommand;
|
|
@@ -1763,7 +1764,7 @@ const de_DeleteChannelFlowCommand = async (output, context) => {
|
|
|
1763
1764
|
const contents = (0, smithy_client_1.map)({
|
|
1764
1765
|
$metadata: deserializeMetadata(output),
|
|
1765
1766
|
});
|
|
1766
|
-
await collectBody(output.body, context);
|
|
1767
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1767
1768
|
return contents;
|
|
1768
1769
|
};
|
|
1769
1770
|
exports.de_DeleteChannelFlowCommand = de_DeleteChannelFlowCommand;
|
|
@@ -1811,7 +1812,7 @@ const de_DeleteChannelMembershipCommand = async (output, context) => {
|
|
|
1811
1812
|
const contents = (0, smithy_client_1.map)({
|
|
1812
1813
|
$metadata: deserializeMetadata(output),
|
|
1813
1814
|
});
|
|
1814
|
-
await collectBody(output.body, context);
|
|
1815
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1815
1816
|
return contents;
|
|
1816
1817
|
};
|
|
1817
1818
|
exports.de_DeleteChannelMembershipCommand = de_DeleteChannelMembershipCommand;
|
|
@@ -1859,7 +1860,7 @@ const de_DeleteChannelMessageCommand = async (output, context) => {
|
|
|
1859
1860
|
const contents = (0, smithy_client_1.map)({
|
|
1860
1861
|
$metadata: deserializeMetadata(output),
|
|
1861
1862
|
});
|
|
1862
|
-
await collectBody(output.body, context);
|
|
1863
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1863
1864
|
return contents;
|
|
1864
1865
|
};
|
|
1865
1866
|
exports.de_DeleteChannelMessageCommand = de_DeleteChannelMessageCommand;
|
|
@@ -1904,7 +1905,7 @@ const de_DeleteChannelModeratorCommand = async (output, context) => {
|
|
|
1904
1905
|
const contents = (0, smithy_client_1.map)({
|
|
1905
1906
|
$metadata: deserializeMetadata(output),
|
|
1906
1907
|
});
|
|
1907
|
-
await collectBody(output.body, context);
|
|
1908
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1908
1909
|
return contents;
|
|
1909
1910
|
};
|
|
1910
1911
|
exports.de_DeleteChannelModeratorCommand = de_DeleteChannelModeratorCommand;
|
|
@@ -1949,7 +1950,7 @@ const de_DeleteMessagingStreamingConfigurationsCommand = async (output, context)
|
|
|
1949
1950
|
const contents = (0, smithy_client_1.map)({
|
|
1950
1951
|
$metadata: deserializeMetadata(output),
|
|
1951
1952
|
});
|
|
1952
|
-
await collectBody(output.body, context);
|
|
1953
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
1953
1954
|
return contents;
|
|
1954
1955
|
};
|
|
1955
1956
|
exports.de_DeleteMessagingStreamingConfigurationsCommand = de_DeleteMessagingStreamingConfigurationsCommand;
|
|
@@ -2346,7 +2347,7 @@ const de_DisassociateChannelFlowCommand = async (output, context) => {
|
|
|
2346
2347
|
const contents = (0, smithy_client_1.map)({
|
|
2347
2348
|
$metadata: deserializeMetadata(output),
|
|
2348
2349
|
});
|
|
2349
|
-
await collectBody(output.body, context);
|
|
2350
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
2350
2351
|
return contents;
|
|
2351
2352
|
};
|
|
2352
2353
|
exports.de_DisassociateChannelFlowCommand = de_DisassociateChannelFlowCommand;
|
|
@@ -3523,7 +3524,7 @@ const de_TagResourceCommand = async (output, context) => {
|
|
|
3523
3524
|
const contents = (0, smithy_client_1.map)({
|
|
3524
3525
|
$metadata: deserializeMetadata(output),
|
|
3525
3526
|
});
|
|
3526
|
-
await collectBody(output.body, context);
|
|
3527
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
3527
3528
|
return contents;
|
|
3528
3529
|
};
|
|
3529
3530
|
exports.de_TagResourceCommand = de_TagResourceCommand;
|
|
@@ -3571,7 +3572,7 @@ const de_UntagResourceCommand = async (output, context) => {
|
|
|
3571
3572
|
const contents = (0, smithy_client_1.map)({
|
|
3572
3573
|
$metadata: deserializeMetadata(output),
|
|
3573
3574
|
});
|
|
3574
|
-
await collectBody(output.body, context);
|
|
3575
|
+
await (0, smithy_client_1.collectBody)(output.body, context);
|
|
3575
3576
|
return contents;
|
|
3576
3577
|
};
|
|
3577
3578
|
exports.de_UntagResourceCommand = de_UntagResourceCommand;
|
|
@@ -4028,6 +4029,7 @@ const de_ChannelMessage = (output, context) => {
|
|
|
4028
4029
|
Sender: smithy_client_1._json,
|
|
4029
4030
|
Status: smithy_client_1._json,
|
|
4030
4031
|
SubChannelId: smithy_client_1.expectString,
|
|
4032
|
+
Target: smithy_client_1._json,
|
|
4031
4033
|
Type: smithy_client_1.expectString,
|
|
4032
4034
|
});
|
|
4033
4035
|
};
|
|
@@ -4044,6 +4046,7 @@ const de_ChannelMessageSummary = (output, context) => {
|
|
|
4044
4046
|
Redacted: smithy_client_1.expectBoolean,
|
|
4045
4047
|
Sender: smithy_client_1._json,
|
|
4046
4048
|
Status: smithy_client_1._json,
|
|
4049
|
+
Target: smithy_client_1._json,
|
|
4047
4050
|
Type: smithy_client_1.expectString,
|
|
4048
4051
|
});
|
|
4049
4052
|
};
|
|
@@ -4100,13 +4103,7 @@ const deserializeMetadata = (output) => ({
|
|
|
4100
4103
|
extendedRequestId: output.headers["x-amz-id-2"],
|
|
4101
4104
|
cfId: output.headers["x-amz-cf-id"],
|
|
4102
4105
|
});
|
|
4103
|
-
const
|
|
4104
|
-
if (streamBody instanceof Uint8Array) {
|
|
4105
|
-
return Promise.resolve(streamBody);
|
|
4106
|
-
}
|
|
4107
|
-
return context.streamCollector(streamBody) || Promise.resolve(new Uint8Array());
|
|
4108
|
-
};
|
|
4109
|
-
const collectBodyString = (streamBody, context) => collectBody(streamBody, context).then((body) => context.utf8Encoder(body));
|
|
4106
|
+
const collectBodyString = (streamBody, context) => (0, smithy_client_1.collectBody)(streamBody, context).then((body) => context.utf8Encoder(body));
|
|
4110
4107
|
const isSerializableHeaderValue = (value) => value !== undefined &&
|
|
4111
4108
|
value !== null &&
|
|
4112
4109
|
value !== "" &&
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { _json, decorateServiceException as __decorateServiceException, expectBoolean as __expectBoolean, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectObject as __expectObject, expectString as __expectString, map, parseEpochTimestamp as __parseEpochTimestamp, resolvedPath as __resolvedPath, take, withBaseException, } from "@aws-sdk/smithy-client";
|
|
1
|
+
import { _json, collectBody, decorateServiceException as __decorateServiceException, expectBoolean as __expectBoolean, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectObject as __expectObject, expectString as __expectString, map, parseEpochTimestamp as __parseEpochTimestamp, resolvedPath as __resolvedPath, take, withBaseException, } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { HttpRequest as __HttpRequest } from "@smithy/protocol-http";
|
|
3
3
|
import { v4 as generateIdempotencyToken } from "uuid";
|
|
4
4
|
import { ChimeSDKMessagingServiceException as __BaseException } from "../models/ChimeSDKMessagingServiceException";
|
|
@@ -1012,6 +1012,7 @@ export const se_SendChannelMessageCommand = async (input, context) => {
|
|
|
1012
1012
|
Persistence: [],
|
|
1013
1013
|
PushNotification: (_) => _json(_),
|
|
1014
1014
|
SubChannelId: [],
|
|
1015
|
+
Target: (_) => _json(_),
|
|
1015
1016
|
Type: [],
|
|
1016
1017
|
}));
|
|
1017
1018
|
return new __HttpRequest({
|
|
@@ -3921,6 +3922,7 @@ const de_ChannelMessage = (output, context) => {
|
|
|
3921
3922
|
Sender: _json,
|
|
3922
3923
|
Status: _json,
|
|
3923
3924
|
SubChannelId: __expectString,
|
|
3925
|
+
Target: _json,
|
|
3924
3926
|
Type: __expectString,
|
|
3925
3927
|
});
|
|
3926
3928
|
};
|
|
@@ -3937,6 +3939,7 @@ const de_ChannelMessageSummary = (output, context) => {
|
|
|
3937
3939
|
Redacted: __expectBoolean,
|
|
3938
3940
|
Sender: _json,
|
|
3939
3941
|
Status: _json,
|
|
3942
|
+
Target: _json,
|
|
3940
3943
|
Type: __expectString,
|
|
3941
3944
|
});
|
|
3942
3945
|
};
|
|
@@ -3993,12 +3996,6 @@ const deserializeMetadata = (output) => ({
|
|
|
3993
3996
|
extendedRequestId: output.headers["x-amz-id-2"],
|
|
3994
3997
|
cfId: output.headers["x-amz-cf-id"],
|
|
3995
3998
|
});
|
|
3996
|
-
const collectBody = (streamBody = new Uint8Array(), context) => {
|
|
3997
|
-
if (streamBody instanceof Uint8Array) {
|
|
3998
|
-
return Promise.resolve(streamBody);
|
|
3999
|
-
}
|
|
4000
|
-
return context.streamCollector(streamBody) || Promise.resolve(new Uint8Array());
|
|
4001
|
-
};
|
|
4002
3999
|
const collectBodyString = (streamBody, context) => collectBody(streamBody, context).then((body) => context.utf8Encoder(body));
|
|
4003
4000
|
const isSerializableHeaderValue = (value) => value !== undefined &&
|
|
4004
4001
|
value !== null &&
|
|
@@ -361,9 +361,9 @@ export interface ChimeSDKMessaging {
|
|
|
361
361
|
}
|
|
362
362
|
/**
|
|
363
363
|
* @public
|
|
364
|
-
* <p>The Amazon Chime SDK
|
|
364
|
+
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
|
|
365
365
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
366
|
-
* provided by the Amazon Chime SDK
|
|
366
|
+
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
|
|
367
367
|
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
|
|
368
368
|
*/
|
|
369
369
|
export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient implements ChimeSDKMessaging {
|
|
@@ -124,7 +124,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
124
124
|
*/
|
|
125
125
|
runtime?: string;
|
|
126
126
|
/**
|
|
127
|
-
* Disable
|
|
127
|
+
* Disable dynamically changing the endpoint of the client based on the hostPrefix
|
|
128
128
|
* trait of an operation.
|
|
129
129
|
*/
|
|
130
130
|
disableHostPrefix?: boolean;
|
|
@@ -196,9 +196,9 @@ export interface ChimeSDKMessagingClientResolvedConfig extends ChimeSDKMessaging
|
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
198
|
* @public
|
|
199
|
-
* <p>The Amazon Chime SDK
|
|
199
|
+
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
|
|
200
200
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
201
|
-
* provided by the Amazon Chime SDK
|
|
201
|
+
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
|
|
202
202
|
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
|
|
203
203
|
*/
|
|
204
204
|
export declare class ChimeSDKMessagingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ChimeSDKMessagingClientResolvedConfig> {
|
|
@@ -23,7 +23,7 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Calls back Chime SDK
|
|
26
|
+
* <p>Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.</p>
|
|
27
27
|
* <p>You can return one of the following processing responses:</p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
@@ -40,7 +40,7 @@ export interface CreateChannelFlowCommandOutput extends CreateChannelFlowRespons
|
|
|
40
40
|
* </li>
|
|
41
41
|
* </ol>
|
|
42
42
|
* <note>
|
|
43
|
-
* <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK
|
|
43
|
+
* <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to
|
|
44
44
|
* <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
|
|
45
45
|
* </note>
|
|
46
46
|
* @example
|
|
@@ -24,8 +24,8 @@ export interface GetChannelMembershipPreferencesCommandOutput extends GetChannel
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
27
|
-
* for the specified channel. A user or a bot must be a member of the channel and own the membership to
|
|
28
|
-
*
|
|
27
|
+
* for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences.
|
|
28
|
+
* Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't
|
|
29
29
|
* retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
|
|
30
30
|
* channel from which they are banned.</p>
|
|
31
31
|
* <note>
|
|
@@ -72,6 +72,11 @@ export interface GetChannelMessageCommandOutput extends GetChannelMessageRespons
|
|
|
72
72
|
* // },
|
|
73
73
|
* // SubChannelId: "STRING_VALUE",
|
|
74
74
|
* // ContentType: "STRING_VALUE",
|
|
75
|
+
* // Target: [ // TargetList
|
|
76
|
+
* // { // Target
|
|
77
|
+
* // MemberArn: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
75
80
|
* // },
|
|
76
81
|
* // };
|
|
77
82
|
*
|
|
@@ -23,7 +23,7 @@ export interface ListChannelMembershipsForAppInstanceUserCommandOutput extends L
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p> Lists all channels that
|
|
26
|
+
* <p> Lists all channels that an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> is a part of.
|
|
27
27
|
* Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -81,6 +81,11 @@ export interface ListChannelMessagesCommandOutput extends ListChannelMessagesRes
|
|
|
81
81
|
* // },
|
|
82
82
|
* // },
|
|
83
83
|
* // ContentType: "STRING_VALUE",
|
|
84
|
+
* // Target: [ // TargetList
|
|
85
|
+
* // { // Target
|
|
86
|
+
* // MemberArn: "STRING_VALUE",
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
84
89
|
* // },
|
|
85
90
|
* // ],
|
|
86
91
|
* // SubChannelId: "STRING_VALUE",
|
|
@@ -23,10 +23,10 @@ export interface PutChannelMembershipPreferencesCommandOutput extends PutChannel
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Sets the membership preferences of an <code>AppInstanceUser</code> or <code>
|
|
26
|
+
* <p>Sets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
27
27
|
* for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the
|
|
28
28
|
* membership can set preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't set
|
|
29
|
-
* preferences for other users
|
|
29
|
+
* preferences for other users. Banned users or bots can't set membership preferences for the channel from
|
|
30
30
|
* which they are banned.</p>
|
|
31
31
|
* <note>
|
|
32
32
|
* <p>The x-amz-chime-bearer request header is mandatory. Use the ARN of an
|
|
@@ -28,8 +28,10 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
|
|
|
28
28
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
29
29
|
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
30
30
|
* the header.</p>
|
|
31
|
-
* <p>Also, <code>STANDARD</code> messages can
|
|
32
|
-
*
|
|
31
|
+
* <p>Also, <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
|
|
32
|
+
* and you can use it in a variety of ways, such as containing a link to an attachment.</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata.</p>
|
|
33
35
|
* </note>
|
|
34
36
|
* @example
|
|
35
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -59,6 +61,11 @@ export interface SendChannelMessageCommandOutput extends SendChannelMessageRespo
|
|
|
59
61
|
* },
|
|
60
62
|
* SubChannelId: "STRING_VALUE",
|
|
61
63
|
* ContentType: "STRING_VALUE",
|
|
64
|
+
* Target: [ // TargetList
|
|
65
|
+
* { // Target
|
|
66
|
+
* MemberArn: "STRING_VALUE",
|
|
67
|
+
* },
|
|
68
|
+
* ],
|
|
62
69
|
* };
|
|
63
70
|
* const command = new SendChannelMessageCommand(input);
|
|
64
71
|
* const response = await client.send(command);
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>The Amazon Chime SDK
|
|
2
|
+
* <p>The Amazon Chime SDK messaging APIs in this section allow software developers to send
|
|
3
3
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
4
|
-
* provided by the Amazon Chime SDK
|
|
4
|
+
* provided by the Amazon Chime SDK identity APIs. For more information about the messaging
|
|
5
5
|
* APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
|
|
6
6
|
*
|
|
7
7
|
* @packageDocumentation
|
|
@@ -649,7 +649,9 @@ export interface ChannelMessageCallback {
|
|
|
649
649
|
*/
|
|
650
650
|
MessageId: string | undefined;
|
|
651
651
|
/**
|
|
652
|
-
* <p>The message content
|
|
652
|
+
* <p>The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
653
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
654
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
653
655
|
*/
|
|
654
656
|
Content?: string;
|
|
655
657
|
/**
|
|
@@ -661,7 +663,9 @@ export interface ChannelMessageCallback {
|
|
|
661
663
|
*/
|
|
662
664
|
PushNotification?: PushNotificationConfiguration;
|
|
663
665
|
/**
|
|
664
|
-
* <p>The attributes for the message
|
|
666
|
+
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
667
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
668
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
665
669
|
*/
|
|
666
670
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
667
671
|
/**
|
|
@@ -669,7 +673,10 @@ export interface ChannelMessageCallback {
|
|
|
669
673
|
*/
|
|
670
674
|
SubChannelId?: string;
|
|
671
675
|
/**
|
|
672
|
-
* <p>The content type of the call-back message
|
|
676
|
+
* <p>The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
677
|
+
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
678
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
679
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
673
680
|
*/
|
|
674
681
|
ContentType?: string;
|
|
675
682
|
}
|
|
@@ -785,7 +792,7 @@ export interface ChannelSummary {
|
|
|
785
792
|
*/
|
|
786
793
|
Metadata?: string;
|
|
787
794
|
/**
|
|
788
|
-
* <p>The time at which the last persistent message in a channel was sent.</p>
|
|
795
|
+
* <p>The time at which the last persistent message visible to the caller in a channel was sent.</p>
|
|
789
796
|
*/
|
|
790
797
|
LastMessageTimestamp?: Date;
|
|
791
798
|
}
|
|
@@ -875,10 +882,21 @@ export interface ChannelMessageStatusStructure {
|
|
|
875
882
|
*/
|
|
876
883
|
Value?: ChannelMessageStatus | string;
|
|
877
884
|
/**
|
|
878
|
-
* <p>Contains more details about the
|
|
885
|
+
* <p>Contains more details about the message status.</p>
|
|
879
886
|
*/
|
|
880
887
|
Detail?: string;
|
|
881
888
|
}
|
|
889
|
+
/**
|
|
890
|
+
* @public
|
|
891
|
+
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
892
|
+
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
893
|
+
*/
|
|
894
|
+
export interface Target {
|
|
895
|
+
/**
|
|
896
|
+
* <p>The ARN of the target channel member.</p>
|
|
897
|
+
*/
|
|
898
|
+
MemberArn?: string;
|
|
899
|
+
}
|
|
882
900
|
/**
|
|
883
901
|
* @public
|
|
884
902
|
* @enum
|
|
@@ -905,7 +923,9 @@ export interface ChannelMessage {
|
|
|
905
923
|
*/
|
|
906
924
|
MessageId?: string;
|
|
907
925
|
/**
|
|
908
|
-
* <p>The message
|
|
926
|
+
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
927
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
928
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
909
929
|
*/
|
|
910
930
|
Content?: string;
|
|
911
931
|
/**
|
|
@@ -945,7 +965,9 @@ export interface ChannelMessage {
|
|
|
945
965
|
*/
|
|
946
966
|
Status?: ChannelMessageStatusStructure;
|
|
947
967
|
/**
|
|
948
|
-
* <p>The attributes for the message
|
|
968
|
+
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
969
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
970
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
949
971
|
*/
|
|
950
972
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
951
973
|
/**
|
|
@@ -953,9 +975,17 @@ export interface ChannelMessage {
|
|
|
953
975
|
*/
|
|
954
976
|
SubChannelId?: string;
|
|
955
977
|
/**
|
|
956
|
-
* <p>The content type of the channel message
|
|
978
|
+
* <p>The content type of the channel message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
979
|
+
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
980
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
981
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
957
982
|
*/
|
|
958
983
|
ContentType?: string;
|
|
984
|
+
/**
|
|
985
|
+
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
986
|
+
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
987
|
+
*/
|
|
988
|
+
Target?: Target[];
|
|
959
989
|
}
|
|
960
990
|
/**
|
|
961
991
|
* @public
|
|
@@ -967,7 +997,9 @@ export interface ChannelMessageSummary {
|
|
|
967
997
|
*/
|
|
968
998
|
MessageId?: string;
|
|
969
999
|
/**
|
|
970
|
-
* <p>The content of the message
|
|
1000
|
+
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
1001
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1002
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
971
1003
|
*/
|
|
972
1004
|
Content?: string;
|
|
973
1005
|
/**
|
|
@@ -1004,13 +1036,23 @@ export interface ChannelMessageSummary {
|
|
|
1004
1036
|
*/
|
|
1005
1037
|
Status?: ChannelMessageStatusStructure;
|
|
1006
1038
|
/**
|
|
1007
|
-
* <p>The message
|
|
1039
|
+
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
1040
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1041
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1008
1042
|
*/
|
|
1009
1043
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1010
1044
|
/**
|
|
1011
|
-
* <p>The content type of the channel
|
|
1045
|
+
* <p>The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
1046
|
+
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
1047
|
+
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1048
|
+
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1012
1049
|
*/
|
|
1013
1050
|
ContentType?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
1053
|
+
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
1054
|
+
*/
|
|
1055
|
+
Target?: Target[];
|
|
1014
1056
|
}
|
|
1015
1057
|
/**
|
|
1016
1058
|
* @public
|
|
@@ -2447,11 +2489,16 @@ export interface SendChannelMessageRequest {
|
|
|
2447
2489
|
*/
|
|
2448
2490
|
ChannelArn: string | undefined;
|
|
2449
2491
|
/**
|
|
2450
|
-
* <p>The content of the message.</p>
|
|
2492
|
+
* <p>The content of the channel message.</p>
|
|
2451
2493
|
*/
|
|
2452
2494
|
Content: string | undefined;
|
|
2453
2495
|
/**
|
|
2454
2496
|
* <p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p>
|
|
2497
|
+
* <p>
|
|
2498
|
+
* <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
|
|
2499
|
+
* and you can use it in a variety of ways, such as containing a link to an attachment.</p>
|
|
2500
|
+
* <p>
|
|
2501
|
+
* <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata.</p>
|
|
2455
2502
|
*/
|
|
2456
2503
|
Type: ChannelMessageType | string | undefined;
|
|
2457
2504
|
/**
|
|
@@ -2487,6 +2534,12 @@ export interface SendChannelMessageRequest {
|
|
|
2487
2534
|
* <p>The content type of the channel message.</p>
|
|
2488
2535
|
*/
|
|
2489
2536
|
ContentType?: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* <p>The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages.
|
|
2539
|
+
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
|
|
2540
|
+
* </p>
|
|
2541
|
+
*/
|
|
2542
|
+
Target?: Target[];
|
|
2490
2543
|
}
|
|
2491
2544
|
/**
|
|
2492
2545
|
* @public
|
|
@@ -2609,7 +2662,7 @@ export interface UpdateChannelMessageRequest {
|
|
|
2609
2662
|
*/
|
|
2610
2663
|
MessageId: string | undefined;
|
|
2611
2664
|
/**
|
|
2612
|
-
* <p>The content of the message
|
|
2665
|
+
* <p>The content of the channel message. </p>
|
|
2613
2666
|
*/
|
|
2614
2667
|
Content: string | undefined;
|
|
2615
2668
|
/**
|
|
@@ -317,6 +317,9 @@ export interface ChannelMessageStatusStructure {
|
|
|
317
317
|
Value?: ChannelMessageStatus | string;
|
|
318
318
|
Detail?: string;
|
|
319
319
|
}
|
|
320
|
+
export interface Target {
|
|
321
|
+
MemberArn?: string;
|
|
322
|
+
}
|
|
320
323
|
export declare const ChannelMessageType: {
|
|
321
324
|
readonly CONTROL: "CONTROL";
|
|
322
325
|
readonly STANDARD: "STANDARD";
|
|
@@ -339,6 +342,7 @@ export interface ChannelMessage {
|
|
|
339
342
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
340
343
|
SubChannelId?: string;
|
|
341
344
|
ContentType?: string;
|
|
345
|
+
Target?: Target[];
|
|
342
346
|
}
|
|
343
347
|
export interface ChannelMessageSummary {
|
|
344
348
|
MessageId?: string;
|
|
@@ -353,6 +357,7 @@ export interface ChannelMessageSummary {
|
|
|
353
357
|
Status?: ChannelMessageStatusStructure;
|
|
354
358
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
355
359
|
ContentType?: string;
|
|
360
|
+
Target?: Target[];
|
|
356
361
|
}
|
|
357
362
|
export interface ChannelModeratedByAppInstanceUserSummary {
|
|
358
363
|
ChannelSummary?: ChannelSummary;
|
|
@@ -772,6 +777,7 @@ export interface SendChannelMessageRequest {
|
|
|
772
777
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
773
778
|
SubChannelId?: string;
|
|
774
779
|
ContentType?: string;
|
|
780
|
+
Target?: Target[];
|
|
775
781
|
}
|
|
776
782
|
export interface SendChannelMessageResponse {
|
|
777
783
|
ChannelArn?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-chime-sdk-messaging",
|
|
3
3
|
"description": "AWS SDK for JavaScript Chime Sdk Messaging Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.358.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,36 +21,36 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
28
|
-
"@aws-sdk/hash-node": "3.
|
|
29
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
30
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
31
|
-
"@aws-sdk/middleware-endpoint": "3.
|
|
32
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
33
|
-
"@aws-sdk/middleware-logger": "3.
|
|
34
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
36
|
-
"@aws-sdk/middleware-serde": "3.
|
|
37
|
-
"@aws-sdk/middleware-signing": "3.
|
|
38
|
-
"@aws-sdk/middleware-stack": "3.
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
40
|
-
"@aws-sdk/node-config-provider": "3.
|
|
41
|
-
"@aws-sdk/node-http-handler": "3.
|
|
42
|
-
"@aws-sdk/smithy-client": "3.
|
|
43
|
-
"@aws-sdk/types": "3.
|
|
44
|
-
"@aws-sdk/url-parser": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.358.0",
|
|
25
|
+
"@aws-sdk/config-resolver": "3.357.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.358.0",
|
|
27
|
+
"@aws-sdk/fetch-http-handler": "3.357.0",
|
|
28
|
+
"@aws-sdk/hash-node": "3.357.0",
|
|
29
|
+
"@aws-sdk/invalid-dependency": "3.357.0",
|
|
30
|
+
"@aws-sdk/middleware-content-length": "3.357.0",
|
|
31
|
+
"@aws-sdk/middleware-endpoint": "3.357.0",
|
|
32
|
+
"@aws-sdk/middleware-host-header": "3.357.0",
|
|
33
|
+
"@aws-sdk/middleware-logger": "3.357.0",
|
|
34
|
+
"@aws-sdk/middleware-recursion-detection": "3.357.0",
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.357.0",
|
|
36
|
+
"@aws-sdk/middleware-serde": "3.357.0",
|
|
37
|
+
"@aws-sdk/middleware-signing": "3.357.0",
|
|
38
|
+
"@aws-sdk/middleware-stack": "3.357.0",
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.357.0",
|
|
40
|
+
"@aws-sdk/node-config-provider": "3.357.0",
|
|
41
|
+
"@aws-sdk/node-http-handler": "3.357.0",
|
|
42
|
+
"@aws-sdk/smithy-client": "3.358.0",
|
|
43
|
+
"@aws-sdk/types": "3.357.0",
|
|
44
|
+
"@aws-sdk/url-parser": "3.357.0",
|
|
45
45
|
"@aws-sdk/util-base64": "3.310.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
51
|
-
"@aws-sdk/util-retry": "3.
|
|
52
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.358.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.358.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.357.0",
|
|
51
|
+
"@aws-sdk/util-retry": "3.357.0",
|
|
52
|
+
"@aws-sdk/util-user-agent-browser": "3.357.0",
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.357.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.310.0",
|
|
55
55
|
"@smithy/protocol-http": "^1.0.1",
|
|
56
56
|
"@smithy/types": "^1.0.0",
|