@aws-sdk/client-connectparticipant 3.296.0 → 3.297.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.
@@ -9,6 +9,7 @@ import { SendMessageCommandInput, SendMessageCommandOutput } from "./commands/Se
9
9
  import { StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput } from "./commands/StartAttachmentUploadCommand";
10
10
  import { ConnectParticipantClient } from "./ConnectParticipantClient";
11
11
  /**
12
+ * @public
12
13
  * <p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
13
14
  * a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use
14
15
  * the Amazon Connect Participant Service to manage chat participants, such as agents and
@@ -16,6 +17,7 @@ import { ConnectParticipantClient } from "./ConnectParticipantClient";
16
17
  */
17
18
  export declare class ConnectParticipant extends ConnectParticipantClient {
18
19
  /**
20
+ * @public
19
21
  * <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
20
22
  * provided in StartAttachmentUpload API. </p>
21
23
  * <note>
@@ -30,6 +32,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
30
32
  completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
31
33
  completeAttachmentUpload(args: CompleteAttachmentUploadCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompleteAttachmentUploadCommandOutput) => void): void;
32
34
  /**
35
+ * @public
33
36
  * <p>Creates the participant's connection. </p>
34
37
  * <note>
35
38
  * <p>
@@ -44,7 +47,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
44
47
  * <p>For chat, you need to publish the following on the established websocket
45
48
  * connection:</p>
46
49
  * <p>
47
- * <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
50
+ * <code>\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}</code>
48
51
  * </p>
49
52
  * <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
50
53
  * clients need to call this API again to obtain a new websocket URL and perform the same
@@ -70,6 +73,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
70
73
  createParticipantConnection(args: CreateParticipantConnectionCommandInput, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
71
74
  createParticipantConnection(args: CreateParticipantConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateParticipantConnectionCommandOutput) => void): void;
72
75
  /**
76
+ * @public
73
77
  * <p>Disconnects a participant. </p>
74
78
  * <note>
75
79
  * <p>
@@ -83,6 +87,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
83
87
  disconnectParticipant(args: DisconnectParticipantCommandInput, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
84
88
  disconnectParticipant(args: DisconnectParticipantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectParticipantCommandOutput) => void): void;
85
89
  /**
90
+ * @public
86
91
  * <p>Provides a pre-signed URL for download of a completed attachment. This is an
87
92
  * asynchronous API for use with active contacts.</p>
88
93
  * <note>
@@ -97,6 +102,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
97
102
  getAttachment(args: GetAttachmentCommandInput, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
98
103
  getAttachment(args: GetAttachmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAttachmentCommandOutput) => void): void;
99
104
  /**
105
+ * @public
100
106
  * <p>Retrieves a transcript of the session, including details about any attachments. For
101
107
  * information about accessing past chat contact transcripts for a persistent chat, see
102
108
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.
@@ -113,6 +119,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
113
119
  getTranscript(args: GetTranscriptCommandInput, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
114
120
  getTranscript(args: GetTranscriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTranscriptCommandOutput) => void): void;
115
121
  /**
122
+ * @public
116
123
  * <p>Sends an event. </p>
117
124
  * <note>
118
125
  * <p>
@@ -126,6 +133,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
126
133
  sendEvent(args: SendEventCommandInput, cb: (err: any, data?: SendEventCommandOutput) => void): void;
127
134
  sendEvent(args: SendEventCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendEventCommandOutput) => void): void;
128
135
  /**
136
+ * @public
129
137
  * <p>Sends a message.</p>
130
138
  * <note>
131
139
  * <p>
@@ -139,6 +147,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
139
147
  sendMessage(args: SendMessageCommandInput, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
140
148
  sendMessage(args: SendMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendMessageCommandOutput) => void): void;
141
149
  /**
150
+ * @public
142
151
  * <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
143
152
  * S3.</p>
144
153
  * <note>
@@ -16,15 +16,24 @@ import { SendEventCommandInput, SendEventCommandOutput } from "./commands/SendEv
16
16
  import { SendMessageCommandInput, SendMessageCommandOutput } from "./commands/SendMessageCommand";
17
17
  import { StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput } from "./commands/StartAttachmentUploadCommand";
18
18
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
19
+ /**
20
+ * @public
21
+ */
19
22
  export type ServiceInputTypes = CompleteAttachmentUploadCommandInput | CreateParticipantConnectionCommandInput | DisconnectParticipantCommandInput | GetAttachmentCommandInput | GetTranscriptCommandInput | SendEventCommandInput | SendMessageCommandInput | StartAttachmentUploadCommandInput;
23
+ /**
24
+ * @public
25
+ */
20
26
  export type ServiceOutputTypes = CompleteAttachmentUploadCommandOutput | CreateParticipantConnectionCommandOutput | DisconnectParticipantCommandOutput | GetAttachmentCommandOutput | GetTranscriptCommandOutput | SendEventCommandOutput | SendMessageCommandOutput | StartAttachmentUploadCommandOutput;
27
+ /**
28
+ * @public
29
+ */
21
30
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
22
31
  /**
23
32
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
24
33
  */
25
34
  requestHandler?: __HttpHandler;
26
35
  /**
27
- * A constructor for a class implementing the {@link __Checksum} interface
36
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
28
37
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
29
38
  * @internal
30
39
  */
@@ -114,23 +123,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
114
123
  */
115
124
  logger?: __Logger;
116
125
  /**
117
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
126
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
118
127
  */
119
128
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
120
129
  }
