@aws-sdk/client-connectcases 3.840.0 → 3.842.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 (62) hide show
  1. package/README.md +17 -19
  2. package/dist-cjs/index.js +77 -0
  3. package/dist-es/ConnectCases.js +4 -0
  4. package/dist-es/commands/DeleteCaseCommand.js +22 -0
  5. package/dist-es/commands/DeleteRelatedItemCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/protocols/Aws_restJson1.js +41 -0
  8. package/dist-types/ConnectCases.d.ts +15 -19
  9. package/dist-types/ConnectCasesClient.d.ts +5 -21
  10. package/dist-types/commands/BatchGetCaseRuleCommand.d.ts +3 -7
  11. package/dist-types/commands/BatchGetFieldCommand.d.ts +2 -4
  12. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +4 -8
  13. package/dist-types/commands/CreateCaseCommand.d.ts +4 -27
  14. package/dist-types/commands/CreateCaseRuleCommand.d.ts +5 -12
  15. package/dist-types/commands/CreateDomainCommand.d.ts +4 -17
  16. package/dist-types/commands/CreateFieldCommand.d.ts +5 -11
  17. package/dist-types/commands/CreateLayoutCommand.d.ts +5 -23
  18. package/dist-types/commands/CreateRelatedItemCommand.d.ts +4 -26
  19. package/dist-types/commands/CreateTemplateCommand.d.ts +5 -38
  20. package/dist-types/commands/DeleteCaseCommand.d.ts +86 -0
  21. package/dist-types/commands/DeleteCaseRuleCommand.d.ts +4 -10
  22. package/dist-types/commands/DeleteDomainCommand.d.ts +4 -12
  23. package/dist-types/commands/DeleteFieldCommand.d.ts +5 -62
  24. package/dist-types/commands/DeleteLayoutCommand.d.ts +4 -22
  25. package/dist-types/commands/DeleteRelatedItemCommand.d.ts +87 -0
  26. package/dist-types/commands/DeleteTemplateCommand.d.ts +4 -23
  27. package/dist-types/commands/GetCaseAuditEventsCommand.d.ts +2 -4
  28. package/dist-types/commands/GetCaseCommand.d.ts +2 -4
  29. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +2 -4
  30. package/dist-types/commands/GetDomainCommand.d.ts +2 -4
  31. package/dist-types/commands/GetLayoutCommand.d.ts +2 -4
  32. package/dist-types/commands/GetTemplateCommand.d.ts +3 -27
  33. package/dist-types/commands/ListCaseRulesCommand.d.ts +3 -7
  34. package/dist-types/commands/ListCasesForContactCommand.d.ts +2 -4
  35. package/dist-types/commands/ListDomainsCommand.d.ts +2 -4
  36. package/dist-types/commands/ListFieldOptionsCommand.d.ts +2 -4
  37. package/dist-types/commands/ListFieldsCommand.d.ts +2 -4
  38. package/dist-types/commands/ListLayoutsCommand.d.ts +3 -6
  39. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -4
  40. package/dist-types/commands/ListTemplatesCommand.d.ts +3 -29
  41. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +4 -11
  42. package/dist-types/commands/SearchCasesCommand.d.ts +3 -11
  43. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +3 -9
  44. package/dist-types/commands/TagResourceCommand.d.ts +2 -4
  45. package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
  46. package/dist-types/commands/UpdateCaseCommand.d.ts +3 -11
  47. package/dist-types/commands/UpdateCaseRuleCommand.d.ts +4 -10
  48. package/dist-types/commands/UpdateFieldCommand.d.ts +3 -7
  49. package/dist-types/commands/UpdateLayoutCommand.d.ts +5 -18
  50. package/dist-types/commands/UpdateTemplateCommand.d.ts +4 -35
  51. package/dist-types/commands/index.d.ts +2 -0
  52. package/dist-types/index.d.ts +1 -19
  53. package/dist-types/models/models_0.d.ts +107 -159
  54. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  55. package/dist-types/ts3.4/ConnectCases.d.ts +34 -0
  56. package/dist-types/ts3.4/ConnectCasesClient.d.ts +12 -0
  57. package/dist-types/ts3.4/commands/DeleteCaseCommand.d.ts +47 -0
  58. package/dist-types/ts3.4/commands/DeleteRelatedItemCommand.d.ts +51 -0
  59. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  60. package/dist-types/ts3.4/models/models_0.d.ts +11 -0
  61. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  62. package/package.json +1 -1
