Skip to content

Commit d439613

Browse files
author
awstools
committed
feat(client-connectcases): This release adds DeleteCase and DeleteRelatedItem APIs, which enable deleting cases and comments, undoing contact association, and removing service level agreements (SLAs) from cases. Contact center admins can use these APIs to delete cases when requested by customers and correct agent errors.
1 parent e5eb29d commit d439613

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+821
-854
lines changed

‎clients/client-connectcases/README.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,7 @@
66

77
AWS SDK for JavaScript ConnectCases Client for Node.js, Browser and React Native.
88

9-
<ul>
10-
<li>
11-
<p>
12-
<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases
13-
actions</a>
14-
</p>
15-
</li>
16-
<li>
17-
<p>
18-
<a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data
19-
types</a>
20-
</p>
21-
</li>
22-
</ul>
23-
<p>With Amazon Connect Cases, your agents can track and manage customer issues that require
24-
multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
25-
customer issue. It records the issue, the steps and interactions taken to resolve the issue,
26-
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
27-
<i>Amazon Connect Administrator Guide</i>.</p>
9+
<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>
2810

2911
## Installing
3012

@@ -300,6 +282,14 @@ CreateTemplate
300282

301283
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/CreateTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateTemplateCommandOutput/)
302284

285+
</details>
286+
<details>
287+
<summary>
288+
DeleteCase
289+
</summary>
290+
291+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/DeleteCaseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteCaseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteCaseCommandOutput/)
292+
303293
</details>
304294
<details>
305295
<summary>
@@ -332,6 +322,14 @@ DeleteLayout
332322

333323
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/DeleteLayoutCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteLayoutCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteLayoutCommandOutput/)
334324

325+
</details>
326+
<details>
327+
<summary>
328+
DeleteRelatedItem
329+
</summary>
330+
331+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/DeleteRelatedItemCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteRelatedItemCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteRelatedItemCommandOutput/)
332+
335333
</details>
336334
<details>
337335
<summary>

