@aws-sdk/client-connect 3.473.0 → 3.475.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.
Files changed (61) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/Connect.js +8 -0
  3. package/dist-cjs/commands/PauseContactCommand.js +51 -0
  4. package/dist-cjs/commands/ResumeContactCommand.js +51 -0
  5. package/dist-cjs/commands/TagContactCommand.js +51 -0
  6. package/dist-cjs/commands/UntagContactCommand.js +51 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +7 -5
  9. package/dist-cjs/models/models_1.js +19 -6
  10. package/dist-cjs/models/models_2.js +6 -1
  11. package/dist-cjs/protocols/Aws_restJson1.js +414 -10
  12. package/dist-es/Connect.js +8 -0
  13. package/dist-es/commands/PauseContactCommand.js +47 -0
  14. package/dist-es/commands/ResumeContactCommand.js +47 -0
  15. package/dist-es/commands/TagContactCommand.js +47 -0
  16. package/dist-es/commands/UntagContactCommand.js +47 -0
  17. package/dist-es/commands/index.js +4 -0
  18. package/dist-es/models/models_0.js +6 -4
  19. package/dist-es/models/models_1.js +17 -5
  20. package/dist-es/models/models_2.js +5 -0
  21. package/dist-es/protocols/Aws_restJson1.js +400 -4
  22. package/dist-types/Connect.d.ts +28 -0
  23. package/dist-types/ConnectClient.d.ts +6 -2
  24. package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +2 -2
  25. package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
  26. package/dist-types/commands/CreateRuleCommand.d.ts +30 -2
  27. package/dist-types/commands/DescribeContactCommand.d.ts +8 -0
  28. package/dist-types/commands/DescribePromptCommand.d.ts +2 -1
  29. package/dist-types/commands/DescribeQueueCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeRuleCommand.d.ts +30 -2
  31. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  32. package/dist-types/commands/ListRulesCommand.d.ts +3 -3
  33. package/dist-types/commands/PauseContactCommand.d.ts +97 -0
  34. package/dist-types/commands/ResumeContactCommand.d.ts +94 -0
  35. package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
  36. package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
  37. package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +9 -0
  38. package/dist-types/commands/TagContactCommand.d.ts +92 -0
  39. package/dist-types/commands/UntagContactCommand.d.ts +91 -0
  40. package/dist-types/commands/UpdateRuleCommand.d.ts +29 -1
  41. package/dist-types/commands/index.d.ts +4 -0
  42. package/dist-types/models/models_0.d.ts +164 -175
  43. package/dist-types/models/models_1.d.ts +237 -319
  44. package/dist-types/models/models_2.d.ts +398 -9
  45. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  46. package/dist-types/ts3.4/Connect.d.ts +68 -0
  47. package/dist-types/ts3.4/ConnectClient.d.ts +24 -0
  48. package/dist-types/ts3.4/commands/DescribePromptCommand.d.ts +2 -4
  49. package/dist-types/ts3.4/commands/DescribeQueueCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/PauseContactCommand.d.ts +35 -0
  51. package/dist-types/ts3.4/commands/ResumeContactCommand.d.ts +38 -0
  52. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
  53. package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/TagContactCommand.d.ts +35 -0
  55. package/dist-types/ts3.4/commands/UntagContactCommand.d.ts +35 -0
  56. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  57. package/dist-types/ts3.4/models/models_0.d.ts +34 -37
  58. package/dist-types/ts3.4/models/models_1.d.ts +56 -65
  59. package/dist-types/ts3.4/models/models_2.d.ts +84 -5
  60. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
  61. package/package.json +4 -4
