@aws-sdk/client-connectparticipant 3.236.0 → 3.241.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 CHANGED
@@ -10,9 +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 and provide reliable customer engagement at any scale.</p>
14
- <p>Amazon Connect enables customer contacts through voice or chat.</p>
15
- <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
16
15
  customers.</p>
17
16
 
18
17
  ## Installing
@@ -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)
@@ -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,15 +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 and provide reliable customer engagement at any scale.</p>
14
- * <p>Amazon Connect enables customer contacts through voice or chat.</p>
15
- * <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
16
15
  * customers.</p>
17
16
  */
18
17
  export declare class ConnectParticipant extends ConnectParticipantClient {
19
18
  /**
20
19
  * <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
21
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>
22
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
23
27
  * authentication</a>.</p>
24
28
  */
@@ -26,10 +30,14 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
26
30
  completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
27
31
  completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
28
32
  /**
29
- * <p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of
30
- * ConnectionToken.</p>
31
- * <p>The participant token is valid for the lifetime of the participant –
32
- * until they are part of a contact.</p>
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>
33
41
  * <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
34
42
  * Clients must manually connect to the returned websocket URL and subscribe to the desired
35
43
  * topic. </p>
@@ -42,14 +50,16 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
42
50
  * clients need to call this API again to obtain a new websocket URL and perform the same
43
51
  * steps as before.</p>
44
52
  * <p>
45
- * <b>Message streaming support</b>: This API can also be used together with the
46
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
47
- * API to create a participant connection for chat contacts that are
48
- * not using a websocket. For more information about message streaming, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message streaming</a> in the <i>Amazon Connect
49
- * Administrator Guide</i>.</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>
50
59
  * <p>
51
- * <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open
52
- * websocket connections per 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
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
53
63
  * Guide</i>. </p>
54
64
  * <note>
55
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
@@ -60,8 +70,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
60
70
  createParticipantConnection(args: CreateParticipantConnectionCommandInput, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
61
71
  createParticipantConnection(args: CreateParticipantConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
62
72
  /**
63
- * <p>Disconnects a participant. Note that ConnectionToken is used for invoking this API
64
- * instead of ParticipantToken.</p>
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>
65
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
66
80
  * authentication</a>.</p>
67
81
  */
@@ -71,6 +85,11 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
71
85
  /**
72
86
  * <p>Provides a pre-signed URL for download of a completed attachment. This is an
73
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>
74
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
75
94
  * authentication</a>.</p>
76
95
  */
@@ -78,8 +97,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
78
97
  getAttachment(args: GetAttachmentCommandInput, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
79
98
  getAttachment(args: GetAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
80
99
  /**
81
- * <p>Retrieves a transcript of the session, including details about any attachments. Note
82
- * that ConnectionToken is used for invoking this API instead of ParticipantToken.</p>
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>
83
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
84
107
  * authentication</a>.</p>
85
108
  */
@@ -87,8 +110,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
87
110
  getTranscript(args: GetTranscriptCommandInput, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
88
111
  getTranscript(args: GetTranscriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
89
112
  /**
90
- * <p>Sends an event. Note that ConnectionToken is used for invoking this API instead of
91
- * ParticipantToken.</p>
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>
92
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
93
120
  * authentication</a>.</p>
94
121
  */
@@ -96,8 +123,12 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
96
123
  sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void;
97
124
  sendEvent(args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void): void;
98
125
  /**
99
- * <p>Sends a message. Note that ConnectionToken is used for invoking this API instead of
100
- * ParticipantToken.</p>
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>
101
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
102
133
  * authentication</a>.</p>
103
134
  */
@@ -107,6 +138,11 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
107
138
  /**
108
139
  * <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
109
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>
110
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
111
147
  * authentication</a>.</p>
112
148
  */
@@ -132,9 +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 and provide reliable customer engagement at any scale.</p>
136
- * <p>Amazon Connect enables customer contacts through voice or chat.</p>
137
- * <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
138
137
  * customers.</p>
139
138
  */
140
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,10 +8,14 @@ export interface CreateParticipantConnectionCommandInput extends CreateParticipa
8
8
  export interface CreateParticipantConnectionCommandOutput extends CreateParticipantConnectionResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of
12
- * ConnectionToken.</p>
13
- * <p>The participant token is valid for the lifetime of the participant –
14
- * until they are part of a contact.</p>
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>
15
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>
@@ -24,14 +28,16 @@ export interface CreateParticipantConnectionCommandOutput extends CreateParticip
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
30
  * <p>
27
- * <b>Message streaming support</b>: This API can also be used together with the
28
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
29
- * API to create a participant connection for chat contacts that are
30
- * not using a websocket. For more information about message streaming, <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message streaming</a> in the <i>Amazon Connect
31
- * Administrator Guide</i>.</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>
32
37
  * <p>
33
- * <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open
34
- * websocket connections per 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
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
@@ -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. Note that ConnectionToken is used for invoking this API
12
- * instead of ParticipantToken.</p>
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,8 +8,12 @@ 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. Note
12
- * that ConnectionToken is used for invoking this API instead of ParticipantToken.</p>
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>
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 SendEventCommandInput extends SendEventRequest {
8
8
  export interface SendEventCommandOutput extends SendEventResponse, __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Sends an event. Note that ConnectionToken is used for invoking this API instead of
12
- * ParticipantToken.</p>
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. Note that ConnectionToken is used for invoking this API instead of
12
- * ParticipantToken.</p>
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
@@ -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.</p>
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,9 +97,10 @@ export declare enum ConnectionType {
95
97
  }
96
98
  export interface CreateParticipantConnectionRequest {
97
99
  /**
98
- * <p>Type of connection information required.</p>
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: (ConnectionType | string)[] | undefined;
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>
@@ -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.</p>
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
  /**
@@ -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/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
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",
@@ -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
  /**
@@ -357,17 +399,26 @@ export interface SendEventRequest {
357
399
  * <li>
358
400
  * <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>
359
401
  * </li>
402
+ * <li>
403
+ * <p>application/vnd.amazonaws.connect.event.message.delivered</p>
404
+ * </li>
405
+ * <li>
406
+ * <p>application/vnd.amazonaws.connect.event.message.read</p>
407
+ * </li>
360
408
  * </ul>
361
409
  */
362
410
  ContentType: string | undefined;
363
411
  /**
364
- * <p>The content of the event to be sent (for example, message text). This is not yet
365
- * 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>
366
415
  */
367
416
  Content?: string;
368
417
  /**
369
418
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
370
- * request.</p>
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>
371
422
  */
372
423
  ClientToken?: string;
373
424
  /**
@@ -389,16 +440,29 @@ export interface SendEventResponse {
389
440
  }
390
441
  export interface SendMessageRequest {
391
442
  /**
392
- * <p>The type of the content. Supported types are text/plain.</p>
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>
393
445
  */
394
446
  ContentType: string | undefined;
395
447
  /**
396
- * <p>The content of the message.</p>
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>
397
459
  */
398
460
  Content: string | undefined;
399
461
  /**
400
462
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
401
- * request.</p>
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>
402
466
  */
403
467
  ClientToken?: string;
404
468
  /**
@@ -420,7 +484,7 @@ export interface SendMessageResponse {
420
484
  }
421
485
  export interface StartAttachmentUploadRequest {
422
486
  /**
423
- * <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/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
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>
424
488
  */
425
489
  ContentType: string | undefined;
426
490
  /**
@@ -432,7 +496,10 @@ export interface StartAttachmentUploadRequest {
432
496
  */
433
497
  AttachmentName: string | undefined;
434
498
  /**
435
- * <p>A unique case sensitive identifier to support idempotency of request.</p>
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>
436
503
  */
437
504
  ClientToken?: string;
438
505
  /**
@@ -520,6 +587,14 @@ export declare const GetTranscriptRequestFilterSensitiveLog: (obj: GetTranscript
520
587
  * @internal
521
588
  */
522
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;
523
598
  /**
524
599
  * @internal
525
600
  */
@@ -57,7 +57,7 @@ export declare enum ConnectionType {
57
57
  WEBSOCKET = "WEBSOCKET",
58
58
  }
59
59
  export interface CreateParticipantConnectionRequest {
60
- Type: (ConnectionType | string)[] | undefined;
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.236.0",
4
+ "version": "3.241.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.236.0",
23
+ "@aws-sdk/client-sts": "3.241.0",
23
24
  "@aws-sdk/config-resolver": "3.234.0",
24
- "@aws-sdk/credential-provider-node": "3.236.0",
25
+ "@aws-sdk/credential-provider-node": "3.241.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",
@@ -46,7 +47,7 @@
46
47
  "@aws-sdk/util-body-length-node": "3.208.0",
47
48
  "@aws-sdk/util-defaults-mode-browser": "3.234.0",
48
49
  "@aws-sdk/util-defaults-mode-node": "3.234.0",
49
- "@aws-sdk/util-endpoints": "3.226.0",
50
+ "@aws-sdk/util-endpoints": "3.241.0",
50
51
  "@aws-sdk/util-retry": "3.229.0",
51
52
  "@aws-sdk/util-user-agent-browser": "3.226.0",
52
53
  "@aws-sdk/util-user-agent-node": "3.226.0",