130
+ /**
131
+ * @public
132
+ */
121
133
  type ConnectParticipantClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
122
134
  /**
123
- * The configuration interface of ConnectParticipantClient class constructor that set the region, credentials and other options.
135
+ * @public
136
+ *
137
+ * The configuration interface of ConnectParticipantClient class constructor that set the region, credentials and other options.
124
138
  */
125
139
  export interface ConnectParticipantClientConfig extends ConnectParticipantClientConfigType {
126
140
  }
141
+ /**
142
+ * @public
143
+ */
127
144
  type ConnectParticipantClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
128
145
  /**
129
- * The resolved configuration interface of ConnectParticipantClient class. This is resolved and normalized from the {@link ConnectParticipantClientConfig | constructor configuration interface}.
146
+ * @public
147
+ *
148
+ * The resolved configuration interface of ConnectParticipantClient class. This is resolved and normalized from the {@link ConnectParticipantClientConfig | constructor configuration interface}.
130
149
  */
131
150
  export interface ConnectParticipantClientResolvedConfig extends ConnectParticipantClientResolvedConfigType {
132
151
  }
133
152
  /**
153
+ * @public
134
154
  * <p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
135
155
  * a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use
136
156
  * the Amazon Connect Participant Service to manage chat participants, such as agents and
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { CompleteAttachmentUploadRequest, CompleteAttachmentUploadResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CompleteAttachmentUploadCommand}.
8
10
  */
9
11
  export interface CompleteAttachmentUploadCommandInput extends CompleteAttachmentUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CompleteAttachmentUploadCommand}.
13
17
  */
14
18
  export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmentUploadResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
18
23
  * provided in StartAttachmentUpload API. </p>
19
24
  * <note>
@@ -33,6 +38,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param CompleteAttachmentUploadCommandInput - {@link CompleteAttachmentUploadCommandInput}
42
+ * @returns {@link CompleteAttachmentUploadCommandOutput}
36
43
  * @see {@link CompleteAttachmentUploadCommandInput} for command's `input` shape.
37
44
  * @see {@link CompleteAttachmentUploadCommandOutput} for command's `response` shape.
38
45
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
60
67
  export declare class CompleteAttachmentUploadCommand extends $Command<CompleteAttachmentUploadCommandInput, CompleteAttachmentUploadCommandOutput, ConnectParticipantClientResolvedConfig> {
61
68
  readonly input: CompleteAttachmentUploadCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CompleteAttachmentUploadCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CompleteAttachmentUploadCommandInput, CompleteAttachmentUploadCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { CreateParticipantConnectionRequest, CreateParticipantConnectionResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateParticipantConnectionCommand}.
8
10
  */
9
11
  export interface CreateParticipantConnectionCommandInput extends CreateParticipantConnectionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateParticipantConnectionCommand}.
13
17
  */
14
18
  export interface CreateParticipantConnectionCommandOutput extends CreateParticipantConnectionResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates the participant's connection. </p>
18
23
  * <note>