‎clients/client-connectcases/src/ConnectCases.ts

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ import {
4444
CreateTemplateCommandInput,
4545
CreateTemplateCommandOutput,
4646
} from "./commands/CreateTemplateCommand";
47+
import { DeleteCaseCommand, DeleteCaseCommandInput, DeleteCaseCommandOutput } from "./commands/DeleteCaseCommand";
4748
import {
4849
DeleteCaseRuleCommand,
4950
DeleteCaseRuleCommandInput,
@@ -60,6 +61,11 @@ import {
6061
DeleteLayoutCommandInput,
6162
DeleteLayoutCommandOutput,
6263
} from "./commands/DeleteLayoutCommand";
64+
import {
65+
DeleteRelatedItemCommand,
66+
DeleteRelatedItemCommandInput,
67+
DeleteRelatedItemCommandOutput,
68+
} from "./commands/DeleteRelatedItemCommand";
6369
import {
6470
DeleteTemplateCommand,
6571
DeleteTemplateCommandInput,
@@ -154,10 +160,12 @@ const commands = {
154160
CreateLayoutCommand,
155161
CreateRelatedItemCommand,
156162
CreateTemplateCommand,
163+
DeleteCaseCommand,
157164
DeleteCaseRuleCommand,
158165
DeleteDomainCommand,
159166
DeleteFieldCommand,
160167
DeleteLayoutCommand,
168+
DeleteRelatedItemCommand,
161169
DeleteTemplateCommand,
162170
GetCaseCommand,
163171
GetCaseAuditEventsCommand,
@@ -320,6 +328,17 @@ export interface ConnectCases {
320328
cb: (err: any, data?: CreateTemplateCommandOutput) => void
321329
): void;
322330

331+
/**
332+
* @see {@link DeleteCaseCommand}
333+
*/
334+
deleteCase(args: DeleteCaseCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCaseCommandOutput>;
335+
deleteCase(args: DeleteCaseCommandInput, cb: (err: any, data?: DeleteCaseCommandOutput) => void): void;
336+
deleteCase(
337+
args: DeleteCaseCommandInput,
338+
options: __HttpHandlerOptions,
339+
cb: (err: any, data?: DeleteCaseCommandOutput) => void
340+
): void;
341+
323342
/**
324343
* @see {@link DeleteCaseRuleCommand}
325344
*/
@@ -367,6 +386,23 @@ export interface ConnectCases {
367386
cb: (err: any, data?: DeleteLayoutCommandOutput) => void
368387
): void;
369388

389+
/**
390+
* @see {@link DeleteRelatedItemCommand}
391+
*/
392+
deleteRelatedItem(
393+
args: DeleteRelatedItemCommandInput,
394+
options?: __HttpHandlerOptions
395+
): Promise<DeleteRelatedItemCommandOutput>;
396+
deleteRelatedItem(
397+
args: DeleteRelatedItemCommandInput,
398+
cb: (err: any, data?: DeleteRelatedItemCommandOutput) => void
399+
): void;
400+
deleteRelatedItem(
401+
args: DeleteRelatedItemCommandInput,
402+
options: __HttpHandlerOptions,
403+
cb: (err: any, data?: DeleteRelatedItemCommandOutput) => void
404+
): void;
405+
370406
/**
371407
* @see {@link DeleteTemplateCommand}
372408
*/
@@ -696,25 +732,7 @@ export interface ConnectCases {
696732
}
697733

698734
/**
699-
* <ul>
700-
* <li>
701-
* <p>
702-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases
703-
* actions</a>
704-
* </p>
705-
* </li>
706-
* <li>
707-
* <p>
708-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data
709-
* types</a>
710-
* </p>
711-
* </li>
712-
* </ul>
713-
* <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
714-
* multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
715-
* customer issue. It records the issue, the steps and interactions taken to resolve the issue,
716-
* 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
717-
* <i>Amazon Connect Administrator Guide</i>.</p>
735+
* <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>
718736
* @public
719737
*/
720738
export class ConnectCases extends ConnectCasesClient implements ConnectCases {}

‎clients/client-connectcases/src/ConnectCasesClient.ts

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,12 @@ import { CreateFieldCommandInput, CreateFieldCommandOutput } from "./commands/Cr
6666
import { CreateLayoutCommandInput, CreateLayoutCommandOutput } from "./commands/CreateLayoutCommand";
6767
import { CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput } from "./commands/CreateRelatedItemCommand";
6868
import { CreateTemplateCommandInput, CreateTemplateCommandOutput } from "./commands/CreateTemplateCommand";
69+
import { DeleteCaseCommandInput, DeleteCaseCommandOutput } from "./commands/DeleteCaseCommand";
6970
import { DeleteCaseRuleCommandInput, DeleteCaseRuleCommandOutput } from "./commands/DeleteCaseRuleCommand";
7071
import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "./commands/DeleteDomainCommand";
7172
import { DeleteFieldCommandInput, DeleteFieldCommandOutput } from "./commands/DeleteFieldCommand";
7273
import { DeleteLayoutCommandInput, DeleteLayoutCommandOutput } from "./commands/DeleteLayoutCommand";
74+
import { DeleteRelatedItemCommandInput, DeleteRelatedItemCommandOutput } from "./commands/DeleteRelatedItemCommand";
7375
import { DeleteTemplateCommandInput, DeleteTemplateCommandOutput } from "./commands/DeleteTemplateCommand";
7476
import { GetCaseAuditEventsCommandInput, GetCaseAuditEventsCommandOutput } from "./commands/GetCaseAuditEventsCommand";
7577
import { GetCaseCommandInput, GetCaseCommandOutput } from "./commands/GetCaseCommand";
@@ -132,10 +134,12 @@ export type ServiceInputTypes =
132134
| CreateLayoutCommandInput
133135
| CreateRelatedItemCommandInput
134136
| CreateTemplateCommandInput
137+
| DeleteCaseCommandInput
135138
| DeleteCaseRuleCommandInput
136139
| DeleteDomainCommandInput
137140
| DeleteFieldCommandInput
138141
| DeleteLayoutCommandInput
142+
| DeleteRelatedItemCommandInput
139143
| DeleteTemplateCommandInput
140144
| GetCaseAuditEventsCommandInput
141145
| GetCaseCommandInput
@@ -176,10 +180,12 @@ export type ServiceOutputTypes =
176180
| CreateLayoutCommandOutput
177181
| CreateRelatedItemCommandOutput
178182
| CreateTemplateCommandOutput
183+
| DeleteCaseCommandOutput
179184
| DeleteCaseRuleCommandOutput
180185
| DeleteDomainCommandOutput
181186
| DeleteFieldCommandOutput
182187
| DeleteLayoutCommandOutput
188+
| DeleteRelatedItemCommandOutput
183189
| DeleteTemplateCommandOutput
184190
| GetCaseAuditEventsCommandOutput
185191
| GetCaseCommandOutput
@@ -397,25 +403,7 @@ export type ConnectCasesClientResolvedConfigType = __SmithyResolvedConfiguration
397403
export interface ConnectCasesClientResolvedConfig extends ConnectCasesClientResolvedConfigType {}
398404

399405
/**
400-
* <ul>
401-
* <li>
402-
* <p>
403-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases
404-
* actions</a>
405-
* </p>
406-
* </li>
407-
* <li>
408-
* <p>
409-
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data
410-
* types</a>
411-
* </p>
412-
* </li>
413-
* </ul>
414-
* <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
415-
* multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
416-
* customer issue. It records the issue, the steps and interactions taken to resolve the issue,
417-
* 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
418-
* <i>Amazon Connect Administrator Guide</i>.</p>
406+
* <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>
419407
* @public
420408
*/
421409
export class ConnectCasesClient extends __Client<

‎clients/client-connectcases/src/commands/BatchGetCaseRuleCommand.ts

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,7 @@ export interface BatchGetCaseRuleCommandInput extends BatchGetCaseRuleRequest {}
2828
export interface BatchGetCaseRuleCommandOutput extends BatchGetCaseRuleResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>. For more
32-
* 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
33-
* case template</a>.</p>
31+
* <p>Gets a batch of case rules. 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>
3432
* @example
3533
* Use a bare-bones client and the command you need to make an API call.
3634
* ```javascript
@@ -116,12 +114,10 @@ export interface BatchGetCaseRuleCommandOutput extends BatchGetCaseRuleResponse,
116114
* <p>You do not have sufficient access to perform this action.</p>
117115
*
118116
* @throws {@link InternalServerException} (server fault)
119-
* <p>We couldn't process your request because of an issue with the server. Try again
120-
* later.</p>
117+
* <p>We couldn't process your request because of an issue with the server. Try again later.</p>
121118
*
122119
* @throws {@link ResourceNotFoundException} (client fault)
123-
* <p>We couldn't find the requested resource. Check that your resources exists and were created
124-
* in the same Amazon Web Services Region as your request, and try your request again.</p>
120+
* <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>
125121
*
126122
* @throws {@link ThrottlingException} (client fault)
127123
* <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>

‎clients/client-connectcases/src/commands/BatchGetFieldCommand.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,10 @@ export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __Met
8383
* <p>You do not have sufficient access to perform this action.</p>
8484
*
8585
* @throws {@link InternalServerException} (server fault)
86-
* <p>We couldn't process your request because of an issue with the server. Try again
87-
* later.</p>
86+
* <p>We couldn't process your request because of an issue with the server. Try again later.</p>
8887
*
8988
* @throws {@link ResourceNotFoundException} (client fault)
90-
* <p>We couldn't find the requested resource. Check that your resources exists and were created
91-
* in the same Amazon Web Services Region as your request, and try your request again.</p>
89+
* <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>
9290
*
9391
* @throws {@link ThrottlingException} (client fault)
9492
* <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>

‎clients/client-connectcases/src/commands/BatchPutFieldOptionsCommand.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface BatchPutFieldOptionsCommandInput extends BatchPutFieldOptionsRe
2828
export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates and updates a set of field options for a single select field in a Cases
32-
* domain.</p>
31+
* <p>Creates and updates a set of field options for a single select field in a Cases domain.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -71,16 +70,13 @@ export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsR
7170
* <p>You do not have sufficient access to perform this action.</p>
7271
*
7372
* @throws {@link InternalServerException} (server fault)
74-
* <p>We couldn't process your request because of an issue with the server. Try again
75-
* later.</p>
73+
* <p>We couldn't process your request because of an issue with the server. Try again later.</p>
7674
*
7775
* @throws {@link ResourceNotFoundException} (client fault)
78-
* <p>We couldn't find the requested resource. Check that your resources exists and were created
79-
* in the same Amazon Web Services Region as your request, and try your request again.</p>
76+
* <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>
8077
*
8178
* @throws {@link ServiceQuotaExceededException} (client fault)
82-
* <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
83-
* Administrator Guide</i>.</p>
79+
* <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>
8480
*
8581
* @throws {@link ThrottlingException} (client fault)
8682
* <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>

0 commit comments

Comments
 (0)