@@ -0,0 +1,92 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
+ import { TagContactRequest, TagContactResponse } from "../models/models_2";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link TagContactCommand}.
14
+ */
15
+ export interface TagContactCommandInput extends TagContactRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link TagContactCommand}.
21
+ */
22
+ export interface TagContactCommandOutput extends TagContactResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Adds the specified tags to the contact resource. For more information about this API is used, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html">Set up granular billing for a detailed
27
+ * view of your Amazon Connect usage</a>.
28
+ * </p>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { ConnectClient, TagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import
33
+ * // const { ConnectClient, TagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import
34
+ * const client = new ConnectClient(config);
35
+ * const input = { // TagContactRequest
36
+ * ContactId: "STRING_VALUE", // required
37
+ * InstanceId: "STRING_VALUE", // required
38
+ * Tags: { // ContactTagMap // required
39
+ * "<keys>": "STRING_VALUE",
40
+ * },
41
+ * };
42
+ * const command = new TagContactCommand(input);
43
+ * const response = await client.send(command);
44
+ * // {};
45
+ *
46
+ * ```
47
+ *
48
+ * @param TagContactCommandInput - {@link TagContactCommandInput}
49
+ * @returns {@link TagContactCommandOutput}
50
+ * @see {@link TagContactCommandInput} for command's `input` shape.
51
+ * @see {@link TagContactCommandOutput} for command's `response` shape.
52
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
53
+ *
54
+ * @throws {@link InternalServiceException} (server fault)
55
+ * <p>Request processing failed because of an error or failure with the service.</p>
56
+ *
57
+ * @throws {@link InvalidParameterException} (client fault)
58
+ * <p>One or more of the specified parameters are not valid.</p>
59
+ *
60
+ * @throws {@link InvalidRequestException} (client fault)
61
+ * <p>The request is 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
+ */
73
+ export declare class TagContactCommand extends $Command<TagContactCommandInput, TagContactCommandOutput, ConnectClientResolvedConfig> {
74
+ readonly input: TagContactCommandInput;
75
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
79
+ constructor(input: TagContactCommandInput);
80
+ /**
81
+ * @internal
82
+ */
83
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagContactCommandInput, TagContactCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
87
+ private serialize;
88
+ /**
89
+ * @internal
90
+ */
91
+ private deserialize;
92
+ }
@@ -0,0 +1,91 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
5
+ import { UntagContactRequest, UntagContactResponse } from "../models/models_2";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UntagContactCommand}.
14
+ */
15
+ export interface UntagContactCommandInput extends UntagContactRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UntagContactCommand}.
21
+ */
22
+ export interface UntagContactCommandOutput extends UntagContactResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Removes the specified tags from the contact resource. For more information about this API is used, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html">Set up granular billing for a detailed
27
+ * view of your Amazon Connect usage</a>.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { ConnectClient, UntagContactCommand } from "@aws-sdk/client-connect"; // ES Modules import
32
+ * // const { ConnectClient, UntagContactCommand } = require("@aws-sdk/client-connect"); // CommonJS import
33
+ * const client = new ConnectClient(config);
34
+ * const input = { // UntagContactRequest
35
+ * ContactId: "STRING_VALUE", // required
36
+ * InstanceId: "STRING_VALUE", // required
37
+ * TagKeys: [ // ContactTagKeys // required
38
+ * "STRING_VALUE",
39
+ * ],
40
+ * };
41
+ * const command = new UntagContactCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param UntagContactCommandInput - {@link UntagContactCommandInput}
48
+ * @returns {@link UntagContactCommandOutput}
49
+ * @see {@link UntagContactCommandInput} for command's `input` shape.
50
+ * @see {@link UntagContactCommandOutput} for command's `response` shape.
51
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
52
+ *
53
+ * @throws {@link InternalServiceException} (server fault)
54
+ * <p>Request processing failed because of an error or failure with the service.</p>
55
+ *
56
+ * @throws {@link InvalidParameterException} (client fault)
57
+ * <p>One or more of the specified parameters are not valid.</p>
58
+ *
59
+ * @throws {@link InvalidRequestException} (client fault)
60
+ * <p>The request is not valid.</p>
61
+ *
62
+ * @throws {@link ResourceNotFoundException} (client fault)
63
+ * <p>The specified resource was not found.</p>
64
+ *
65
+ * @throws {@link ThrottlingException} (client fault)
66
+ * <p>The throttling limit has been exceeded.</p>
67
+ *
68
+ * @throws {@link ConnectServiceException}
69
+ * <p>Base exception class for all service exceptions from Connect service.</p>
70
+ *
71
+ */
72
+ export declare class UntagContactCommand extends $Command<UntagContactCommandInput, UntagContactCommandOutput, ConnectClientResolvedConfig> {
73
+ readonly input: UntagContactCommandInput;
74
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
78
+ constructor(input: UntagContactCommandInput);
79
+ /**
80
+ * @internal
81
+ */
82
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagContactCommandInput, UntagContactCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
86
+ private serialize;
87
+ /**
88
+ * @internal
89
+ */
90
+ private deserialize;
91
+ }
@@ -39,7 +39,7 @@ export interface UpdateRuleCommandOutput extends __MetadataBearer {
39
39
  * Function: "STRING_VALUE", // required
40
40
  * Actions: [ // RuleActions // required
41
41
  * { // RuleAction
42
- * ActionType: "CREATE_TASK" || "ASSIGN_CONTACT_CATEGORY" || "GENERATE_EVENTBRIDGE_EVENT" || "SEND_NOTIFICATION", // required
42
+ * ActionType: "CREATE_TASK" || "ASSIGN_CONTACT_CATEGORY" || "GENERATE_EVENTBRIDGE_EVENT" || "SEND_NOTIFICATION" || "CREATE_CASE" || "UPDATE_CASE" || "END_ASSOCIATED_TASKS", // required
43
43
  * TaskAction: { // TaskActionDefinition
44
44
  * Name: "STRING_VALUE", // required
45
45
  * Description: "STRING_VALUE",
@@ -69,6 +69,34 @@ export interface UpdateRuleCommandOutput extends __MetadataBearer {
69
69
  * ],
70
70
  * },
71
71
  * },
72
+ * CreateCaseAction: { // CreateCaseActionDefinition
73
+ * Fields: [ // FieldValues // required
74
+ * { // FieldValue
75
+ * Id: "STRING_VALUE", // required
76
+ * Value: { // FieldValueUnion
77
+ * BooleanValue: true || false,
78
+ * DoubleValue: Number("double"),
79
+ * EmptyValue: {},
80
+ * StringValue: "STRING_VALUE",
81
+ * },
82
+ * },
83
+ * ],
84
+ * TemplateId: "STRING_VALUE", // required
85
+ * },
86
+ * UpdateCaseAction: { // UpdateCaseActionDefinition
87
+ * Fields: [ // required
88
+ * {
89
+ * Id: "STRING_VALUE", // required
90
+ * Value: {
91
+ * BooleanValue: true || false,
92
+ * DoubleValue: Number("double"),
93
+ * EmptyValue: {},
94
+ * StringValue: "STRING_VALUE",
95
+ * },
96
+ * },
97
+ * ],
98
+ * },
99
+ * EndAssociatedTasksAction: {},
72
100
  * },
73
101
  * ],
74
102
  * PublishStatus: "DRAFT" || "PUBLISHED", // required
@@ -152,9 +152,11 @@ export * from "./ListUsersCommand";
152
152
  export * from "./ListViewVersionsCommand";
153
153
  export * from "./ListViewsCommand";
154
154
  export * from "./MonitorContactCommand";
155
+ export * from "./PauseContactCommand";
155
156
  export * from "./PutUserStatusCommand";
156
157
  export * from "./ReleasePhoneNumberCommand";
157
158
  export * from "./ReplicateInstanceCommand";
159
+ export * from "./ResumeContactCommand";
158
160
  export * from "./ResumeContactRecordingCommand";
159
161
  export * from "./SearchAvailablePhoneNumbersCommand";
160
162
  export * from "./SearchHoursOfOperationsCommand";
@@ -179,8 +181,10 @@ export * from "./StopContactRecordingCommand";
179
181
  export * from "./StopContactStreamingCommand";
180
182
  export * from "./SubmitContactEvaluationCommand";
181
183
  export * from "./SuspendContactRecordingCommand";
184
+ export * from "./TagContactCommand";
182
185
  export * from "./TagResourceCommand";
183
186
  export * from "./TransferContactCommand";
187
+ export * from "./UntagContactCommand";
184
188
  export * from "./UntagResourceCommand";
185
189
  export * from "./UpdateAgentStatusCommand";
186
190
  export * from "./UpdateContactAttributesCommand";