19
24
  * <p>
@@ -28,7 +33,7 @@ export interface CreateParticipantConnectionCommandOutput extends CreateParticip
28
33
  * <p>For chat, you need to publish the following on the established websocket
29
34
  * connection:</p>
30
35
  * <p>
31
- * <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
36
+ * <code>\{"topic":"aws/subscribe","content":\{"topics":["aws/chat"]\}\}</code>
32
37
  * </p>
33
38
  * <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
34
39
  * clients need to call this API again to obtain a new websocket URL and perform the same
@@ -59,6 +64,8 @@ export interface CreateParticipantConnectionCommandOutput extends CreateParticip
59
64
  * const response = await client.send(command);
60
65
  * ```
61
66
  *
67
+ * @param CreateParticipantConnectionCommandInput - {@link CreateParticipantConnectionCommandInput}
68
+ * @returns {@link CreateParticipantConnectionCommandOutput}
62
69
  * @see {@link CreateParticipantConnectionCommandInput} for command's `input` shape.
63
70
  * @see {@link CreateParticipantConnectionCommandOutput} for command's `response` shape.
64
71
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -80,11 +87,20 @@ export interface CreateParticipantConnectionCommandOutput extends CreateParticip
80
87
  export declare class CreateParticipantConnectionCommand extends $Command<CreateParticipantConnectionCommandInput, CreateParticipantConnectionCommandOutput, ConnectParticipantClientResolvedConfig> {
81
88
  readonly input: CreateParticipantConnectionCommandInput;
82
89
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
90
+ /**
91
+ * @public
92
+ */
83
93
  constructor(input: CreateParticipantConnectionCommandInput);
84
94
  /**
85
95
  * @internal
86
96
  */
87
97
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateParticipantConnectionCommandInput, CreateParticipantConnectionCommandOutput>;
98
+ /**
99
+ * @internal
100
+ */
88
101
  private serialize;
102
+ /**
103
+ * @internal
104
+ */
89
105
  private deserialize;
90
106
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { DisconnectParticipantRequest, DisconnectParticipantResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisconnectParticipantCommand}.
8
10
  */
9
11
  export interface DisconnectParticipantCommandInput extends DisconnectParticipantRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisconnectParticipantCommand}.
13
17
  */
14
18
  export interface DisconnectParticipantCommandOutput extends DisconnectParticipantResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Disconnects a participant. </p>
18
23
  * <note>
19
24
  * <p>
@@ -32,6 +37,8 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param DisconnectParticipantCommandInput - {@link DisconnectParticipantCommandInput}
41
+ * @returns {@link DisconnectParticipantCommandOutput}
35
42
  * @see {@link DisconnectParticipantCommandInput} for command's `input` shape.
36
43
  * @see {@link DisconnectParticipantCommandOutput} for command's `response` shape.
37
44
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DisconnectParticipantCommandOutput extends DisconnectParticipan
53
60
  export declare class DisconnectParticipantCommand extends $Command<DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput, ConnectParticipantClientResolvedConfig> {
54
61
  readonly input: DisconnectParticipantCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DisconnectParticipantCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisconnectParticipantCommandInput, DisconnectParticipantCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { GetAttachmentRequest, GetAttachmentResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetAttachmentCommand}.
8
10
  */
9
11
  export interface GetAttachmentCommandInput extends GetAttachmentRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetAttachmentCommand}.
13
17
  */
14
18
  export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a pre-signed URL for download of a completed attachment. This is an
18
23
  * asynchronous API for use with active contacts.</p>
19
24
  * <note>
@@ -33,6 +38,8 @@ export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __Met
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param GetAttachmentCommandInput - {@link GetAttachmentCommandInput}
42
+ * @returns {@link GetAttachmentCommandOutput}
36
43
  * @see {@link GetAttachmentCommandInput} for command's `input` shape.
37
44
  * @see {@link GetAttachmentCommandOutput} for command's `response` shape.
38
45
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -54,11 +61,20 @@ export interface GetAttachmentCommandOutput extends GetAttachmentResponse, __Met
54
61
  export declare class GetAttachmentCommand extends $Command<GetAttachmentCommandInput, GetAttachmentCommandOutput, ConnectParticipantClientResolvedConfig> {
55
62
  readonly input: GetAttachmentCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: GetAttachmentCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAttachmentCommandInput, GetAttachmentCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { GetTranscriptRequest, GetTranscriptResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetTranscriptCommand}.
8
10
  */
9
11
  export interface GetTranscriptCommandInput extends GetTranscriptRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetTranscriptCommand}.
13
17
  */
14
18
  export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a transcript of the session, including details about any attachments. For
18
23
  * information about accessing past chat contact transcripts for a persistent chat, see
19
24
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.
@@ -35,6 +40,8 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param GetTranscriptCommandInput - {@link GetTranscriptCommandInput}
44
+ * @returns {@link GetTranscriptCommandOutput}
38
45
  * @see {@link GetTranscriptCommandInput} for command's `input` shape.
39
46
  * @see {@link GetTranscriptCommandOutput} for command's `response` shape.
40
47
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -56,11 +63,20 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met
56
63
  export declare class GetTranscriptCommand extends $Command<GetTranscriptCommandInput, GetTranscriptCommandOutput, ConnectParticipantClientResolvedConfig> {
57
64
  readonly input: GetTranscriptCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: GetTranscriptCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetTranscriptCommandInput, GetTranscriptCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { SendEventRequest, SendEventResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendEventCommand}.
8
10
  */
9
11
  export interface SendEventCommandInput extends SendEventRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendEventCommand}.
13
17
  */
14
18
  export interface SendEventCommandOutput extends SendEventResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends an event. </p>
18
23
  * <note>
19
24
  * <p>
@@ -32,6 +37,8 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param SendEventCommandInput - {@link SendEventCommandInput}
41
+ * @returns {@link SendEventCommandOutput}
35
42
  * @see {@link SendEventCommandInput} for command's `input` shape.
36
43
  * @see {@link SendEventCommandOutput} for command's `response` shape.
37
44
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -53,11 +60,20 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea
53
60
  export declare class SendEventCommand extends $Command<SendEventCommandInput, SendEventCommandOutput, ConnectParticipantClientResolvedConfig> {
54
61
  readonly input: SendEventCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: SendEventCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendEventCommandInput, SendEventCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { SendMessageRequest, SendMessageResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link SendMessageCommand}.
8
10
  */
9
11
  export interface SendMessageCommandInput extends SendMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link SendMessageCommand}.
13
17
  */
14
18
  export interface SendMessageCommandOutput extends SendMessageResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Sends a message.</p>
18
23
  * <note>
19
24
  * <p>
@@ -32,6 +37,8 @@ export interface SendMessageCommandOutput extends SendMessageResponse, __Metadat
32
37
  * const response = await client.send(command);
33
38
  * ```