@@ -27,9 +27,7 @@ declare const UpdateCaseRuleCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more
31
- * information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a
32
- * case template</a>.</p>
30
+ * <p>Updates a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a case template</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -91,17 +89,13 @@ declare const UpdateCaseRuleCommand_base: {
91
89
  * <p>You do not have sufficient access to perform this action.</p>
92
90
  *
93
91
  * @throws {@link ConflictException} (client fault)
94
- * <p>The requested operation would cause a conflict with the current state of a service
95
- * resource associated with the request. Resolve the conflict before retrying this request. See
96
- * the accompanying error message for details.</p>
92
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
97
93
  *
98
94
  * @throws {@link InternalServerException} (server fault)
99
- * <p>We couldn't process your request because of an issue with the server. Try again
100
- * later.</p>
95
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
101
96
  *
102
97
  * @throws {@link ResourceNotFoundException} (client fault)
103
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
104
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
98
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
105
99
  *
106
100
  * @throws {@link ThrottlingException} (client fault)
107
101
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -56,17 +56,13 @@ declare const UpdateFieldCommand_base: {
56
56
  * <p>You do not have sufficient access to perform this action.</p>
57
57
  *
58
58
  * @throws {@link ConflictException} (client fault)
59
- * <p>The requested operation would cause a conflict with the current state of a service
60
- * resource associated with the request. Resolve the conflict before retrying this request. See
61
- * the accompanying error message for details.</p>
59
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
62
60
  *
63
61
  * @throws {@link InternalServerException} (server fault)
64
- * <p>We couldn't process your request because of an issue with the server. Try again
65
- * later.</p>
62
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
66
63
  *
67
64
  * @throws {@link ResourceNotFoundException} (client fault)
68
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
69
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
65
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
70
66
  *
71
67
  * @throws {@link ThrottlingException} (client fault)
72
68
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,15 +27,7 @@ declare const UpdateLayoutCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the attributes of an existing layout.</p>
31
- * <p>If the action is successful, the service sends back an HTTP 200 response with an empty
32
- * HTTP body.</p>
33
- * <p>A <code>ValidationException</code> is returned when you add non-existent
34
- * <code>fieldIds</code> to a layout.</p>
35
- * <note>
36
- * <p>Title and Status fields cannot be part of layouts because they are not
37
- * configurable.</p>
38
- * </note>
30
+ * <p>Updates the attributes of an existing layout.</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> <p>A <code>ValidationException</code> is returned when you add non-existent <code>fieldIds</code> to a layout.</p> <note> <p>Title and Status fields cannot be part of layouts because they are not configurable.</p> </note>
39
31
  * @example
40
32
  * Use a bare-bones client and the command you need to make an API call.
41
33
  * ```javascript
@@ -95,21 +87,16 @@ declare const UpdateLayoutCommand_base: {
95
87
  * <p>You do not have sufficient access to perform this action.</p>
96
88
  *
97
89
  * @throws {@link ConflictException} (client fault)
98
- * <p>The requested operation would cause a conflict with the current state of a service
99
- * resource associated with the request. Resolve the conflict before retrying this request. See
100
- * the accompanying error message for details.</p>
90
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
101
91
  *
102
92
  * @throws {@link InternalServerException} (server fault)
103
- * <p>We couldn't process your request because of an issue with the server. Try again
104
- * later.</p>
93
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
105
94
  *
106
95
  * @throws {@link ResourceNotFoundException} (client fault)
107
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
108
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
96
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
109
97
  *
110
98
  * @throws {@link ServiceQuotaExceededException} (client fault)
111
- * <p>The service quota has been exceeded. For a list of service quotas, see <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
112
- * Administrator Guide</i>.</p>
99
+ * <p>The service quota has been exceeded. For a list of service quotas, see <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 Guide</i>.</p>
113
100
  *
114
101
  * @throws {@link ThrottlingException} (client fault)
115
102
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -27,34 +27,7 @@ declare const UpdateTemplateCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the attributes of an existing template. The template attributes that can be
31
- * modified include <code>name</code>, <code>description</code>,
32
- * <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At
33
- * least one of these attributes must not be null. If a null value is provided for a given
34
- * attribute, that attribute is ignored and its current value is preserved.</p>
35
- * <p>Other template APIs are:</p>
36
- * <ul>
37
- * <li>
38
- * <p>
39
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a>
40
- * </p>
41
- * </li>
42
- * <li>
43
- * <p>
44
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a>
45
- * </p>
46
- * </li>
47
- * <li>
48
- * <p>
49
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a>
50
- * </p>
51
- * </li>
52
- * <li>
53
- * <p>
54
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a>
55
- * </p>
56
- * </li>
57
- * </ul>
30
+ * <p>Updates the attributes of an existing template. The template attributes that can be modified include <code>name</code>, <code>description</code>, <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.</p> <p>Other template APIs are:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a> </p> </li> </ul>
58
31
  * @example
59
32
  * Use a bare-bones client and the command you need to make an API call.
60
33
  * ```javascript
@@ -98,17 +71,13 @@ declare const UpdateTemplateCommand_base: {
98
71
  * <p>You do not have sufficient access to perform this action.</p>
99
72
  *
100
73
  * @throws {@link ConflictException} (client fault)
101
- * <p>The requested operation would cause a conflict with the current state of a service
102
- * resource associated with the request. Resolve the conflict before retrying this request. See
103
- * the accompanying error message for details.</p>
74
+ * <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
104
75
  *
105
76
  * @throws {@link InternalServerException} (server fault)
106
- * <p>We couldn't process your request because of an issue with the server. Try again
107
- * later.</p>
77
+ * <p>We couldn't process your request because of an issue with the server. Try again later.</p>
108
78
  *
109
79
  * @throws {@link ResourceNotFoundException} (client fault)
110
- * <p>We couldn't find the requested resource. Check that your resources exists and were created
111
- * in the same Amazon Web Services Region as your request, and try your request again.</p>
80
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created in the same Amazon Web Services Region as your request, and try your request again.</p>
112
81
  *
113
82
  * @throws {@link ThrottlingException} (client fault)
114
83
  * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
@@ -8,10 +8,12 @@ export * from "./CreateFieldCommand";
8
8
  export * from "./CreateLayoutCommand";
9
9
  export * from "./CreateRelatedItemCommand";
10
10
  export * from "./CreateTemplateCommand";
11
+ export * from "./DeleteCaseCommand";
11
12
  export * from "./DeleteCaseRuleCommand";
12
13
  export * from "./DeleteDomainCommand";
13
14
  export * from "./DeleteFieldCommand";
14
15
  export * from "./DeleteLayoutCommand";
16
+ export * from "./DeleteRelatedItemCommand";
15
17
  export * from "./DeleteTemplateCommand";
16
18
  export * from "./GetCaseAuditEventsCommand";
17
19
  export * from "./GetCaseCommand";
@@ -1,23 +1,5 @@
1
1
  /**
2
- * <ul>
3
- * <li>
4
- * <p>
5
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases
6
- * actions</a>
7
- * </p>
8
- * </li>
9
- * <li>
10
- * <p>
11
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data
12
- * types</a>
13
- * </p>
14
- * </li>
15
- * </ul>
16
- * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
17
- * multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
18
- * customer issue. It records the issue, the steps and interactions taken to resolve the issue,
19
- * and the outcome. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the
20
- * <i>Amazon Connect Administrator Guide</i>.</p>
2
+ * <ul> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases actions</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data types</a> </p> </li> </ul> <p>With Amazon Connect Cases, your agents can track and manage customer issues that require multiple interactions, follow-up tasks, and teams in your contact center. A case represents a customer issue. It records the issue, the steps and interactions taken to resolve the issue, and the outcome. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
21
3
  *
22
4
  * @packageDocumentation
23
5
  */