@aws-sdk/client-connect 3.701.0 → 3.709.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 +18 -2
- package/dist-cjs/index.js +186 -63
- package/dist-es/Connect.js +4 -0
- package/dist-es/commands/CreateContactCommand.js +1 -1
- package/dist-es/commands/CreatePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/DeletePushNotificationRegistrationCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +11 -0
- package/dist-es/models/models_1.js +0 -16
- package/dist-es/models/models_2.js +24 -5
- package/dist-es/models/models_3.js +5 -0
- package/dist-es/protocols/Aws_restJson1.js +62 -0
- package/dist-types/Connect.d.ts +16 -2
- package/dist-types/ConnectClient.d.ts +6 -4
- package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/CreatePushNotificationRegistrationCommand.d.ts +101 -0
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +86 -0
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -2
- package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +2 -3
- package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +2 -2
- package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -2
- package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
- package/dist-types/commands/UpdateContactCommand.d.ts +21 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +142 -81
- package/dist-types/models/models_1.d.ts +202 -171
- package/dist-types/models/models_2.d.ts +215 -400
- package/dist-types/models/models_3.d.ts +430 -3
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Connect.d.ts +46 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreatePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +34 -19
- package/dist-types/ts3.4/models/models_1.d.ts +19 -43
- package/dist-types/ts3.4/models/models_2.d.ts +65 -89
- package/dist-types/ts3.4/models/models_3.d.ts +92 -6
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +35 -35
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
+
import { DeletePushNotificationRegistrationRequest, DeletePushNotificationRegistrationResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeletePushNotificationRegistrationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeletePushNotificationRegistrationCommandInput extends DeletePushNotificationRegistrationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeletePushNotificationRegistrationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePushNotificationRegistrationCommandOutput extends DeletePushNotificationRegistrationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeletePushNotificationRegistrationCommand_base: {
|
|
25
|
+
new (input: DeletePushNotificationRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePushNotificationRegistrationCommandInput, DeletePushNotificationRegistrationCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeletePushNotificationRegistrationCommandInput): import("@smithy/smithy-client").CommandImpl<DeletePushNotificationRegistrationCommandInput, DeletePushNotificationRegistrationCommandOutput, ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes registration for a device token and a chat contact.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ConnectClient, DeletePushNotificationRegistrationCommand } from "@aws-sdk/client-connect"; // ES Modules import
|
|
35
|
+
* // const { ConnectClient, DeletePushNotificationRegistrationCommand } = require("@aws-sdk/client-connect"); // CommonJS import
|
|
36
|
+
* const client = new ConnectClient(config);
|
|
37
|
+
* const input = { // DeletePushNotificationRegistrationRequest
|
|
38
|
+
* InstanceId: "STRING_VALUE", // required
|
|
39
|
+
* RegistrationId: "STRING_VALUE", // required
|
|
40
|
+
* ContactId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new DeletePushNotificationRegistrationCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // {};
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeletePushNotificationRegistrationCommandInput - {@link DeletePushNotificationRegistrationCommandInput}
|
|
49
|
+
* @returns {@link DeletePushNotificationRegistrationCommandOutput}
|
|
50
|
+
* @see {@link DeletePushNotificationRegistrationCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeletePushNotificationRegistrationCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
58
|
+
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
61
|
+
* <p>One or more of the specified parameters are not valid.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
+
* <p>The specified resource was not found.</p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
67
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ConnectServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Connect service.</p>
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export declare class DeletePushNotificationRegistrationCommand extends DeletePushNotificationRegistrationCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: DeletePushNotificationRegistrationRequest;
|
|
79
|
+
output: {};
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: DeletePushNotificationRegistrationCommandInput;
|
|
83
|
+
output: DeletePushNotificationRegistrationCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { DeleteUserHierarchyGroupRequest } from "../models/
|
|
4
|
+
import { DeleteUserHierarchyGroupRequest } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { DeleteViewRequest, DeleteViewResponse } from "../models/
|
|
4
|
+
import { DeleteViewRequest, DeleteViewResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { DeleteViewVersionRequest, DeleteViewVersionResponse } from "../models/
|
|
4
|
+
import { DeleteViewVersionRequest, DeleteViewVersionResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
|
|
4
|
-
import { DeleteVocabularyRequest } from "../models/
|
|
5
|
-
import { DeleteVocabularyResponse } from "../models/models_1";
|
|
4
|
+
import { DeleteVocabularyRequest, DeleteVocabularyResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -36,8 +36,7 @@ declare const DescribePhoneNumberCommand_base: {
|
|
|
36
36
|
* and you are calling this API in the alternate Amazon Web Services Region associated with the
|
|
37
37
|
* traffic distribution group, you must provide a full phone number ARN. If a UUID is provided
|
|
38
38
|
* in
|
|
39
|
-
* this scenario, you
|
|
40
|
-
* <code>ResourceNotFoundException</code>.</p>
|
|
39
|
+
* this scenario, you receive a <code>ResourceNotFoundException</code>.</p>
|
|
41
40
|
* </important>
|
|
42
41
|
* @example
|
|
43
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -37,7 +37,7 @@ declare const DisassociateFlowCommand_base: {
|
|
|
37
37
|
* const input = { // DisassociateFlowRequest
|
|
38
38
|
* InstanceId: "STRING_VALUE", // required
|
|
39
39
|
* ResourceId: "STRING_VALUE", // required
|
|
40
|
-
* ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL", // required
|
|
40
|
+
* ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR" || "WHATSAPP_MESSAGING_PHONE_NUMBER", // required
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DisassociateFlowCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
@@ -37,14 +37,14 @@ declare const GetFlowAssociationCommand_base: {
|
|
|
37
37
|
* const input = { // GetFlowAssociationRequest
|
|
38
38
|
* InstanceId: "STRING_VALUE", // required
|
|
39
39
|
* ResourceId: "STRING_VALUE", // required
|
|
40
|
-
* ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL", // required
|
|
40
|
+
* ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR" || "WHATSAPP_MESSAGING_PHONE_NUMBER", // required
|
|
41
41
|
* };
|
|
42
42
|
* const command = new GetFlowAssociationCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
44
|
* // { // GetFlowAssociationResponse
|
|
45
45
|
* // ResourceId: "STRING_VALUE",
|
|
46
46
|
* // FlowId: "STRING_VALUE",
|
|
47
|
-
* // ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL",
|
|
47
|
+
* // ResourceType: "SMS_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR" || "WHATSAPP_MESSAGING_PHONE_NUMBER",
|
|
48
48
|
* // };
|
|
49
49
|
*
|
|
50
50
|
* ```
|
|
@@ -27,9 +27,8 @@ declare const ImportPhoneNumberCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Imports a claimed phone number from an external service, such as Amazon
|
|
31
|
-
*
|
|
32
|
-
* where the Amazon Connect instance was created.</p>
|
|
30
|
+
* <p>Imports a claimed phone number from an external service, such as Amazon Web Services End User
|
|
31
|
+
* Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.</p>
|
|
33
32
|
* <important>
|
|
34
33
|
* <p>Call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API
|
|
35
34
|
* to verify the status of a previous <code>ImportPhoneNumber</code> operation. </p>
|
|
@@ -36,7 +36,7 @@ declare const ListFlowAssociationsCommand_base: {
|
|
|
36
36
|
* const client = new ConnectClient(config);
|
|
37
37
|
* const input = { // ListFlowAssociationsRequest
|
|
38
38
|
* InstanceId: "STRING_VALUE", // required
|
|
39
|
-
* ResourceType: "VOICE_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL",
|
|
39
|
+
* ResourceType: "WHATSAPP_MESSAGING_PHONE_NUMBER" || "VOICE_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR",
|
|
40
40
|
* NextToken: "STRING_VALUE",
|
|
41
41
|
* MaxResults: Number("int"),
|
|
42
42
|
* };
|
|
@@ -47,7 +47,7 @@ declare const ListFlowAssociationsCommand_base: {
|
|
|
47
47
|
* // { // FlowAssociationSummary
|
|
48
48
|
* // ResourceId: "STRING_VALUE",
|
|
49
49
|
* // FlowId: "STRING_VALUE",
|
|
50
|
-
* // ResourceType: "VOICE_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL",
|
|
50
|
+
* // ResourceType: "WHATSAPP_MESSAGING_PHONE_NUMBER" || "VOICE_PHONE_NUMBER" || "INBOUND_EMAIL" || "OUTBOUND_EMAIL" || "ANALYTICS_CONNECTOR",
|
|
51
51
|
* // },
|
|
52
52
|
* // ],
|
|
53
53
|
* // NextToken: "STRING_VALUE",
|
|
@@ -37,7 +37,7 @@ declare const ListIntegrationAssociationsCommand_base: {
|
|
|
37
37
|
* const client = new ConnectClient(config);
|
|
38
38
|
* const input = { // ListIntegrationAssociationsRequest
|
|
39
39
|
* InstanceId: "STRING_VALUE", // required
|
|
40
|
-
* IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY",
|
|
40
|
+
* IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY" || "ANALYTICS_CONNECTOR" || "CALL_TRANSFER_CONNECTOR",
|
|
41
41
|
* NextToken: "STRING_VALUE",
|
|
42
42
|
* MaxResults: Number("int"),
|
|
43
43
|
* IntegrationArn: "STRING_VALUE",
|
|
@@ -50,7 +50,7 @@ declare const ListIntegrationAssociationsCommand_base: {
|
|
|
50
50
|
* // IntegrationAssociationId: "STRING_VALUE",
|
|
51
51
|
* // IntegrationAssociationArn: "STRING_VALUE",
|
|
52
52
|
* // InstanceId: "STRING_VALUE",
|
|
53
|
-
* // IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY",
|
|
53
|
+
* // IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY" || "ANALYTICS_CONNECTOR" || "CALL_TRANSFER_CONNECTOR",
|
|
54
54
|
* // IntegrationArn: "STRING_VALUE",
|
|
55
55
|
* // SourceApplicationUrl: "STRING_VALUE",
|
|
56
56
|
* // SourceApplicationName: "STRING_VALUE",
|
|
@@ -42,6 +42,7 @@ declare const ResumeContactRecordingCommand_base: {
|
|
|
42
42
|
* InstanceId: "STRING_VALUE", // required
|
|
43
43
|
* ContactId: "STRING_VALUE", // required
|
|
44
44
|
* InitialContactId: "STRING_VALUE", // required
|
|
45
|
+
* ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
|
|
45
46
|
* };
|
|
46
47
|
* const command = new ResumeContactRecordingCommand(input);
|
|
47
48
|
* const response = await client.send(command);
|
|
@@ -41,8 +41,8 @@ declare const SendChatIntegrationEventCommand_base: {
|
|
|
41
41
|
* </ul>
|
|
42
42
|
* <p>When a chat integration event is sent with chat identifiers that do not map to an active
|
|
43
43
|
* chat contact, a new chat contact is also created before handling chat action. </p>
|
|
44
|
-
* <p>Access to this API is currently restricted to Amazon
|
|
45
|
-
* integration. </p>
|
|
44
|
+
* <p>Access to this API is currently restricted to Amazon Web Services End User Messaging for
|
|
45
|
+
* supporting SMS integration. </p>
|
|
46
46
|
* @example
|
|
47
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
48
48
|
* ```javascript
|
|
@@ -58,6 +58,7 @@ declare const StartContactRecordingCommand_base: {
|
|
|
58
58
|
* InitialContactId: "STRING_VALUE", // required
|
|
59
59
|
* VoiceRecordingConfiguration: { // VoiceRecordingConfiguration
|
|
60
60
|
* VoiceRecordingTrack: "FROM_AGENT" || "TO_AGENT" || "ALL",
|
|
61
|
+
* IvrRecordingTrack: "ALL",
|
|
61
62
|
* },
|
|
62
63
|
* };
|
|
63
64
|
* const command = new StartContactRecordingCommand(input);
|
|
@@ -29,13 +29,13 @@ declare const StartOutboundChatContactCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
31
|
* <p>Initiates a new outbound SMS contact to a customer. Response of this API provides the
|
|
32
|
-
*
|
|
32
|
+
* <code>ContactId</code> of the outbound SMS contact created.</p>
|
|
33
33
|
* <p>
|
|
34
34
|
* <b>SourceEndpoint</b> only supports Endpoints with
|
|
35
35
|
* <code>CONNECT_PHONENUMBER_ARN</code> as Type and <b>DestinationEndpoint</b> only supports Endpoints with <code>TELEPHONE_NUMBER</code> as
|
|
36
36
|
* Type. <b>ContactFlowId</b> initiates the flow to manage the new SMS
|
|
37
37
|
* contact created.</p>
|
|
38
|
-
* <p>This API can be used to initiate outbound SMS contacts for an agent or it can also deflect
|
|
38
|
+
* <p>This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect
|
|
39
39
|
* an ongoing contact to an outbound SMS contact by using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html">StartOutboundChatContact</a> Flow Action.</p>
|
|
40
40
|
* <p>For more information about using SMS in Amazon Connect, see the following topics in the
|
|
41
41
|
* <i>Amazon Connect Administrator Guide</i>:</p>
|
|
@@ -43,6 +43,7 @@ declare const StopContactRecordingCommand_base: {
|
|
|
43
43
|
* InstanceId: "STRING_VALUE", // required
|
|
44
44
|
* ContactId: "STRING_VALUE", // required
|
|
45
45
|
* InitialContactId: "STRING_VALUE", // required
|
|
46
|
+
* ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
|
|
46
47
|
* };
|
|
47
48
|
* const command = new StopContactRecordingCommand(input);
|
|
48
49
|
* const response = await client.send(command);
|
|
@@ -45,6 +45,7 @@ declare const SuspendContactRecordingCommand_base: {
|
|
|
45
45
|
* InstanceId: "STRING_VALUE", // required
|
|
46
46
|
* ContactId: "STRING_VALUE", // required
|
|
47
47
|
* InitialContactId: "STRING_VALUE", // required
|
|
48
|
+
* ContactRecordingType: "AGENT" || "IVR" || "SCREEN",
|
|
48
49
|
* };
|
|
49
50
|
* const command = new SuspendContactRecordingCommand(input);
|
|
50
51
|
* const response = await client.send(command);
|
|
@@ -70,6 +70,20 @@ declare const UpdateContactCommand_base: {
|
|
|
70
70
|
* ValueInteger: Number("int"),
|
|
71
71
|
* },
|
|
72
72
|
* },
|
|
73
|
+
* QueueInfo: { // QueueInfoInput
|
|
74
|
+
* Id: "STRING_VALUE",
|
|
75
|
+
* },
|
|
76
|
+
* UserInfo: { // UserInfo
|
|
77
|
+
* UserId: "STRING_VALUE",
|
|
78
|
+
* },
|
|
79
|
+
* CustomerEndpoint: { // Endpoint
|
|
80
|
+
* Type: "TELEPHONE_NUMBER" || "VOIP" || "CONTACT_FLOW" || "CONNECT_PHONENUMBER_ARN" || "EMAIL_ADDRESS",
|
|
81
|
+
* Address: "STRING_VALUE",
|
|
82
|
+
* },
|
|
83
|
+
* SystemEndpoint: {
|
|
84
|
+
* Type: "TELEPHONE_NUMBER" || "VOIP" || "CONTACT_FLOW" || "CONNECT_PHONENUMBER_ARN" || "EMAIL_ADDRESS",
|
|
85
|
+
* Address: "STRING_VALUE",
|
|
86
|
+
* },
|
|
73
87
|
* };
|
|
74
88
|
* const command = new UpdateContactCommand(input);
|
|
75
89
|
* const response = await client.send(command);
|
|
@@ -83,6 +97,13 @@ declare const UpdateContactCommand_base: {
|
|
|
83
97
|
* @see {@link UpdateContactCommandOutput} for command's `response` shape.
|
|
84
98
|
* @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
|
|
85
99
|
*
|
|
100
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
101
|
+
* <p>You do not have sufficient permissions to perform this action.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ConflictException} (client fault)
|
|
104
|
+
* <p>Operation cannot be performed at this time as there is a conflict with another operation or
|
|
105
|
+
* contact state.</p>
|
|
106
|
+
*
|
|
86
107
|
* @throws {@link InternalServiceException} (server fault)
|
|
87
108
|
* <p>Request processing failed because of an error or failure with the service.</p>
|
|
88
109
|
*
|
|
@@ -34,6 +34,7 @@ export * from "./CreateParticipantCommand";
|
|
|
34
34
|
export * from "./CreatePersistentContactAssociationCommand";
|
|
35
35
|
export * from "./CreatePredefinedAttributeCommand";
|
|
36
36
|
export * from "./CreatePromptCommand";
|
|
37
|
+
export * from "./CreatePushNotificationRegistrationCommand";
|
|
37
38
|
export * from "./CreateQueueCommand";
|
|
38
39
|
export * from "./CreateQuickConnectCommand";
|
|
39
40
|
export * from "./CreateRoutingProfileCommand";
|
|
@@ -59,6 +60,7 @@ export * from "./DeleteInstanceCommand";
|
|
|
59
60
|
export * from "./DeleteIntegrationAssociationCommand";
|
|
60
61
|
export * from "./DeletePredefinedAttributeCommand";
|
|
61
62
|
export * from "./DeletePromptCommand";
|
|
63
|
+
export * from "./DeletePushNotificationRegistrationCommand";
|
|
62
64
|
export * from "./DeleteQueueCommand";
|
|
63
65
|
export * from "./DeleteQuickConnectCommand";
|
|
64
66
|
export * from "./DeleteRoutingProfileCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
* are also limits to the number of requests that you can make per second. For more information, see
|
|
22
22
|
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
|
|
23
23
|
* Guide</i>.</p>
|
|
24
|
-
* <p>You can connect programmatically to an Amazon Web Services service
|
|
25
|
-
*
|
|
24
|
+
* <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For a
|
|
25
|
+
* list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
|
|
26
26
|
*
|
|
27
27
|
* @packageDocumentation
|
|
28
28
|
*/
|
|
@@ -1185,9 +1185,11 @@ export interface AssociateDefaultVocabularyResponse {
|
|
|
1185
1185
|
* @enum
|
|
1186
1186
|
*/
|
|
1187
1187
|
export declare const FlowAssociationResourceType: {
|
|
1188
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
1188
1189
|
readonly INBOUND_EMAIL: "INBOUND_EMAIL";
|
|
1189
1190
|
readonly OUTBOUND_EMAIL: "OUTBOUND_EMAIL";
|
|
1190
1191
|
readonly SMS_PHONE_NUMBER: "SMS_PHONE_NUMBER";
|
|
1192
|
+
readonly WHATSAPP_MESSAGING_PHONE_NUMBER: "WHATSAPP_MESSAGING_PHONE_NUMBER";
|
|
1191
1193
|
};
|
|
1192
1194
|
/**
|
|
1193
1195
|
* @public
|
|
@@ -1204,6 +1206,18 @@ export interface AssociateFlowRequest {
|
|
|
1204
1206
|
InstanceId: string | undefined;
|
|
1205
1207
|
/**
|
|
1206
1208
|
* <p>The identifier of the resource.</p>
|
|
1209
|
+
* <ul>
|
|
1210
|
+
* <li>
|
|
1211
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
1212
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
1213
|
+
* </p>
|
|
1214
|
+
* </li>
|
|
1215
|
+
* <li>
|
|
1216
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
1217
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
1218
|
+
* </p>
|
|
1219
|
+
* </li>
|
|
1220
|
+
* </ul>
|
|
1207
1221
|
* @public
|
|
1208
1222
|
*/
|
|
1209
1223
|
ResourceId: string | undefined;
|
|
@@ -1994,9 +2008,11 @@ export interface BatchGetAttachedFileMetadataResponse {
|
|
|
1994
2008
|
* @enum
|
|
1995
2009
|
*/
|
|
1996
2010
|
export declare const ListFlowAssociationResourceType: {
|
|
2011
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
1997
2012
|
readonly INBOUND_EMAIL: "INBOUND_EMAIL";
|
|
1998
2013
|
readonly OUTBOUND_EMAIL: "OUTBOUND_EMAIL";
|
|
1999
2014
|
readonly VOICE_PHONE_NUMBER: "VOICE_PHONE_NUMBER";
|
|
2015
|
+
readonly WHATSAPP_MESSAGING_PHONE_NUMBER: "WHATSAPP_MESSAGING_PHONE_NUMBER";
|
|
2000
2016
|
};
|
|
2001
2017
|
/**
|
|
2002
2018
|
* @public
|
|
@@ -2013,6 +2029,18 @@ export interface BatchGetFlowAssociationRequest {
|
|
|
2013
2029
|
InstanceId: string | undefined;
|
|
2014
2030
|
/**
|
|
2015
2031
|
* <p>A list of resource identifiers to retrieve flow associations.</p>
|
|
2032
|
+
* <ul>
|
|
2033
|
+
* <li>
|
|
2034
|
+
* <p>Amazon Web Services End User Messaging SMS phone number ARN when using
|
|
2035
|
+
* <code>SMS_PHONE_NUMBER</code>
|
|
2036
|
+
* </p>
|
|
2037
|
+
* </li>
|
|
2038
|
+
* <li>
|
|
2039
|
+
* <p>Amazon Web Services End User Messaging Social phone number ARN when using
|
|
2040
|
+
* <code>WHATSAPP_MESSAGING_PHONE_NUMBER</code>
|
|
2041
|
+
* </p>
|
|
2042
|
+
* </li>
|
|
2043
|
+
* </ul>
|
|
2016
2044
|
* @public
|
|
2017
2045
|
*/
|
|
2018
2046
|
ResourceIds: string[] | undefined;
|
|
@@ -3419,7 +3447,9 @@ export interface CreateInstanceResponse {
|
|
|
3419
3447
|
* @enum
|
|
3420
3448
|
*/
|
|
3421
3449
|
export declare const IntegrationType: {
|
|
3450
|
+
readonly ANALYTICS_CONNECTOR: "ANALYTICS_CONNECTOR";
|
|
3422
3451
|
readonly APPLICATION: "APPLICATION";
|
|
3452
|
+
readonly CALL_TRANSFER_CONNECTOR: "CALL_TRANSFER_CONNECTOR";
|
|
3423
3453
|
readonly CASES_DOMAIN: "CASES_DOMAIN";
|
|
3424
3454
|
readonly EVENT: "EVENT";
|
|
3425
3455
|
readonly FILE_SCANNER: "FILE_SCANNER";
|
|
@@ -3465,8 +3495,8 @@ export interface CreateIntegrationAssociationRequest {
|
|
|
3465
3495
|
/**
|
|
3466
3496
|
* <p>The Amazon Resource Name (ARN) of the integration.</p>
|
|
3467
3497
|
* <note>
|
|
3468
|
-
* <p>When integrating with Amazon
|
|
3469
|
-
*
|
|
3498
|
+
* <p>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and
|
|
3499
|
+
* Amazon Web Services End User Messaging instances must be in the same account.</p>
|
|
3470
3500
|
* </note>
|
|
3471
3501
|
* @public
|
|
3472
3502
|
*/
|
|
@@ -3853,6 +3883,90 @@ export interface CreatePromptResponse {
|
|
|
3853
3883
|
*/
|
|
3854
3884
|
PromptId?: string | undefined;
|
|
3855
3885
|
}
|
|
3886
|
+
/**
|
|
3887
|
+
* <p>The contact configuration for push notification registration.</p>
|
|
3888
|
+
* @public
|
|
3889
|
+
*/
|
|
3890
|
+
export interface ContactConfiguration {
|
|
3891
|
+
/**
|
|
3892
|
+
* <p>The identifier of the contact within the Amazon Connect instance.</p>
|
|
3893
|
+
* @public
|
|
3894
|
+
*/
|
|
3895
|
+
ContactId: string | undefined;
|
|
3896
|
+
/**
|
|
3897
|
+
* <p>The role of the participant in the chat conversation.</p>
|
|
3898
|
+
* @public
|
|
3899
|
+
*/
|
|
3900
|
+
ParticipantRole?: ParticipantRole | undefined;
|
|
3901
|
+
/**
|
|
3902
|
+
* <p>Whether to include raw connect message in the push notification payload. Default is
|
|
3903
|
+
* <code>False</code>.</p>
|
|
3904
|
+
* @public
|
|
3905
|
+
*/
|
|
3906
|
+
IncludeRawMessage?: boolean | undefined;
|
|
3907
|
+
}
|
|
3908
|
+
/**
|
|
3909
|
+
* @public
|
|
3910
|
+
* @enum
|
|
3911
|
+
*/
|
|
3912
|
+
export declare const DeviceType: {
|
|
3913
|
+
readonly APNS: "APNS";
|
|
3914
|
+
readonly APNS_SANDBOX: "APNS_SANDBOX";
|
|
3915
|
+
readonly GCM: "GCM";
|
|
3916
|
+
};
|
|
3917
|
+
/**
|
|
3918
|
+
* @public
|
|
3919
|
+
*/
|
|
3920
|
+
export type DeviceType = (typeof DeviceType)[keyof typeof DeviceType];
|
|
3921
|
+
/**
|
|
3922
|
+
* @public
|
|
3923
|
+
*/
|
|
3924
|
+
export interface CreatePushNotificationRegistrationRequest {
|
|
3925
|
+
/**
|
|
3926
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the
|
|
3927
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
3928
|
+
* @public
|
|
3929
|
+
*/
|
|
3930
|
+
InstanceId: string | undefined;
|
|
3931
|
+
/**
|
|
3932
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3933
|
+
* request. If not provided, the Amazon Web Services
|
|
3934
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3935
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3936
|
+
* @public
|
|
3937
|
+
*/
|
|
3938
|
+
ClientToken?: string | undefined;
|
|
3939
|
+
/**
|
|
3940
|
+
* <p>The Amazon Resource Name (ARN) of the Pinpoint application.</p>
|
|
3941
|
+
* @public
|
|
3942
|
+
*/
|
|
3943
|
+
PinpointAppArn: string | undefined;
|
|
3944
|
+
/**
|
|
3945
|
+
* <p>The push notification token issued by the Apple or Google gateways.</p>
|
|
3946
|
+
* @public
|
|
3947
|
+
*/
|
|
3948
|
+
DeviceToken: string | undefined;
|
|
3949
|
+
/**
|
|
3950
|
+
* <p>The device type to use when sending the message.</p>
|
|
3951
|
+
* @public
|
|
3952
|
+
*/
|
|
3953
|
+
DeviceType: DeviceType | undefined;
|
|
3954
|
+
/**
|
|
3955
|
+
* <p>The contact configuration for push notification registration.</p>
|
|
3956
|
+
* @public
|
|
3957
|
+
*/
|
|
3958
|
+
ContactConfiguration: ContactConfiguration | undefined;
|
|
3959
|
+
}
|
|
3960
|
+
/**
|
|
3961
|
+
* @public
|
|
3962
|
+
*/
|
|
3963
|
+
export interface CreatePushNotificationRegistrationResponse {
|
|
3964
|
+
/**
|
|
3965
|
+
* <p>The identifier for the registration.</p>
|
|
3966
|
+
* @public
|
|
3967
|
+
*/
|
|
3968
|
+
RegistrationId: string | undefined;
|
|
3969
|
+
}
|
|
3856
3970
|
/**
|
|
3857
3971
|
* <p>The outbound caller ID name, number, and outbound whisper flow.</p>
|
|
3858
3972
|
* @public
|
|
@@ -5922,6 +6036,32 @@ export interface DeletePromptRequest {
|
|
|
5922
6036
|
*/
|
|
5923
6037
|
PromptId: string | undefined;
|
|
5924
6038
|
}
|
|
6039
|
+
/**
|
|
6040
|
+
* @public
|
|
6041
|
+
*/
|
|
6042
|
+
export interface DeletePushNotificationRegistrationRequest {
|
|
6043
|
+
/**
|
|
6044
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the
|
|
6045
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
6046
|
+
* @public
|
|
6047
|
+
*/
|
|
6048
|
+
InstanceId: string | undefined;
|
|
6049
|
+
/**
|
|
6050
|
+
* <p>The identifier for the registration.</p>
|
|
6051
|
+
* @public
|
|
6052
|
+
*/
|
|
6053
|
+
RegistrationId: string | undefined;
|
|
6054
|
+
/**
|
|
6055
|
+
* <p>The identifier of the contact within the Amazon Connect instance.</p>
|
|
6056
|
+
* @public
|
|
6057
|
+
*/
|
|
6058
|
+
ContactId: string | undefined;
|
|
6059
|
+
}
|
|
6060
|
+
/**
|
|
6061
|
+
* @public
|
|
6062
|
+
*/
|
|
6063
|
+
export interface DeletePushNotificationRegistrationResponse {
|
|
6064
|
+
}
|
|
5925
6065
|
/**
|
|
5926
6066
|
* @public
|
|
5927
6067
|
*/
|
|
@@ -6068,85 +6208,6 @@ export interface DeleteUserRequest {
|
|
|
6068
6208
|
*/
|
|
6069
6209
|
UserId: string | undefined;
|
|
6070
6210
|
}
|
|
6071
|
-
/**
|
|
6072
|
-
* @public
|
|
6073
|
-
*/
|
|
6074
|
-
export interface DeleteUserHierarchyGroupRequest {
|
|
6075
|
-
/**
|
|
6076
|
-
* <p>The identifier of the hierarchy group.</p>
|
|
6077
|
-
* @public
|
|
6078
|
-
*/
|
|
6079
|
-
HierarchyGroupId: string | undefined;
|
|
6080
|
-
/**
|
|
6081
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6082
|
-
* @public
|
|
6083
|
-
*/
|
|
6084
|
-
InstanceId: string | undefined;
|
|
6085
|
-
}
|
|
6086
|
-
/**
|
|
6087
|
-
* @public
|
|
6088
|
-
*/
|
|
6089
|
-
export interface DeleteViewRequest {
|
|
6090
|
-
/**
|
|
6091
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
6092
|
-
* the instance.</p>
|
|
6093
|
-
* @public
|
|
6094
|
-
*/
|
|
6095
|
-
InstanceId: string | undefined;
|
|
6096
|
-
/**
|
|
6097
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
6098
|
-
* used.</p>
|
|
6099
|
-
* @public
|
|
6100
|
-
*/
|
|
6101
|
-
ViewId: string | undefined;
|
|
6102
|
-
}
|
|
6103
|
-
/**
|
|
6104
|
-
* @public
|
|
6105
|
-
*/
|
|
6106
|
-
export interface DeleteViewResponse {
|
|
6107
|
-
}
|
|
6108
|
-
/**
|
|
6109
|
-
* @public
|
|
6110
|
-
*/
|
|
6111
|
-
export interface DeleteViewVersionRequest {
|
|
6112
|
-
/**
|
|
6113
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of
|
|
6114
|
-
* the instance.</p>
|
|
6115
|
-
* @public
|
|
6116
|
-
*/
|
|
6117
|
-
InstanceId: string | undefined;
|
|
6118
|
-
/**
|
|
6119
|
-
* <p>The identifier of the view. Both <code>ViewArn</code> and <code>ViewId</code> can be
|
|
6120
|
-
* used.</p>
|
|
6121
|
-
* @public
|
|
6122
|
-
*/
|
|
6123
|
-
ViewId: string | undefined;
|
|
6124
|
-
/**
|
|
6125
|
-
* <p>The version number of the view.</p>
|
|
6126
|
-
* @public
|
|
6127
|
-
*/
|
|
6128
|
-
ViewVersion: number | undefined;
|
|
6129
|
-
}
|
|
6130
|
-
/**
|
|
6131
|
-
* @public
|
|
6132
|
-
*/
|
|
6133
|
-
export interface DeleteViewVersionResponse {
|
|
6134
|
-
}
|
|
6135
|
-
/**
|
|
6136
|
-
* @public
|
|
6137
|
-
*/
|
|
6138
|
-
export interface DeleteVocabularyRequest {
|
|
6139
|
-
/**
|
|
6140
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6141
|
-
* @public
|
|
6142
|
-
*/
|
|
6143
|
-
InstanceId: string | undefined;
|
|
6144
|
-
/**
|
|
6145
|
-
* <p>The identifier of the custom vocabulary.</p>
|
|
6146
|
-
* @public
|
|
6147
|
-
*/
|
|
6148
|
-
VocabularyId: string | undefined;
|
|
6149
|
-
}
|
|
6150
6211
|
/**
|
|
6151
6212
|
* @internal
|
|
6152
6213
|
*/
|