34
39
  *
40
+ * @param SendMessageCommandInput - {@link SendMessageCommandInput}
41
+ * @returns {@link SendMessageCommandOutput}
35
42
  * @see {@link SendMessageCommandInput} for command's `input` shape.
36
43
  * @see {@link SendMessageCommandOutput} for command's `response` shape.
37
44
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -53,11 +60,20 @@ export interface SendMessageCommandOutput extends SendMessageResponse, __Metadat
53
60
  export declare class SendMessageCommand extends $Command<SendMessageCommandInput, SendMessageCommandOutput, ConnectParticipantClientResolvedConfig> {
54
61
  readonly input: SendMessageCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: SendMessageCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendMessageCommandInput, SendMessageCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectParticipantClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectParticipantClient";
5
5
  import { StartAttachmentUploadRequest, StartAttachmentUploadResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartAttachmentUploadCommand}.
8
10
  */
9
11
  export interface StartAttachmentUploadCommandInput extends StartAttachmentUploadRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartAttachmentUploadCommand}.
13
17
  */
14
18
  export interface StartAttachmentUploadCommandOutput extends StartAttachmentUploadResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
18
23
  * S3.</p>
19
24
  * <note>
@@ -33,6 +38,8 @@ export interface StartAttachmentUploadCommandOutput extends StartAttachmentUploa
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param StartAttachmentUploadCommandInput - {@link StartAttachmentUploadCommandInput}
42
+ * @returns {@link StartAttachmentUploadCommandOutput}
36
43
  * @see {@link StartAttachmentUploadCommandInput} for command's `input` shape.
