@aws-sdk/client-connectparticipant 3.235.0 → 3.236.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 +0 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/ConnectParticipant.d.ts +11 -12
- package/dist-types/ConnectParticipantClient.d.ts +2 -3
- package/dist-types/commands/CreateParticipantConnectionCommand.d.ts +8 -8
- package/dist-types/commands/GetTranscriptCommand.d.ts +1 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +10 -11
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -12,7 +12,6 @@ AWS SDK for JavaScript ConnectParticipant Client for Node.js, Browser and React
|
|
|
12
12
|
<p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
|
|
13
13
|
a customer contact center and provide reliable customer engagement at any scale.</p>
|
|
14
14
|
<p>Amazon Connect enables customer contacts through voice or chat.</p>
|
|
15
|
-
|
|
16
15
|
<p>The APIs described here are used by chat participants, such as agents and
|
|
17
16
|
customers.</p>
|
|
18
17
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a =
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
4
|
+
const q = "fn", r = "argv", s = "ref";
|
|
5
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a =
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region: {
|
|
1
|
+
const q = "fn", r = "argv", s = "ref";
|
|
2
|
+
const a = true, b = false, c = "String", d = "PartitionResult", e = "tree", f = "error", g = "endpoint", h = { "required": true, "default": false, "type": "Boolean" }, i = { [s]: "Endpoint" }, j = { [q]: "booleanEquals", [r]: [{ [s]: "UseFIPS" }, true] }, k = { [q]: "booleanEquals", [r]: [{ [s]: "UseDualStack" }, true] }, l = {}, m = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsFIPS"] }] }, n = { [q]: "booleanEquals", [r]: [true, { [q]: "getAttr", [r]: [{ [s]: d }, "supportsDualStack"] }] }, o = [j], p = [k];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: { required: a, type: c }, UseDualStack: h, UseFIPS: h, Endpoint: { required: b, type: c } }, rules: [{ conditions: [{ [q]: "aws.partition", [r]: [{ [s]: "Region" }], assign: d }], type: e, rules: [{ conditions: [{ [q]: "isSet", [r]: [i] }], type: e, rules: [{ conditions: o, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: f }, { type: e, rules: [{ conditions: p, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: f }, { endpoint: { url: i, properties: l, headers: l }, type: g }] }] }, { conditions: [j, k], type: e, rules: [{ conditions: [m, n], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: f }] }, { conditions: o, type: e, rules: [{ conditions: [m], type: e, rules: [{ endpoint: { url: "https://participant.connect-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: f }] }, { conditions: p, type: e, rules: [{ conditions: [n], type: e, rules: [{ endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: g }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: f }] }, { endpoint: { url: "https://participant.connect.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: g }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -11,9 +11,8 @@ 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
13
|
* a customer contact center and provide reliable customer engagement at any scale.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <p>The APIs described here are used by chat participants, such as agents and
|
|
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
|
|
17
16
|
* customers.</p>
|
|
18
17
|
*/
|
|
19
18
|
export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
@@ -29,30 +28,30 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
29
28
|
/**
|
|
30
29
|
* <p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of
|
|
31
30
|
* ConnectionToken.</p>
|
|
32
|
-
*
|
|
31
|
+
* <p>The participant token is valid for the lifetime of the participant –
|
|
33
32
|
* until they are part of a contact.</p>
|
|
34
|
-
*
|
|
33
|
+
* <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
|
|
35
34
|
* Clients must manually connect to the returned websocket URL and subscribe to the desired
|
|
36
35
|
* topic. </p>
|
|
37
|
-
*
|
|
36
|
+
* <p>For chat, you need to publish the following on the established websocket
|
|
38
37
|
* connection:</p>
|
|
39
|
-
*
|
|
38
|
+
* <p>
|
|
40
39
|
* <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
|
|
41
40
|
* </p>
|
|
42
|
-
*
|
|
41
|
+
* <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
|
|
43
42
|
* clients need to call this API again to obtain a new websocket URL and perform the same
|
|
44
43
|
* steps as before.</p>
|
|
45
|
-
*
|
|
44
|
+
* <p>
|
|
46
45
|
* <b>Message streaming support</b>: This API can also be used together with the
|
|
47
46
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
|
|
48
47
|
* API to create a participant connection for chat contacts that are
|
|
49
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
|
|
50
49
|
* Administrator Guide</i>.</p>
|
|
51
|
-
*
|
|
50
|
+
* <p>
|
|
52
51
|
* <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open
|
|
53
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
|
|
54
53
|
* Guide</i>. </p>
|
|
55
|
-
*
|
|
54
|
+
* <note>
|
|
56
55
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
57
56
|
* authentication</a>.</p>
|
|
58
57
|
* </note>
|
|
@@ -81,7 +80,7 @@ export declare class ConnectParticipant extends ConnectParticipantClient {
|
|
|
81
80
|
/**
|
|
82
81
|
* <p>Retrieves a transcript of the session, including details about any attachments. Note
|
|
83
82
|
* that ConnectionToken is used for invoking this API instead of ParticipantToken.</p>
|
|
84
|
-
*
|
|
83
|
+
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
85
84
|
* authentication</a>.</p>
|
|
86
85
|
*/
|
|
87
86
|
getTranscript(args: GetTranscriptCommandInput, options?: __HttpHandlerOptions): Promise<GetTranscriptCommandOutput>;
|
|
@@ -133,9 +133,8 @@ export interface ConnectParticipantClientResolvedConfig extends ConnectParticipa
|
|
|
133
133
|
/**
|
|
134
134
|
* <p>Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage
|
|
135
135
|
* a customer contact center and provide reliable customer engagement at any scale.</p>
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
* <p>The APIs described here are used by chat participants, such as agents and
|
|
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
|
|
139
138
|
* customers.</p>
|
|
140
139
|
*/
|
|
141
140
|
export declare class ConnectParticipantClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectParticipantClientResolvedConfig> {
|
|
@@ -10,30 +10,30 @@ export interface CreateParticipantConnectionCommandOutput extends CreateParticip
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of
|
|
12
12
|
* ConnectionToken.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>The participant token is valid for the lifetime of the participant –
|
|
14
14
|
* until they are part of a contact.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
|
|
16
16
|
* Clients must manually connect to the returned websocket URL and subscribe to the desired
|
|
17
17
|
* topic. </p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For chat, you need to publish the following on the established websocket
|
|
19
19
|
* connection:</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>
|
|
21
21
|
* <code>{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}</code>
|
|
22
22
|
* </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
|
|
24
24
|
* clients need to call this API again to obtain a new websocket URL and perform the same
|
|
25
25
|
* steps as before.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <b>Message streaming support</b>: This API can also be used together with the
|
|
28
28
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a>
|
|
29
29
|
* API to create a participant connection for chat contacts that are
|
|
30
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
31
|
* Administrator Guide</i>.</p>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <b>Feature specifications</b>: For information about feature specifications, such as the allowed number of open
|
|
34
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
|
|
35
35
|
* Guide</i>. </p>
|
|
36
|
-
*
|
|
36
|
+
* <note>
|
|
37
37
|
* <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
|
|
38
38
|
* authentication</a>.</p>
|
|
39
39
|
* </note>
|
|
@@ -10,7 +10,7 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves a transcript of the session, including details about any attachments. Note
|
|
12
12
|
* that ConnectionToken is used for invoking this API instead of ParticipantToken.</p>
|
|
13
|
-
*
|
|
13
|
+
* <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
14
|
* authentication</a>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -100,7 +100,7 @@ export interface CreateParticipantConnectionRequest {
|
|
|
100
100
|
Type: (ConnectionType | string)[] | undefined;
|
|
101
101
|
/**
|
|
102
102
|
* <p>This is a header parameter.</p>
|
|
103
|
-
*
|
|
103
|
+
* <p>The ParticipantToken as obtained from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a>
|
|
104
104
|
* API response.</p>
|
|
105
105
|
*/
|
|
106
106
|
ParticipantToken: string | undefined;
|
|
@@ -120,7 +120,7 @@ export interface ConnectionCredentials {
|
|
|
120
120
|
ConnectionToken?: string;
|
|
121
121
|
/**
|
|
122
122
|
* <p>The expiration of the token.</p>
|
|
123
|
-
*
|
|
123
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
124
124
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
125
125
|
*/
|
|
126
126
|
Expiry?: string;
|
|
@@ -135,7 +135,7 @@ export interface Websocket {
|
|
|
135
135
|
Url?: string;
|
|
136
136
|
/**
|
|
137
137
|
* <p>The URL expiration timestamp in ISO date format.</p>
|
|
138
|
-
*
|
|
138
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
139
139
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
140
140
|
*/
|
|
141
141
|
ConnectionExpiry?: string;
|
|
@@ -204,7 +204,7 @@ export interface StartPosition {
|
|
|
204
204
|
Id?: string;
|
|
205
205
|
/**
|
|
206
206
|
* <p>The time in ISO format where to start.</p>
|
|
207
|
-
*
|
|
207
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
208
208
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
209
209
|
*/
|
|
210
210
|
AbsoluteTime?: string;
|
|
@@ -295,7 +295,7 @@ export declare enum ChatItemType {
|
|
|
295
295
|
export interface Item {
|
|
296
296
|
/**
|
|
297
297
|
* <p>The time when the message or event was sent.</p>
|
|
298
|
-
*
|
|
298
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
299
299
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
300
300
|
*/
|
|
301
301
|
AbsoluteTime?: string;
|
|
@@ -350,13 +350,12 @@ export interface GetTranscriptResponse {
|
|
|
350
350
|
export interface SendEventRequest {
|
|
351
351
|
/**
|
|
352
352
|
* <p>The content type of the request. Supported types are:</p>
|
|
353
|
-
*
|
|
354
|
-
* <ul>
|
|
353
|
+
* <ul>
|
|
355
354
|
* <li>
|
|
356
|
-
*
|
|
355
|
+
* <p>application/vnd.amazonaws.connect.event.typing</p>
|
|
357
356
|
* </li>
|
|
358
357
|
* <li>
|
|
359
|
-
*
|
|
358
|
+
* <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>
|
|
360
359
|
* </li>
|
|
361
360
|
* </ul>
|
|
362
361
|
*/
|
|
@@ -383,7 +382,7 @@ export interface SendEventResponse {
|
|
|
383
382
|
Id?: string;
|
|
384
383
|
/**
|
|
385
384
|
* <p>The time when the event was sent.</p>
|
|
386
|
-
*
|
|
385
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
387
386
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
388
387
|
*/
|
|
389
388
|
AbsoluteTime?: string;
|
|
@@ -414,7 +413,7 @@ export interface SendMessageResponse {
|
|
|
414
413
|
Id?: string;
|
|
415
414
|
/**
|
|
416
415
|
* <p>The time when the message was sent.</p>
|
|
417
|
-
*
|
|
416
|
+
* <p>It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
|
|
418
417
|
* 2019-11-08T02:41:28.172Z.</p>
|
|
419
418
|
*/
|
|
420
419
|
AbsoluteTime?: string;
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-connectparticipant",
|
|
3
3
|
"description": "AWS SDK for JavaScript Connectparticipant Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.236.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",
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
21
21
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
22
|
-
"@aws-sdk/client-sts": "3.
|
|
22
|
+
"@aws-sdk/client-sts": "3.236.0",
|
|
23
23
|
"@aws-sdk/config-resolver": "3.234.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.236.0",
|
|
25
25
|
"@aws-sdk/fetch-http-handler": "3.226.0",
|
|
26
26
|
"@aws-sdk/hash-node": "3.226.0",
|
|
27
27
|
"@aws-sdk/invalid-dependency": "3.226.0",
|