@aws-sdk/client-connectparticipant 3.235.0 → 3.238.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 -4
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +11 -1
- package/dist-cjs/protocols/Aws_restJson1.js +27 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +27 -0
- package/dist-types/ConnectParticipant.d.ts +66 -31
- package/dist-types/ConnectParticipantClient.d.ts +2 -4
- package/dist-types/commands/CompleteAttachmentUploadCommand.d.ts +5 -0
- package/dist-types/commands/CreateParticipantConnectionCommand.d.ts +24 -18
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +6 -2
- package/dist-types/commands/GetAttachmentCommand.d.ts +5 -0
- package/dist-types/commands/GetTranscriptCommand.d.ts +7 -3
- package/dist-types/commands/SendEventCommand.d.ts +6 -2
- package/dist-types/commands/SendMessageCommand.d.ts +6 -2
- package/dist-types/commands/StartAttachmentUploadCommand.d.ts +5 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +98 -24
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +17 -1
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -10,10 +10,8 @@
|
|
|
10
10
|
AWS SDK for JavaScript ConnectParticipant Client for Node.js, Browser and React Native.
|
|
11
11
|
|
|
12
12
|
<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
|
|
13
|
-
a customer contact center
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
<p>The APIs described here are used by chat participants, such as agents and
|
|
13
|
+
a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use
|
|
14
|
+
the Amazon Connect Participant Service to manage chat participants, such as agents and
|
|
17
15
|
customers.</p>
|
|
18
16
|
|
|
19
17
|
## Installing
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
4
|
+
const q = "fn", r = "argv", s = "ref";
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.StartAttachmentUploadResponseFilterSensitiveLog = exports.UploadMetadataFilterSensitiveLog = exports.StartAttachmentUploadRequestFilterSensitiveLog = exports.SendMessageResponseFilterSensitiveLog = exports.SendMessageRequestFilterSensitiveLog = exports.SendEventResponseFilterSensitiveLog = exports.SendEventRequestFilterSensitiveLog = exports.GetTranscriptResponseFilterSensitiveLog = exports.ItemFilterSensitiveLog = exports.AttachmentItemFilterSensitiveLog = exports.GetTranscriptRequestFilterSensitiveLog = exports.StartPositionFilterSensitiveLog = exports.GetAttachmentResponseFilterSensitiveLog = exports.GetAttachmentRequestFilterSensitiveLog = exports.DisconnectParticipantResponseFilterSensitiveLog = exports.DisconnectParticipantRequestFilterSensitiveLog = exports.CreateParticipantConnectionResponseFilterSensitiveLog = exports.WebsocketFilterSensitiveLog = exports.ConnectionCredentialsFilterSensitiveLog = exports.CreateParticipantConnectionRequestFilterSensitiveLog = exports.CompleteAttachmentUploadResponseFilterSensitiveLog = exports.CompleteAttachmentUploadRequestFilterSensitiveLog = exports.ChatItemType = exports.ParticipantRole = exports.ArtifactStatus = exports.SortKey = exports.ScanDirection = exports.ConnectionType = exports.ValidationException = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.InternalServerException = exports.ConflictException = exports.AccessDeniedException = void 0;
|
|
3
|
+
exports.StartAttachmentUploadResponseFilterSensitiveLog = exports.UploadMetadataFilterSensitiveLog = exports.StartAttachmentUploadRequestFilterSensitiveLog = exports.SendMessageResponseFilterSensitiveLog = exports.SendMessageRequestFilterSensitiveLog = exports.SendEventResponseFilterSensitiveLog = exports.SendEventRequestFilterSensitiveLog = exports.GetTranscriptResponseFilterSensitiveLog = exports.ItemFilterSensitiveLog = exports.MessageMetadataFilterSensitiveLog = exports.ReceiptFilterSensitiveLog = exports.AttachmentItemFilterSensitiveLog = exports.GetTranscriptRequestFilterSensitiveLog = exports.StartPositionFilterSensitiveLog = exports.GetAttachmentResponseFilterSensitiveLog = exports.GetAttachmentRequestFilterSensitiveLog = exports.DisconnectParticipantResponseFilterSensitiveLog = exports.DisconnectParticipantRequestFilterSensitiveLog = exports.CreateParticipantConnectionResponseFilterSensitiveLog = exports.WebsocketFilterSensitiveLog = exports.ConnectionCredentialsFilterSensitiveLog = exports.CreateParticipantConnectionRequestFilterSensitiveLog = exports.CompleteAttachmentUploadResponseFilterSensitiveLog = exports.CompleteAttachmentUploadRequestFilterSensitiveLog = exports.ChatItemType = exports.ParticipantRole = exports.ArtifactStatus = exports.SortKey = exports.ScanDirection = exports.ConnectionType = exports.ValidationException = exports.ThrottlingException = exports.ServiceQuotaExceededException = exports.InternalServerException = exports.ConflictException = exports.AccessDeniedException = void 0;
|
|
4
4
|
const ConnectParticipantServiceException_1 = require("./ConnectParticipantServiceException");
|
|
5
5
|
class AccessDeniedException extends ConnectParticipantServiceException_1.ConnectParticipantServiceException {
|
|
6
6
|
constructor(opts) {
|
|
@@ -120,6 +120,8 @@ var ChatItemType;
|
|
|
120
120
|
ChatItemType["CONNECTION_ACK"] = "CONNECTION_ACK";
|
|
121
121
|
ChatItemType["EVENT"] = "EVENT";
|
|
122
122
|
ChatItemType["MESSAGE"] = "MESSAGE";
|
|
123
|
+
ChatItemType["MESSAGE_DELIVERED"] = "MESSAGE_DELIVERED";
|
|
124
|
+
ChatItemType["MESSAGE_READ"] = "MESSAGE_READ";
|
|
123
125
|
ChatItemType["PARTICIPANT_JOINED"] = "PARTICIPANT_JOINED";
|
|
124
126
|
ChatItemType["PARTICIPANT_LEFT"] = "PARTICIPANT_LEFT";
|
|
125
127
|
ChatItemType["TRANSFER_FAILED"] = "TRANSFER_FAILED";
|
|
@@ -178,6 +180,14 @@ const AttachmentItemFilterSensitiveLog = (obj) => ({
|
|
|
178
180
|
...obj,
|
|
179
181
|
});
|
|
180
182
|
exports.AttachmentItemFilterSensitiveLog = AttachmentItemFilterSensitiveLog;
|
|
183
|
+
const ReceiptFilterSensitiveLog = (obj) => ({
|
|
184
|
+
...obj,
|
|
185
|
+
});
|
|
186
|
+
exports.ReceiptFilterSensitiveLog = ReceiptFilterSensitiveLog;
|
|
187
|
+
const MessageMetadataFilterSensitiveLog = (obj) => ({
|
|
188
|
+
...obj,
|
|
189
|
+
});
|
|
190
|
+
exports.MessageMetadataFilterSensitiveLog = MessageMetadataFilterSensitiveLog;
|
|
181
191
|
const ItemFilterSensitiveLog = (obj) => ({
|
|
182
192
|
...obj,
|
|
183
193
|
});
|
|
@@ -695,11 +695,38 @@ const deserializeAws_restJson1Item = (output, context) => {
|
|
|
695
695
|
ContentType: (0, smithy_client_1.expectString)(output.ContentType),
|
|
696
696
|
DisplayName: (0, smithy_client_1.expectString)(output.DisplayName),
|
|
697
697
|
Id: (0, smithy_client_1.expectString)(output.Id),
|
|
698
|
+
MessageMetadata: output.MessageMetadata != null
|
|
699
|
+
? deserializeAws_restJson1MessageMetadata(output.MessageMetadata, context)
|
|
700
|
+
: undefined,
|
|
698
701
|
ParticipantId: (0, smithy_client_1.expectString)(output.ParticipantId),
|
|
699
702
|
ParticipantRole: (0, smithy_client_1.expectString)(output.ParticipantRole),
|
|
700
703
|
Type: (0, smithy_client_1.expectString)(output.Type),
|
|
701
704
|
};
|
|
702
705
|
};
|
|
706
|
+
const deserializeAws_restJson1MessageMetadata = (output, context) => {
|
|
707
|
+
return {
|
|
708
|
+
MessageId: (0, smithy_client_1.expectString)(output.MessageId),
|
|
709
|
+
Receipts: output.Receipts != null ? deserializeAws_restJson1Receipts(output.Receipts, context) : undefined,
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
const deserializeAws_restJson1Receipt = (output, context) => {
|
|
713
|
+
return {
|
|
714
|
+
DeliveredTimestamp: (0, smithy_client_1.expectString)(output.DeliveredTimestamp),
|
|
715
|
+
ReadTimestamp: (0, smithy_client_1.expectString)(output.ReadTimestamp),
|
|
716
|
+
RecipientParticipantId: (0, smithy_client_1.expectString)(output.RecipientParticipantId),
|
|
717
|
+
};
|
|
718
|
+
};
|
|
719
|
+
const deserializeAws_restJson1Receipts = (output, context) => {
|
|
720
|
+
const retVal = (output || [])
|
|
721
|
+
.filter((e) => e != null)
|
|
722
|
+
.map((entry) => {
|
|
723
|
+
if (entry === null) {
|
|
724
|
+
return null;
|
|
725
|
+
}
|
|
726
|
+
return deserializeAws_restJson1Receipt(entry, context);
|
|
727
|
+
});
|
|
728
|
+
return retVal;
|
|
729
|
+
};
|
|
703
730
|
const deserializeAws_restJson1Transcript = (output, context) => {
|
|
704
731
|
const retVal = (output || [])
|
|
705
732
|
.filter((e) => e != null)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
1
|
+
const q = "fn", r = "argv", s = "ref";
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -111,6 +111,8 @@ export var ChatItemType;
|
|
|
111
111
|
ChatItemType["CONNECTION_ACK"] = "CONNECTION_ACK";
|
|
112
112
|
ChatItemType["EVENT"] = "EVENT";
|
|
113
113
|
ChatItemType["MESSAGE"] = "MESSAGE";
|
|
114
|
+
ChatItemType["MESSAGE_DELIVERED"] = "MESSAGE_DELIVERED";
|
|
115
|
+
ChatItemType["MESSAGE_READ"] = "MESSAGE_READ";
|
|
114
116
|
ChatItemType["PARTICIPANT_JOINED"] = "PARTICIPANT_JOINED";
|
|
115
117
|
ChatItemType["PARTICIPANT_LEFT"] = "PARTICIPANT_LEFT";
|
|
116
118
|
ChatItemType["TRANSFER_FAILED"] = "TRANSFER_FAILED";
|
|
@@ -156,6 +158,12 @@ export const GetTranscriptRequestFilterSensitiveLog = (obj) => ({
|
|
|
156
158
|
export const AttachmentItemFilterSensitiveLog = (obj) => ({
|
|
157
159
|
...obj,
|
|
158
160
|
});
|
|
161
|
+
export const ReceiptFilterSensitiveLog = (obj) => ({
|
|
162
|
+
...obj,
|
|
163
|
+
});
|
|
164
|
+
export const MessageMetadataFilterSensitiveLog = (obj) => ({
|
|
165
|
+
...obj,
|
|
166
|
+
});
|
|
159
167
|
export const ItemFilterSensitiveLog = (obj) => ({
|
|
160
168
|
...obj,
|
|
161
169
|
});
|
|
@@ -676,11 +676,38 @@ const deserializeAws_restJson1Item = (output, context) => {
|
|
|
676
676
|
ContentType: __expectString(output.ContentType),
|
|
677
677
|
DisplayName: __expectString(output.DisplayName),
|
|
678
678
|
Id: __expectString(output.Id),
|
|
679
|
+
MessageMetadata: output.MessageMetadata != null
|
|
680
|
+
? deserializeAws_restJson1MessageMetadata(output.MessageMetadata, context)
|
|
681
|
+
: undefined,
|
|
679
682
|
ParticipantId: __expectString(output.ParticipantId),
|
|
680
683
|
ParticipantRole: __expectString(output.ParticipantRole),
|
|
681
684
|
Type: __expectString(output.Type),
|
|
682
685
|
};
|
|
683
686
|
};
|
|
687
|
+
const deserializeAws_restJson1MessageMetadata = (output, context) => {
|
|
688
|
+
return {
|
|
689
|
+
MessageId: __expectString(output.MessageId),
|
|
690
|
+
Receipts: output.Receipts != null ? deserializeAws_restJson1Receipts(output.Receipts, context) : undefined,
|
|
691
|
+
};
|
|
692
|
+
};
|
|
693
|
+
const deserializeAws_restJson1Receipt = (output, context) => {
|
|
694
|
+
return {
|
|
695
|
+
DeliveredTimestamp: __expectString(output.DeliveredTimestamp),
|
|
696
|
+
ReadTimestamp: __expectString(output.ReadTimestamp),
|
|
697
|
+
RecipientParticipantId: __expectString(output.RecipientParticipantId),
|
|
698
|
+
};
|
|
699
|
+
};
|
|
700
|
+
const deserializeAws_restJson1Receipts = (output, context) => {
|
|
701
|
+
const retVal = (output || [])
|
|
702
|
+
.filter((e) => e != null)
|
|
703
|
+
.map((entry) => {
|
|
704
|
+
if (entry === null) {
|
|
705
|
+
return null;
|
|
706
|
+
}
|
|
707
|
+
return deserializeAws_restJson1Receipt(entry, context);
|
|
708
|
+
});
|
|
709
|
+
return retVal;
|
|
710
|
+
};
|
|
684
711
|
const deserializeAws_restJson1Transcript = (output, context) => {
|
|
685
712
|
const retVal = (output || [])
|
|
686
713
|
.filter((e) => e != null)
|
|
@@ -10,16 +10,19 @@ import { StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput }
|
|
|
10
10
|
import { ConnectParticipantClient } from "./ConnectParticipantClient";
|
|
11
11
|
/**
|
|
12
12
|
* <p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
|
|
13
|
-
* a customer contact center
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <p>The APIs described here are used by chat participants, such as agents and
|
|
13
|
+
* a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use
|
|
14
|
+
* the Amazon Connect Participant Service to manage chat participants, such as agents and
|
|
17
15
|
* customers.</p>
|
|
18
16
|
*/
|
|
19
17
|
export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
20
18
|
/**
|
|
21
19
|
* <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
|
|
22
20
|
* provided in StartAttachmentUpload API. </p>
|
|
21
|
+
* <note>
|
|
22
|
+
* <p>
|
|
23
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
24
|
+
* <code>ParticipantToken</code>.</p>
|
|
25
|
+
* </note>
|
|
23
26
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
24
27
|
* authentication</a>.</p>
|
|
25
28
|
*/
|
|
@@ -27,32 +30,38 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
27
30
|
completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
|
|
28
31
|
completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
|
|
29
32
|
/**
|
|
30
|
-
* <p>Creates the participant's connection.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* <p>Creates the participant's connection. </p>
|
|
34
|
+
* <note>
|
|
35
|
+
* <p>
|
|
36
|
+
* <code>ParticipantToken</code> is used for invoking this API instead of
|
|
37
|
+
* <code>ConnectionToken</code>.</p>
|
|
38
|
+
* </note>
|
|
39
|
+
* <p>The participant token is valid for the lifetime of the participant – until they are
|
|
40
|
+
* part of a contact.</p>
|
|
41
|
+
* <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
|
|
35
42
|
* Clients must manually connect to the returned websocket URL and subscribe to the desired
|
|
36
43
|
* topic. </p>
|
|
37
|
-
*
|
|
44
|
+
* <p>For chat, you need to publish the following on the established websocket
|
|
38
45
|
* connection:</p>
|
|
39
|
-
*
|
|
46
|
+
* <p>
|
|
40
47
|
* <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
|
|
41
48
|
* </p>
|
|
42
|
-
*
|
|
49
|
+
* <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
|
|
43
50
|
* clients need to call this API again to obtain a new websocket URL and perform the same
|
|
44
51
|
* steps as before.</p>
|
|
45
|
-
*
|
|
46
|
-
* <b>Message streaming support</b>: This API can also be used
|
|
47
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
52
|
+
* <p>
|
|
53
|
+
* <b>Message streaming support</b>: This API can also be used
|
|
54
|
+
* together with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API to create a participant connection for chat
|
|
55
|
+
* contacts that are not using a websocket. For more information about message streaming,
|
|
56
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat
|
|
57
|
+
* message streaming</a> in the <i>Amazon Connect Administrator
|
|
58
|
+
* Guide</i>.</p>
|
|
59
|
+
* <p>
|
|
60
|
+
* <b>Feature specifications</b>: For information about feature
|
|
61
|
+
* specifications, such as the allowed number of open websocket connections per
|
|
62
|
+
* participant, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator
|
|
54
63
|
* Guide</i>. </p>
|
|
55
|
-
*
|
|
64
|
+
* <note>
|
|
56
65
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
57
66
|
* authentication</a>.</p>
|
|
58
67
|
* </note>
|
|
@@ -61,8 +70,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
61
70
|
createParticipantConnection(args: CreateParticipantConnectionCommandInput, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
|
|
62
71
|
createParticipantConnection(args: CreateParticipantConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
|
|
63
72
|
/**
|
|
64
|
-
* <p>Disconnects a participant.
|
|
65
|
-
*
|
|
73
|
+
* <p>Disconnects a participant. </p>
|
|
74
|
+
* <note>
|
|
75
|
+
* <p>
|
|
76
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
77
|
+
* <code>ParticipantToken</code>.</p>
|
|
78
|
+
* </note>
|
|
66
79
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
67
80
|
* authentication</a>.</p>
|
|
68
81
|
*/
|
|
@@ -72,6 +85,11 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
72
85
|
/**
|
|
73
86
|
* <p>Provides a pre-signed URL for download of a completed attachment. This is an
|
|
74
87
|
* asynchronous API for use with active contacts.</p>
|
|
88
|
+
* <note>
|
|
89
|
+
* <p>
|
|
90
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
91
|
+
* <code>ParticipantToken</code>.</p>
|
|
92
|
+
* </note>
|
|
75
93
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
76
94
|
* authentication</a>.</p>
|
|
77
95
|
*/
|
|
@@ -79,17 +97,25 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
79
97
|
getAttachment(args: GetAttachmentCommandInput, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
|
|
80
98
|
getAttachment(args: GetAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
|
|
81
99
|
/**
|
|
82
|
-
* <p>Retrieves a transcript of the session, including details about any attachments.
|
|
83
|
-
*
|
|
84
|
-
*
|
|
100
|
+
* <p>Retrieves a transcript of the session, including details about any attachments. </p>
|
|
101
|
+
* <note>
|
|
102
|
+
* <p>
|
|
103
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
104
|
+
* <code>ParticipantToken</code>.</p>
|
|
105
|
+
* </note>
|
|
106
|
+
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
85
107
|
* authentication</a>.</p>
|
|
86
108
|
*/
|
|
87
109
|
getTranscript(args: GetTranscriptCommandInput, options?: __HttpHandlerOptions): Promise<GetTranscriptCommandOutput>;
|
|
88
110
|
getTranscript(args: GetTranscriptCommandInput, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
|
|
89
111
|
getTranscript(args: GetTranscriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
|
|
90
112
|
/**
|
|
91
|
-
* <p>Sends an event.
|
|
92
|
-
*
|
|
113
|
+
* <p>Sends an event. </p>
|
|
114
|
+
* <note>
|
|
115
|
+
* <p>
|
|
116
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
117
|
+
* <code>ParticipantToken</code>.</p>
|
|
118
|
+
* </note>
|
|
93
119
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
94
120
|
* authentication</a>.</p>
|
|
95
121
|
*/
|
|
@@ -97,8 +123,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
97
123
|
sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void;
|
|
98
124
|
sendEvent(args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void): void;
|
|
99
125
|
/**
|
|
100
|
-
* <p>Sends a message
|
|
101
|
-
*
|
|
126
|
+
* <p>Sends a message.</p>
|
|
127
|
+
* <note>
|
|
128
|
+
* <p>
|
|
129
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
130
|
+
* <code>ParticipantToken</code>.</p>
|
|
131
|
+
* </note>
|
|
102
132
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
103
133
|
* authentication</a>.</p>
|
|
104
134
|
*/
|
|
@@ -108,6 +138,11 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
108
138
|
/**
|
|
109
139
|
* <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
|
|
110
140
|
* S3.</p>
|
|
141
|
+
* <note>
|
|
142
|
+
* <p>
|
|
143
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
144
|
+
* <code>ParticipantToken</code>.</p>
|
|
145
|
+
* </note>
|
|
111
146
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
112
147
|
* authentication</a>.</p>
|
|
113
148
|
*/
|
|
@@ -132,10 +132,8 @@ export interface ConnectParticipantClientResolvedConfig extends ConnectParticipa
|
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
134
|
* <p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
|
|
135
|
-
* a customer contact center
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
* <p>The APIs described here are used by chat participants, such as agents and
|
|
135
|
+
* a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use
|
|
136
|
+
* the Amazon Connect Participant Service to manage chat participants, such as agents and
|
|
139
137
|
* customers.</p>
|
|
140
138
|
*/
|
|
141
139
|
export declare class ConnectParticipantClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectParticipantClientResolvedConfig> {
|
|
@@ -10,6 +10,11 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
|
|
12
12
|
* provided in StartAttachmentUpload API. </p>
|
|
13
|
+
* <note>
|
|
14
|
+
* <p>
|
|
15
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
16
|
+
* <code>ParticipantToken</code>.</p>
|
|
17
|
+
* </note>
|
|
13
18
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
19
|
* authentication</a>.</p>
|
|
15
20
|
* @example
|
|
@@ -8,32 +8,38 @@ export interface CreateParticipantConnectionCommandInput extends CreateParticipa
|
|
|
8
8
|
export interface CreateParticipantConnectionCommandOutput extends CreateParticipantConnectionResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates the participant's connection.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* <p>Creates the participant's connection. </p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>ParticipantToken</code> is used for invoking this API instead of
|
|
15
|
+
* <code>ConnectionToken</code>.</p>
|
|
16
|
+
* </note>
|
|
17
|
+
* <p>The participant token is valid for the lifetime of the participant – until they are
|
|
18
|
+
* part of a contact.</p>
|
|
19
|
+
* <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
|
|
16
20
|
* Clients must manually connect to the returned websocket URL and subscribe to the desired
|
|
17
21
|
* topic. </p>
|
|
18
|
-
*
|
|
22
|
+
* <p>For chat, you need to publish the following on the established websocket
|
|
19
23
|
* connection:</p>
|
|
20
|
-
*
|
|
24
|
+
* <p>
|
|
21
25
|
* <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
|
|
22
26
|
* </p>
|
|
23
|
-
*
|
|
27
|
+
* <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
|
|
24
28
|
* clients need to call this API again to obtain a new websocket URL and perform the same
|
|
25
29
|
* steps as before.</p>
|
|
26
|
-
*
|
|
27
|
-
* <b>Message streaming support</b>: This API can also be used
|
|
28
|
-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
30
|
+
* <p>
|
|
31
|
+
* <b>Message streaming support</b>: This API can also be used
|
|
32
|
+
* together with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API to create a participant connection for chat
|
|
33
|
+
* contacts that are not using a websocket. For more information about message streaming,
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat
|
|
35
|
+
* message streaming</a> in the <i>Amazon Connect Administrator
|
|
36
|
+
* Guide</i>.</p>
|
|
37
|
+
* <p>
|
|
38
|
+
* <b>Feature specifications</b>: For information about feature
|
|
39
|
+
* specifications, such as the allowed number of open websocket connections per
|
|
40
|
+
* participant, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator
|
|
35
41
|
* Guide</i>. </p>
|
|
36
|
-
*
|
|
42
|
+
* <note>
|
|
37
43
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
38
44
|
* authentication</a>.</p>
|
|
39
45
|
* </note>
|
|
@@ -8,8 +8,12 @@ export interface DisconnectParticipantCommandInput extends DisconnectParticipant
|
|
|
8
8
|
export interface DisconnectParticipantCommandOutput extends DisconnectParticipantResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Disconnects a participant.
|
|
12
|
-
*
|
|
11
|
+
* <p>Disconnects a participant. </p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
15
|
+
* <code>ParticipantToken</code>.</p>
|
|
16
|
+
* </note>
|
|
13
17
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
18
|
* authentication</a>.</p>
|
|
15
19
|
* @example
|
|
@@ -10,6 +10,11 @@ export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a pre-signed URL for download of a completed attachment. This is an
|
|
12
12
|
* asynchronous API for use with active contacts.</p>
|
|
13
|
+
* <note>
|
|
14
|
+
* <p>
|
|
15
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
16
|
+
* <code>ParticipantToken</code>.</p>
|
|
17
|
+
* </note>
|
|
13
18
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
19
|
* authentication</a>.</p>
|
|
15
20
|
* @example
|
|
@@ -8,9 +8,13 @@ export interface GetTranscriptCommandInput extends GetTranscriptRequest {
|
|
|
8
8
|
export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves a transcript of the session, including details about any attachments.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Retrieves a transcript of the session, including details about any attachments. </p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
15
|
+
* <code>ParticipantToken</code>.</p>
|
|
16
|
+
* </note>
|
|
17
|
+
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
18
|
* authentication</a>.</p>
|
|
15
19
|
* @example
|
|
16
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,8 +8,12 @@ export interface SendEventCommandInput extends SendEventRequest {
|
|
|
8
8
|
export interface SendEventCommandOutput extends SendEventResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Sends an event.
|
|
12
|
-
*
|
|
11
|
+
* <p>Sends an event. </p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
15
|
+
* <code>ParticipantToken</code>.</p>
|
|
16
|
+
* </note>
|
|
13
17
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
18
|
* authentication</a>.</p>
|
|
15
19
|
* @example
|
|
@@ -8,8 +8,12 @@ export interface SendMessageCommandInput extends SendMessageRequest {
|
|
|
8
8
|
export interface SendMessageCommandOutput extends SendMessageResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Sends a message
|
|
12
|
-
*
|
|
11
|
+
* <p>Sends a message.</p>
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>
|
|
14
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
15
|
+
* <code>ParticipantToken</code>.</p>
|
|
16
|
+
* </note>
|
|
13
17
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
18
|
* authentication</a>.</p>
|
|
15
19
|
* @example
|
|
@@ -10,6 +10,11 @@ export interface StartAttachmentUploadCommandOutput extends StartAttachmentUploa
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
|
|
12
12
|
* S3.</p>
|
|
13
|
+
* <note>
|
|
14
|
+
* <p>
|
|
15
|
+
* <code>ConnectionToken</code> is used for invoking this API instead of
|
|
16
|
+
* <code>ParticipantToken</code>.</p>
|
|
17
|
+
* </note>
|
|
13
18
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
14
19
|
* authentication</a>.</p>
|
|
15
20
|
* @example
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -19,7 +19,9 @@ export interface CompleteAttachmentUploadRequest {
|
|
|
19
19
|
AttachmentIds: string[] | undefined;
|
|
20
20
|
/**
|
|
21
21
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
22
|
-
* request
|
|
22
|
+
* request. If not provided, the Amazon Web Services
|
|
23
|
+
* SDK populates this field. For more information about idempotency, see
|
|
24
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
23
25
|
*/
|
|
24
26
|
ClientToken?: string;
|
|
25
27
|
/**
|
|
@@ -95,12 +97,13 @@ export declare enum ConnectionType {
|
|
|
95
97
|
}
|
|
96
98
|
export interface CreateParticipantConnectionRequest {
|
|
97
99
|
/**
|
|
98
|
-
* <p>Type of connection information required
|
|
100
|
+
* <p>Type of connection information required. This can be omitted if
|
|
101
|
+
* <code>ConnectParticipant</code> is <code>true</code>.</p>
|
|
99
102
|
*/
|
|
100
|
-
Type
|
|
103
|
+
Type?: (ConnectionType | string)[];
|
|
101
104
|
/**
|
|
102
105
|
* <p>This is a header parameter.</p>
|
|
103
|
-
*
|
|
106
|
+
* <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a>
|
|
104
107
|
* API response.</p>
|
|
105
108
|
*/
|
|
106
109
|
ParticipantToken: string | undefined;
|
|
@@ -120,7 +123,7 @@ export interface ConnectionCredentials {
|
|
|
120
123
|
ConnectionToken?: string;
|
|
121
124
|
/**
|
|
122
125
|
* <p>The expiration of the token.</p>
|
|
123
|
-
*
|
|
126
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
124
127
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
125
128
|
*/
|
|
126
129
|
Expiry?: string;
|
|
@@ -135,7 +138,7 @@ export interface Websocket {
|
|
|
135
138
|
Url?: string;
|
|
136
139
|
/**
|
|
137
140
|
* <p>The URL expiration timestamp in ISO date format.</p>
|
|
138
|
-
*
|
|
141
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
139
142
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
140
143
|
*/
|
|
141
144
|
ConnectionExpiry?: string;
|
|
@@ -154,7 +157,9 @@ export interface CreateParticipantConnectionResponse {
|
|
|
154
157
|
export interface DisconnectParticipantRequest {
|
|
155
158
|
/**
|
|
156
159
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
157
|
-
* request
|
|
160
|
+
* request. If not provided, the Amazon Web Services
|
|
161
|
+
* SDK populates this field. For more information about idempotency, see
|
|
162
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
158
163
|
*/
|
|
159
164
|
ClientToken?: string;
|
|
160
165
|
/**
|
|
@@ -204,7 +209,7 @@ export interface StartPosition {
|
|
|
204
209
|
Id?: string;
|
|
205
210
|
/**
|
|
206
211
|
* <p>The time in ISO format where to start.</p>
|
|
207
|
-
*
|
|
212
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
208
213
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
209
214
|
*/
|
|
210
215
|
AbsoluteTime?: string;
|
|
@@ -256,7 +261,7 @@ export declare enum ArtifactStatus {
|
|
|
256
261
|
*/
|
|
257
262
|
export interface AttachmentItem {
|
|
258
263
|
/**
|
|
259
|
-
* <p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
264
|
+
* <p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
260
265
|
*/
|
|
261
266
|
ContentType?: string;
|
|
262
267
|
/**
|
|
@@ -272,6 +277,36 @@ export interface AttachmentItem {
|
|
|
272
277
|
*/
|
|
273
278
|
Status?: ArtifactStatus | string;
|
|
274
279
|
}
|
|
280
|
+
/**
|
|
281
|
+
* <p>The receipt for the message delivered to the recipient.</p>
|
|
282
|
+
*/
|
|
283
|
+
export interface Receipt {
|
|
284
|
+
/**
|
|
285
|
+
* <p>The time when the message was delivered to the recipient.</p>
|
|
286
|
+
*/
|
|
287
|
+
DeliveredTimestamp?: string;
|
|
288
|
+
/**
|
|
289
|
+
* <p>The time when the message was read by the recipient.</p>
|
|
290
|
+
*/
|
|
291
|
+
ReadTimestamp?: string;
|
|
292
|
+
/**
|
|
293
|
+
* <p>The identifier of the recipient of the message. </p>
|
|
294
|
+
*/
|
|
295
|
+
RecipientParticipantId?: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* <p>Contains metadata related to a message.</p>
|
|
299
|
+
*/
|
|
300
|
+
export interface MessageMetadata {
|
|
301
|
+
/**
|
|
302
|
+
* <p>The identifier of the message that contains the metadata information. </p>
|
|
303
|
+
*/
|
|
304
|
+
MessageId?: string;
|
|
305
|
+
/**
|
|
306
|
+
* <p>The list of receipt information for a message for different recipients.</p>
|
|
307
|
+
*/
|
|
308
|
+
Receipts?: Receipt[];
|
|
309
|
+
}
|
|
275
310
|
export declare enum ParticipantRole {
|
|
276
311
|
AGENT = "AGENT",
|
|
277
312
|
CUSTOMER = "CUSTOMER",
|
|
@@ -283,6 +318,8 @@ export declare enum ChatItemType {
|
|
|
283
318
|
CONNECTION_ACK = "CONNECTION_ACK",
|
|
284
319
|
EVENT = "EVENT",
|
|
285
320
|
MESSAGE = "MESSAGE",
|
|
321
|
+
MESSAGE_DELIVERED = "MESSAGE_DELIVERED",
|
|
322
|
+
MESSAGE_READ = "MESSAGE_READ",
|
|
286
323
|
PARTICIPANT_JOINED = "PARTICIPANT_JOINED",
|
|
287
324
|
PARTICIPANT_LEFT = "PARTICIPANT_LEFT",
|
|
288
325
|
TRANSFER_FAILED = "TRANSFER_FAILED",
|
|
@@ -295,7 +332,7 @@ export declare enum ChatItemType {
|
|
|
295
332
|
export interface Item {
|
|
296
333
|
/**
|
|
297
334
|
* <p>The time when the message or event was sent.</p>
|
|
298
|
-
*
|
|
335
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
299
336
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
300
337
|
*/
|
|
301
338
|
AbsoluteTime?: string;
|
|
@@ -331,6 +368,11 @@ export interface Item {
|
|
|
331
368
|
* <p>Provides information about the attachments.</p>
|
|
332
369
|
*/
|
|
333
370
|
Attachments?: AttachmentItem[];
|
|
371
|
+
/**
|
|
372
|
+
* <p>The metadata related to the message. Currently this supports only information related to
|
|
373
|
+
* message receipts.</p>
|
|
374
|
+
*/
|
|
375
|
+
MessageMetadata?: MessageMetadata;
|
|
334
376
|
}
|
|
335
377
|
export interface GetTranscriptResponse {
|
|
336
378
|
/**
|
|
@@ -350,25 +392,33 @@ export interface GetTranscriptResponse {
|
|
|
350
392
|
export interface SendEventRequest {
|
|
351
393
|
/**
|
|
352
394
|
* <p>The content type of the request. Supported types are:</p>
|
|
353
|
-
*
|
|
354
|
-
*
|
|
395
|
+
* <ul>
|
|
396
|
+
* <li>
|
|
397
|
+
* <p>application/vnd.amazonaws.connect.event.typing</p>
|
|
398
|
+
* </li>
|
|
399
|
+
* <li>
|
|
400
|
+
* <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>
|
|
401
|
+
* </li>
|
|
355
402
|
* <li>
|
|
356
|
-
*
|
|
403
|
+
* <p>application/vnd.amazonaws.connect.event.message.delivered</p>
|
|
357
404
|
* </li>
|
|
358
405
|
* <li>
|
|
359
|
-
*
|
|
406
|
+
* <p>application/vnd.amazonaws.connect.event.message.read</p>
|
|
360
407
|
* </li>
|
|
361
408
|
* </ul>
|
|
362
409
|
*/
|
|
363
410
|
ContentType: string | undefined;
|
|
364
411
|
/**
|
|
365
|
-
* <p>The content of the event to be sent (for example, message text).
|
|
366
|
-
* supported.</p>
|
|
412
|
+
* <p>The content of the event to be sent (for example, message text). For content related
|
|
413
|
+
* to message receipts, this is supported in the form of a JSON string.</p>
|
|
414
|
+
* <p>Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"</p>
|
|
367
415
|
*/
|
|
368
416
|
Content?: string;
|
|
369
417
|
/**
|
|
370
418
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
371
|
-
* request
|
|
419
|
+
* request. If not provided, the Amazon Web Services
|
|
420
|
+
* SDK populates this field. For more information about idempotency, see
|
|
421
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
372
422
|
*/
|
|
373
423
|
ClientToken?: string;
|
|
374
424
|
/**
|
|
@@ -383,23 +433,36 @@ export interface SendEventResponse {
|
|
|
383
433
|
Id?: string;
|
|
384
434
|
/**
|
|
385
435
|
* <p>The time when the event was sent.</p>
|
|
386
|
-
*
|
|
436
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
387
437
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
388
438
|
*/
|
|
389
439
|
AbsoluteTime?: string;
|
|
390
440
|
}
|
|
391
441
|
export interface SendMessageRequest {
|
|
392
442
|
/**
|
|
393
|
-
* <p>The type of the content. Supported types are text/plain
|
|
443
|
+
* <p>The type of the content. Supported types are <code>text/plain</code>,
|
|
444
|
+
* <code>text/markdown</code>, and <code>application/json</code>.</p>
|
|
394
445
|
*/
|
|
395
446
|
ContentType: string | undefined;
|
|
396
447
|
/**
|
|
397
|
-
* <p>The content of the message
|
|
448
|
+
* <p>The content of the message. </p>
|
|
449
|
+
* <ul>
|
|
450
|
+
* <li>
|
|
451
|
+
* <p>For <code>text/plain</code> and <code>text/markdown</code>, the Length
|
|
452
|
+
* Constraints are Minimum of 1, Maximum of 1024. </p>
|
|
453
|
+
* </li>
|
|
454
|
+
* <li>
|
|
455
|
+
* <p>For <code>application/json</code>, the Length Constraints are Minimum of 1,
|
|
456
|
+
* Maximum of 12000. </p>
|
|
457
|
+
* </li>
|
|
458
|
+
* </ul>
|
|
398
459
|
*/
|
|
399
460
|
Content: string | undefined;
|
|
400
461
|
/**
|
|
401
462
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
402
|
-
* request
|
|
463
|
+
* request. If not provided, the Amazon Web Services
|
|
464
|
+
* SDK populates this field. For more information about idempotency, see
|
|
465
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
403
466
|
*/
|
|
404
467
|
ClientToken?: string;
|
|
405
468
|
/**
|
|
@@ -414,14 +477,14 @@ export interface SendMessageResponse {
|
|
|
414
477
|
Id?: string;
|
|
415
478
|
/**
|
|
416
479
|
* <p>The time when the message was sent.</p>
|
|
417
|
-
*
|
|
480
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
418
481
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
419
482
|
*/
|
|
420
483
|
AbsoluteTime?: string;
|
|
421
484
|
}
|
|
422
485
|
export interface StartAttachmentUploadRequest {
|
|
423
486
|
/**
|
|
424
|
-
* <p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
487
|
+
* <p>Describes the MIME file type of the attachment. For a list of supported file types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
425
488
|
*/
|
|
426
489
|
ContentType: string | undefined;
|
|
427
490
|
/**
|
|
@@ -433,7 +496,10 @@ export interface StartAttachmentUploadRequest {
|
|
|
433
496
|
*/
|
|
434
497
|
AttachmentName: string | undefined;
|
|
435
498
|
/**
|
|
436
|
-
* <p>A unique case
|
|
499
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
500
|
+
* request. If not provided, the Amazon Web Services
|
|
501
|
+
* SDK populates this field. For more information about idempotency, see
|
|
502
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
437
503
|
*/
|
|
438
504
|
ClientToken?: string;
|
|
439
505
|
/**
|
|
@@ -521,6 +587,14 @@ export declare const GetTranscriptRequestFilterSensitiveLog: (obj: GetTranscript
|
|
|
521
587
|
* @internal
|
|
522
588
|
*/
|
|
523
589
|
export declare const AttachmentItemFilterSensitiveLog: (obj: AttachmentItem) => any;
|
|
590
|
+
/**
|
|
591
|
+
* @internal
|
|
592
|
+
*/
|
|
593
|
+
export declare const ReceiptFilterSensitiveLog: (obj: Receipt) => any;
|
|
594
|
+
/**
|
|
595
|
+
* @internal
|
|
596
|
+
*/
|
|
597
|
+
export declare const MessageMetadataFilterSensitiveLog: (obj: MessageMetadata) => any;
|
|
524
598
|
/**
|
|
525
599
|
* @internal
|
|
526
600
|
*/
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|
|
@@ -57,7 +57,7 @@ export declare enum ConnectionType {
|
|
|
57
57
|
WEBSOCKET = "WEBSOCKET",
|
|
58
58
|
}
|
|
59
59
|
export interface CreateParticipantConnectionRequest {
|
|
60
|
-
Type
|
|
60
|
+
Type?: (ConnectionType | string)[];
|
|
61
61
|
ParticipantToken: string | undefined;
|
|
62
62
|
ConnectParticipant?: boolean;
|
|
63
63
|
}
|
|
@@ -119,6 +119,15 @@ export interface AttachmentItem {
|
|
|
119
119
|
AttachmentName?: string;
|
|
120
120
|
Status?: ArtifactStatus | string;
|
|
121
121
|
}
|
|
122
|
+
export interface Receipt {
|
|
123
|
+
DeliveredTimestamp?: string;
|
|
124
|
+
ReadTimestamp?: string;
|
|
125
|
+
RecipientParticipantId?: string;
|
|
126
|
+
}
|
|
127
|
+
export interface MessageMetadata {
|
|
128
|
+
MessageId?: string;
|
|
129
|
+
Receipts?: Receipt[];
|
|
130
|
+
}
|
|
122
131
|
export declare enum ParticipantRole {
|
|
123
132
|
AGENT = "AGENT",
|
|
124
133
|
CUSTOMER = "CUSTOMER",
|
|
@@ -130,6 +139,8 @@ export declare enum ChatItemType {
|
|
|
130
139
|
CONNECTION_ACK = "CONNECTION_ACK",
|
|
131
140
|
EVENT = "EVENT",
|
|
132
141
|
MESSAGE = "MESSAGE",
|
|
142
|
+
MESSAGE_DELIVERED = "MESSAGE_DELIVERED",
|
|
143
|
+
MESSAGE_READ = "MESSAGE_READ",
|
|
133
144
|
PARTICIPANT_JOINED = "PARTICIPANT_JOINED",
|
|
134
145
|
PARTICIPANT_LEFT = "PARTICIPANT_LEFT",
|
|
135
146
|
TRANSFER_FAILED = "TRANSFER_FAILED",
|
|
@@ -146,6 +157,7 @@ export interface Item {
|
|
|
146
157
|
DisplayName?: string;
|
|
147
158
|
ParticipantRole?: ParticipantRole | string;
|
|
148
159
|
Attachments?: AttachmentItem[];
|
|
160
|
+
MessageMetadata?: MessageMetadata;
|
|
149
161
|
}
|
|
150
162
|
export interface GetTranscriptResponse {
|
|
151
163
|
InitialContactId?: string;
|
|
@@ -225,6 +237,10 @@ export declare const GetTranscriptRequestFilterSensitiveLog: (
|
|
|
225
237
|
export declare const AttachmentItemFilterSensitiveLog: (
|
|
226
238
|
obj: AttachmentItem
|
|
227
239
|
) => any;
|
|
240
|
+
export declare const ReceiptFilterSensitiveLog: (obj: Receipt) => any;
|
|
241
|
+
export declare const MessageMetadataFilterSensitiveLog: (
|
|
242
|
+
obj: MessageMetadata
|
|
243
|
+
) => any;
|
|
228
244
|
export declare const ItemFilterSensitiveLog: (obj: Item) => any;
|
|
229
245
|
export declare const GetTranscriptResponseFilterSensitiveLog: (
|
|
230
246
|
obj: GetTranscriptResponse
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-connectparticipant",
|
|
3
3
|
"description": "AWS SDK for JavaScript Connectparticipant Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.238.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",
|
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
"build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build",
|
|
11
11
|
"build:types": "tsc -p tsconfig.types.json",
|
|
12
12
|
"build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
|
|
13
|
-
"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo"
|
|
13
|
+
"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
|
|
14
|
+
"generate:client": "(cd ../../ && yarn generate-clients -g ./codegen/sdk-codegen/aws-models/connectparticipant.json --keepFiles)"
|
|
14
15
|
},
|
|
15
16
|
"main": "./dist-cjs/index.js",
|
|
16
17
|
"types": "./dist-types/index.d.ts",
|
|
@@ -19,9 +20,9 @@
|
|
|
19
20
|
"dependencies": {
|
|
20
21
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
22
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.238.0",
|
|
23
24
|
"@aws-sdk/config-resolver": "3.234.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.238.0",
|
|
25
26
|
"@aws-sdk/fetch-http-handler": "3.226.0",
|
|
26
27
|
"@aws-sdk/hash-node": "3.226.0",
|
|
27
28
|
"@aws-sdk/invalid-dependency": "3.226.0",
|