37
44
  * @see {@link StartAttachmentUploadCommandOutput} for command's `response` shape.
38
45
  * @see {@link ConnectParticipantClientResolvedConfig | config} for ConnectParticipantClient's `config` shape.
@@ -57,11 +64,20 @@ export interface StartAttachmentUploadCommandOutput extends StartAttachmentUploa
57
64
  export declare class StartAttachmentUploadCommand extends $Command<StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput, ConnectParticipantClientResolvedConfig> {
58
65
  readonly input: StartAttachmentUploadCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: StartAttachmentUploadCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectParticipantClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartAttachmentUploadCommandInput, StartAttachmentUploadCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ConnectParticipant service.
4
6
  */
5
7
  export declare class ConnectParticipantServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ConnectParticipantServiceException as __BaseException } from "./ConnectParticipantServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You do not have sufficient access to perform this action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -12,6 +13,9 @@ export declare class AccessDeniedException extends __BaseException {
12
13
  */
13
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
15
  }
16
+ /**
17
+ * @public
18
+ */
15
19
  export interface CompleteAttachmentUploadRequest {
16
20
  /**
17
21
  * <p>A list of unique identifiers for the attachments.</p>
@@ -29,9 +33,13 @@ export interface CompleteAttachmentUploadRequest {
29
33
  */
30
34
  ConnectionToken: string | undefined;
31
35
  }
36
+ /**
37
+ * @public
38
+ */
32
39
  export interface CompleteAttachmentUploadResponse {
33
40
  }
34
41
  /**
42
+ * @public
35
43
  * <p>An attachment with that identifier is already being uploaded.</p>
36
44
  */
