@aws-sdk/client-connectparticipant 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -18,10 +18,12 @@ export declare class AccessDeniedException extends __BaseException {
  */
 export interface CompleteAttachmentUploadRequest {
     /**
+     * @public
      * <p>A list of unique identifiers for the attachments.</p>
      */
     AttachmentIds: string[] | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -29,6 +31,7 @@ export interface CompleteAttachmentUploadRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -120,17 +123,20 @@ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType
  */
 export interface CreateParticipantConnectionRequest {
     /**
+     * @public
      * <p>Type of connection information required. This can be omitted if
      *                 <code>ConnectParticipant</code> is <code>true</code>.</p>
      */
     Type?: (ConnectionType | string)[];
     /**
+     * @public
      * <p>This is a header parameter.</p>
      *          <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a>
      *             API response.</p>
      */
     ParticipantToken: string | undefined;
     /**
+     * @public
      * <p>Amazon Connect Participant is used to mark the participant as connected for customer
      *             participant in message streaming, as well as for agent or manager participant in
      *             non-streaming chats.</p>
@@ -143,10 +149,12 @@ export interface CreateParticipantConnectionRequest {
  */
 export interface ConnectionCredentials {
     /**
+     * @public
      * <p>The connection token.</p>
      */
     ConnectionToken?: string;
     /**
+     * @public
      * <p>The expiration of the token.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
@@ -159,10 +167,12 @@ export interface ConnectionCredentials {
  */
 export interface Websocket {
     /**
+     * @public
      * <p>The URL of the websocket.</p>
      */
     Url?: string;
     /**
+     * @public
      * <p>The URL expiration timestamp in ISO date format.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
@@ -174,10 +184,12 @@ export interface Websocket {
  */
 export interface CreateParticipantConnectionResponse {
     /**
+     * @public
      * <p>Creates the participant's websocket connection.</p>
      */
     Websocket?: Websocket;
     /**
+     * @public
      * <p>Creates the participant's connection credentials. The authentication token associated
      *             with the participant's connection.</p>
      */
@@ -188,6 +200,7 @@ export interface CreateParticipantConnectionResponse {
  */
 export interface DisconnectParticipantRequest {
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -195,6 +208,7 @@ export interface DisconnectParticipantRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -209,10 +223,12 @@ export interface DisconnectParticipantResponse {
  */
 export interface GetAttachmentRequest {
     /**
+     * @public
      * <p>A unique identifier for the attachment.</p>
      */
     AttachmentId: string | undefined;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -222,11 +238,13 @@ export interface GetAttachmentRequest {
  */
 export interface GetAttachmentResponse {
     /**
+     * @public
      * <p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response
      * to <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html">StartAttachmentUpload</a>.</p>
      */
     Url?: string;
     /**
+     * @public
      * <p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>
      */
     UrlExpiry?: string;
@@ -262,16 +280,19 @@ export type SortKey = (typeof SortKey)[keyof typeof SortKey];
  */
 export interface StartPosition {
     /**
+     * @public
      * <p>The ID of the message or event where to start. </p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The time in ISO format where to start.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
      */
     AbsoluteTime?: string;
     /**
+     * @public
      * <p>The start position of the most recent message where you want to start. </p>
      */
     MostRecent?: number;
@@ -281,32 +302,39 @@ export interface StartPosition {
  */
 export interface GetTranscriptRequest {
     /**
+     * @public
      * <p>The contactId from the current contact chain for which transcript is needed.</p>
      */
     ContactId?: string;
     /**
+     * @public
      * <p>The maximum number of results to return in the page. Default: 10. </p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>The pagination token. Use the value returned previously in the next subsequent request
      *             to retrieve the next set of results.</p>
      */
     NextToken?: string;
     /**
+     * @public
      * <p>The direction from StartPosition from which to retrieve message. Default: BACKWARD
      *             when no StartPosition is provided, FORWARD with StartPosition. </p>
      */
     ScanDirection?: ScanDirection | string;
     /**
+     * @public
      * <p>The sort order for the records. Default: DESCENDING.</p>
      */
     SortOrder?: SortKey | string;
     /**
+     * @public
      * <p>A filtering option for where to start.</p>
      */
     StartPosition?: StartPosition;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -331,18 +359,22 @@ export type ArtifactStatus = (typeof ArtifactStatus)[keyof typeof ArtifactStatus
  */
 export interface AttachmentItem {
     /**
+     * @public
      * <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>
      */
     ContentType?: string;
     /**
+     * @public
      * <p>A unique identifier for the attachment.</p>
      */
     AttachmentId?: string;
     /**
+     * @public
      * <p>A case-sensitive name of the attachment being uploaded.</p>
      */
     AttachmentName?: string;
     /**
+     * @public
      * <p>Status of the attachment.</p>
      */
     Status?: ArtifactStatus | string;
@@ -353,14 +385,17 @@ export interface AttachmentItem {
  */
 export interface Receipt {
     /**
+     * @public
      * <p>The time when the message was delivered to the recipient.</p>
      */
     DeliveredTimestamp?: string;
     /**
+     * @public
      * <p>The time when the message was read by the recipient.</p>
      */
     ReadTimestamp?: string;
     /**
+     * @public
      * <p>The identifier of the recipient of the message. </p>
      */
     RecipientParticipantId?: string;
@@ -371,10 +406,12 @@ export interface Receipt {
  */
 export interface MessageMetadata {
     /**
+     * @public
      * <p>The identifier of the message that contains the metadata information. </p>
      */
     MessageId?: string;
     /**
+     * @public
      * <p>The list of receipt information for a message for different recipients.</p>
      */
     Receipts?: Receipt[];
@@ -420,49 +457,60 @@ export type ChatItemType = (typeof ChatItemType)[keyof typeof ChatItemType];
  */
 export interface Item {
     /**
+     * @public
      * <p>The time when the message or event was sent.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
      */
     AbsoluteTime?: string;
     /**
+     * @public
      * <p>The content of the message or event.</p>
      */
     Content?: string;
     /**
+     * @public
      * <p>The type of content of the item.</p>
      */
     ContentType?: string;
     /**
+     * @public
      * <p>The ID of the item.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>Type of the item: message or event. </p>
      */
     Type?: ChatItemType | string;
     /**
+     * @public
      * <p>The ID of the sender in the session.</p>
      */
     ParticipantId?: string;
     /**
+     * @public
      * <p>The chat display name of the sender.</p>
      */
     DisplayName?: string;
     /**
+     * @public
      * <p>The role of the sender. For example, is it a customer, agent, or system.</p>
      */
     ParticipantRole?: ParticipantRole | string;
     /**
+     * @public
      * <p>Provides information about the attachments.</p>
      */
     Attachments?: AttachmentItem[];
     /**
+     * @public
      * <p>The metadata related to the message. Currently this supports only information related
      *             to message receipts.</p>
      */
     MessageMetadata?: MessageMetadata;
     /**
+     * @public
      * <p>The contactId on which the transcript item was originally sent. This field is only
      *             populated for persistent chats when the transcript item is from the past chat session.
      *             For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent
@@ -470,6 +518,7 @@ export interface Item {
      */
     RelatedContactId?: string;
     /**
+     * @public
      * <p>The contactId on which the transcript item was originally sent. This field is
      *             populated only when the transcript item is from the current chat session.</p>
      */
@@ -480,14 +529,17 @@ export interface Item {
  */
 export interface GetTranscriptResponse {
     /**
+     * @public
      * <p>The initial contact ID for the contact. </p>
      */
     InitialContactId?: string;
     /**
+     * @public
      * <p>The list of messages in the session.</p>
      */
     Transcript?: Item[];
     /**
+     * @public
      * <p>The pagination token. Use the value returned previously in the next subsequent request
      *             to retrieve the next set of results.</p>
      */
@@ -498,6 +550,7 @@ export interface GetTranscriptResponse {
  */
 export interface SendEventRequest {
     /**
+     * @public
      * <p>The content type of the request. Supported types are:</p>
      *          <ul>
      *             <li>
@@ -516,12 +569,14 @@ export interface SendEventRequest {
      */
     ContentType: string | undefined;
     /**
+     * @public
      * <p>The content of the event to be sent (for example, message text). For content related
      *             to message receipts, this is supported in the form of a JSON string.</p>
      *          <p>Sample Content: "\{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"\}"</p>
      */
     Content?: string;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -529,6 +584,7 @@ export interface SendEventRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -538,10 +594,12 @@ export interface SendEventRequest {
  */
 export interface SendEventResponse {
     /**
+     * @public
      * <p>The ID of the response.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The time when the event was sent.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
@@ -553,12 +611,14 @@ export interface SendEventResponse {
  */
 export interface SendMessageRequest {
     /**
+     * @public
      * <p>The type of the content. Supported types are <code>text/plain</code>,
      *             <code>text/markdown</code>, <code>application/json</code>, and
      *             <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
      */
     ContentType: string | undefined;
     /**
+     * @public
      * <p>The content of the message. </p>
      *          <ul>
      *             <li>
@@ -577,6 +637,7 @@ export interface SendMessageRequest {
      */
     Content: string | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -584,6 +645,7 @@ export interface SendMessageRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The authentication token associated with the connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -593,10 +655,12 @@ export interface SendMessageRequest {
  */
 export interface SendMessageResponse {
     /**
+     * @public
      * <p>The ID of the message.</p>
      */
     Id?: string;
     /**
+     * @public
      * <p>The time when the message was sent.</p>
      *          <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
      *             2019-11-08T02:41:28.172Z.</p>
@@ -608,18 +672,22 @@ export interface SendMessageResponse {
  */
 export interface StartAttachmentUploadRequest {
     /**
+     * @public
      * <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>
      */
     ContentType: string | undefined;
     /**
+     * @public
      * <p>The size of the attachment in bytes.</p>
      */
     AttachmentSizeInBytes: number | undefined;
     /**
+     * @public
      * <p>A case-sensitive name of the attachment being uploaded.</p>
      */
     AttachmentName: string | undefined;
     /**
+     * @public
      * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
      *             request. If not provided, the Amazon Web Services
      *             SDK populates this field. For more information about idempotency, see
@@ -627,6 +695,7 @@ export interface StartAttachmentUploadRequest {
      */
     ClientToken?: string;
     /**
+     * @public
      * <p>The authentication token associated with the participant's connection.</p>
      */
     ConnectionToken: string | undefined;
@@ -637,15 +706,18 @@ export interface StartAttachmentUploadRequest {
  */
 export interface UploadMetadata {
     /**
+     * @public
      * <p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response
      * to <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html">StartAttachmentUpload</a>.</p>
      */
     Url?: string;
     /**
+     * @public
      * <p>The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.</p>
      */
     UrlExpiry?: string;
     /**
+     * @public
      * <p>The headers to be provided while uploading the file to the URL.</p>
      */
     HeadersToInclude?: Record<string, string>;
@@ -655,10 +727,12 @@ export interface UploadMetadata {
  */
 export interface StartAttachmentUploadResponse {
     /**
+     * @public
      * <p>A unique identifier for the attachment.</p>
      */
     AttachmentId?: string;
     /**
+     * @public
      * <p>Fields to be used while uploading the attachment.</p>
      */
     UploadMetadata?: UploadMetadata;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-connectparticipant",
   "description": "AWS SDK for JavaScript Connectparticipant Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",