37
45
  export declare class ConflictException extends __BaseException {
@@ -44,6 +52,7 @@ export declare class ConflictException extends __BaseException {
44
52
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
45
53
  }
46
54
  /**
55
+ * @public
47
56
  * <p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>
48
57
  */
49
58
  export declare class InternalServerException extends __BaseException {
@@ -56,6 +65,7 @@ export declare class InternalServerException extends __BaseException {
56
65
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
57
66
  }
58
67
  /**
68
+ * @public
59
69
  * <p>The number of attachments per contact exceeds the quota.</p>
60
70
  */
61
71
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -68,6 +78,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
68
78
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
69
79
  }
70
80
  /**
81
+ * @public
71
82
  * <p>The request was denied due to request throttling.</p>
72
83
  */
73
84
  export declare class ThrottlingException extends __BaseException {
@@ -80,6 +91,7 @@ export declare class ThrottlingException extends __BaseException {
80
91
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
81
92
  }
82
93
  /**
94
+ * @public
83
95
  * <p>The input fails to satisfy the constraints specified by Amazon Connect.</p>
84
96
  */
85
97
  export declare class ValidationException extends __BaseException {
@@ -91,10 +103,16 @@ export declare class ValidationException extends __BaseException {
91
103
  */
92
104
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
93
105
  }
106
+ /**
107
+ * @public
108
+ */
94
109
  export declare enum ConnectionType {
95
110
  CONNECTION_CREDENTIALS = "CONNECTION_CREDENTIALS",
96
111
  WEBSOCKET = "WEBSOCKET"
97
112
  }
113
+ /**
114
+ * @public
115
+ */
98
116
  export interface CreateParticipantConnectionRequest {
99
117
  /**
100
118
  * <p>Type of connection information required. This can be omitted if
@@ -114,6 +132,7 @@ export interface CreateParticipantConnectionRequest {
114
132
  ConnectParticipant?: boolean;
115
133
  }
116
134
  /**
135
+ * @public
117
136
  * <p>Connection credentials. </p>
118
137
  */
119
138
  export interface ConnectionCredentials {
@@ -129,6 +148,7 @@ export interface ConnectionCredentials {
129
148
  Expiry?: string;
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <p>The websocket for the participant's connection.</p>
133
153
  */
134
154
  export interface Websocket {
@@ -143,6 +163,9 @@ export interface Websocket {
143
163
  */
144
164
  ConnectionExpiry?: string;
145
165
  }
166
+ /**
167
+ * @public
168
+ */
146
169
  export interface CreateParticipantConnectionResponse {
147
170
  /**
148
171
  * <p>Creates the participant's websocket connection.</p>
@@ -154,6 +177,9 @@ export interface CreateParticipantConnectionResponse {
154
177
  */
155
178
  ConnectionCredentials?: ConnectionCredentials;
156
179
  }
180
+ /**
181
+ * @public
182
+ */
157
183
  export interface DisconnectParticipantRequest {
158
184
  /**
159
185
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
@@ -167,8 +193,14 @@ export interface DisconnectParticipantRequest {
167
193
  */
168
194
  ConnectionToken: string | undefined;
169
195
  }
196
+ /**
197
+ * @public
198
+ */
170
199
  export interface DisconnectParticipantResponse {
171
200
  }
201
+ /**
202
+ * @public
203
+ */
172
204
  export interface GetAttachmentRequest {
173
205
  /**
174
206
  * <p>A unique identifier for the attachment.</p>
@@ -179,6 +211,9 @@ export interface GetAttachmentRequest {
179
211
  */
180
212
  ConnectionToken: string | undefined;
181
213
  }
214
+ /**
215
+ * @public
216
+ */
182
217
  export interface GetAttachmentResponse {
183
218
  /**
184
219
  * <p>This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response
@@ -190,15 +225,22 @@ export interface GetAttachmentResponse {
190
225
  */
191
226
  UrlExpiry?: string;
192
227
  }
228
+ /**
229
+ * @public
230
+ */
193
231
  export declare enum ScanDirection {
194
232
  BACKWARD = "BACKWARD",
195
233
  FORWARD = "FORWARD"
196
234
  }
235
+ /**
236
+ * @public
237
+ */
197
238
  export declare enum SortKey {
198
239
  ASCENDING = "ASCENDING",
199
240
  DESCENDING = "DESCENDING"
200
241
  }
201
242
  /**
243
+ * @public
202
244
  * <p>A filtering option for where to start. For example, if you sent 100 messages, start
203
245
  * with message 50. </p>
204
246
  */
@@ -218,6 +260,9 @@ export interface StartPosition {
218
260
  */
219
261
  MostRecent?: number;
220
262
  }
263
+ /**
264
+ * @public
265
+ */
221
266
  export interface GetTranscriptRequest {
222
267
  /**
223
268
  * <p>The contactId from the current contact chain for which transcript is needed.</p>
@@ -250,12 +295,16 @@ export interface GetTranscriptRequest {
250
295
  */
251
296
  ConnectionToken: string | undefined;
252
297
  }
298
+ /**
299
+ * @public
300
+ */
253
301
  export declare enum ArtifactStatus {
254
302
  APPROVED = "APPROVED",
255
303
  IN_PROGRESS = "IN_PROGRESS",
256
304
  REJECTED = "REJECTED"
257
305
  }
258
306
  /**
307
+ * @public
259
308
  * <p>The case-insensitive input to indicate standard MIME type that describes the format of the file
260
309
  * that will be uploaded.</p>
261
310
  */
@@ -278,6 +327,7 @@ export interface AttachmentItem {
278
327
  Status?: ArtifactStatus | string;
279
328
  }
280
329
  /**
330
+ * @public
281
331
  * <p>The receipt for the message delivered to the recipient.</p>
282
332
  */
283
333
  export interface Receipt {
@@ -295,6 +345,7 @@ export interface Receipt {
295
345
  RecipientParticipantId?: string;
296
346
  }
297
347
  /**
348
+ * @public
298
349
  * <p>Contains metadata related to a message.</p>
299
350
  */
300
351
  export interface MessageMetadata {
@@ -307,11 +358,17 @@ export interface MessageMetadata {
307
358
  */
308
359
  Receipts?: Receipt[];
309
360
  }
361
+ /**
362
+ * @public
363
+ */
310
364
  export declare enum ParticipantRole {
311
365
  AGENT = "AGENT",
312
366
  CUSTOMER = "CUSTOMER",
313
367
  SYSTEM = "SYSTEM"
314
368
  }
369
+ /**
370
+ * @public
371
+ */
315
372
  export declare enum ChatItemType {
316
373
  ATTACHMENT = "ATTACHMENT",
317
374
  CHAT_ENDED = "CHAT_ENDED",
@@ -327,6 +384,7 @@ export declare enum ChatItemType {
327
384
  TYPING = "TYPING"
328
385
  }
329
386
  /**
387
+ * @public
330
388
  * <p>An item - message or event - that has been sent. </p>
331
389
  */
332
390
  export interface Item {
@@ -386,6 +444,9 @@ export interface Item {
386
444
  */
387
445
  ContactId?: string;
388
446
  }
447
+ /**
448
+ * @public
449
+ */
389
450
  export interface GetTranscriptResponse {
390
451
  /**
391
452
  * <p>The initial contact ID for the contact. </p>
@@ -401,6 +462,9 @@ export interface GetTranscriptResponse {
401
462
  */
402
463
  NextToken?: string;
403
464
  }
465
+ /**
466
+ * @public
467
+ */
404
468
  export interface SendEventRequest {
405
469
  /**
406
470
  * <p>The content type of the request. Supported types are:</p>
@@ -423,7 +487,7 @@ export interface SendEventRequest {
423
487
  /**
424
488
  * <p>The content of the event to be sent (for example, message text). For content related
425
489
  * to message receipts, this is supported in the form of a JSON string.</p>
426
- * <p>Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"</p>
490
+ * <p>Sample Content: "\{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"\}"</p>
427
491
  */
428
492
  Content?: string;
429
493
  /**
@@ -438,6 +502,9 @@ export interface SendEventRequest {
438
502
  */
439
503
  ConnectionToken: string | undefined;
440
504
  }
505
+ /**
506
+ * @public
507
+ */
441
508
  export interface SendEventResponse {
442
509
  /**
443
510
  * <p>The ID of the response.</p>
@@ -450,6 +517,9 @@ export interface SendEventResponse {
450
517
  */
451
518
  AbsoluteTime?: string;
452
519
  }
520
+ /**
521
+ * @public
522
+ */
453
523
  export interface SendMessageRequest {
454
524
  /**
455
525
  * <p>The type of the content. Supported types are <code>text/plain</code>,
@@ -482,6 +552,9 @@ export interface SendMessageRequest {
482
552
  */
483
553
  ConnectionToken: string | undefined;
484
554
  }
555
+ /**
556
+ * @public
557
+ */
485
558
  export interface SendMessageResponse {
486
559
  /**
487
560
  * <p>The ID of the message.</p>
@@ -494,6 +567,9 @@ export interface SendMessageResponse {
494
567
  */
495
568
  AbsoluteTime?: string;
496
569
  }
570
+ /**
571
+ * @public
572
+ */
497
573
  export interface StartAttachmentUploadRequest {
498
574
  /**
499
575
  * <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>
@@ -520,6 +596,7 @@ export interface StartAttachmentUploadRequest {
520
596
  ConnectionToken: string | undefined;
521
597
  }
522
598
  /**
599
+ * @public
523
600
  * <p>Fields to be used while uploading the attachment.</p>
524
601
  */
525
602
  export interface UploadMetadata {
@@ -537,6 +614,9 @@ export interface UploadMetadata {
537
614
  */
538
615
  HeadersToInclude?: Record<string, string>;
539
616
  }
617
+ /**
618
+ * @public
619
+ */
540
620
  export interface StartAttachmentUploadResponse {
541
621
  /**
542
622
  * <p>A unique identifier for the attachment.</p>
@@ -1,4 +1,7 @@
1
1
  import { Paginator } from "@aws-sdk/types";
2
2
  import { GetTranscriptCommandInput, GetTranscriptCommandOutput } from "../commands/GetTranscriptCommand";
3
3
  import { ConnectParticipantPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
4
7
  export declare function paginateGetTranscript(config: ConnectParticipantPaginationConfiguration, input: GetTranscriptCommandInput, ...additionalArguments: any): Paginator<GetTranscriptCommandOutput>;
@@ -1,5 +1,8 @@
1
1
  import { PaginationConfiguration } from "@aws-sdk/types";
2
2
  import { ConnectParticipantClient } from "../ConnectParticipantClient";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface ConnectParticipantPaginationConfiguration extends PaginationConfiguration {
4
7
  client: ConnectParticipantClient;
5
8
  }
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.296.0",
4
+ "version": "3.297.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",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",