feat(client-connectcases): This release adds the ability to condition…

…ally require fields on a template. Check public documentation for more information.
aws · Feb 6, 2025 · 83f7355 · 83f7355
1 parent f4a25ae
commit 83f7355
Show file tree

Hide file tree

Showing 24 changed files with 2,195 additions and 26 deletions.
diff --git a/clients/client-connectcases/README.md b/clients/client-connectcases/README.md
@@ -6,6 +6,20 @@
 
 AWS SDK for JavaScript ConnectCases Client for Node.js, Browser and React Native.
 
+<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,
@@ -207,6 +221,14 @@ see LICENSE for more information.
 
 ## Client Commands (Operations List)
 
+<details>
+<summary>
+BatchGetCaseRule
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/BatchGetCaseRuleCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/BatchGetCaseRuleCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/BatchGetCaseRuleCommandOutput/)
+
+</details>
 <details>
 <summary>
 BatchGetField
@@ -230,6 +252,14 @@ CreateCase
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/CreateCaseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateCaseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateCaseCommandOutput/)
 
+</details>
+<details>
+<summary>
+CreateCaseRule
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/CreateCaseRuleCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateCaseRuleCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/CreateCaseRuleCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -270,6 +300,14 @@ CreateTemplate
 
 [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/)
 
+</details>
+<details>
+<summary>
+DeleteCaseRule
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/DeleteCaseRuleCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteCaseRuleCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/DeleteCaseRuleCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -350,6 +388,14 @@ GetTemplate
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/GetTemplateCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/GetTemplateCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/GetTemplateCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListCaseRules
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/ListCaseRulesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/ListCaseRulesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/ListCaseRulesCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -454,6 +500,14 @@ UpdateCase
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/UpdateCaseCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/UpdateCaseCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/UpdateCaseCommandOutput/)
 
+</details>
+<details>
+<summary>
+UpdateCaseRule
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connectcases/command/UpdateCaseRuleCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/UpdateCaseRuleCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connectcases/Interface/UpdateCaseRuleCommandOutput/)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-connectcases/src/ConnectCases.ts b/clients/client-connectcases/src/ConnectCases.ts
@@ -2,6 +2,11 @@
 import { createAggregatedClient } from "@smithy/smithy-client";
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
 
+import {
+  BatchGetCaseRuleCommand,
+  BatchGetCaseRuleCommandInput,
+  BatchGetCaseRuleCommandOutput,
+} from "./commands/BatchGetCaseRuleCommand";
 import {
   BatchGetFieldCommand,
   BatchGetFieldCommandInput,
@@ -13,6 +18,11 @@ import {
   BatchPutFieldOptionsCommandOutput,
 } from "./commands/BatchPutFieldOptionsCommand";
 import { CreateCaseCommand, CreateCaseCommandInput, CreateCaseCommandOutput } from "./commands/CreateCaseCommand";
+import {
+  CreateCaseRuleCommand,
+  CreateCaseRuleCommandInput,
+  CreateCaseRuleCommandOutput,
+} from "./commands/CreateCaseRuleCommand";
 import {
   CreateDomainCommand,
   CreateDomainCommandInput,
@@ -34,6 +44,11 @@ import {
   CreateTemplateCommandInput,
   CreateTemplateCommandOutput,
 } from "./commands/CreateTemplateCommand";
+import {
+  DeleteCaseRuleCommand,
+  DeleteCaseRuleCommandInput,
+  DeleteCaseRuleCommandOutput,
+} from "./commands/DeleteCaseRuleCommand";
 import {
   DeleteDomainCommand,
   DeleteDomainCommandInput,
@@ -64,6 +79,11 @@ import {
 import { GetDomainCommand, GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
 import { GetLayoutCommand, GetLayoutCommandInput, GetLayoutCommandOutput } from "./commands/GetLayoutCommand";
 import { GetTemplateCommand, GetTemplateCommandInput, GetTemplateCommandOutput } from "./commands/GetTemplateCommand";
+import {
+  ListCaseRulesCommand,
+  ListCaseRulesCommandInput,
+  ListCaseRulesCommandOutput,
+} from "./commands/ListCaseRulesCommand";
 import {
   ListCasesForContactCommand,
   ListCasesForContactCommandInput,
@@ -105,6 +125,11 @@ import {
   UntagResourceCommandOutput,
 } from "./commands/UntagResourceCommand";
 import { UpdateCaseCommand, UpdateCaseCommandInput, UpdateCaseCommandOutput } from "./commands/UpdateCaseCommand";
+import {
+  UpdateCaseRuleCommand,
+  UpdateCaseRuleCommandInput,
+  UpdateCaseRuleCommandOutput,
+} from "./commands/UpdateCaseRuleCommand";
 import { UpdateFieldCommand, UpdateFieldCommandInput, UpdateFieldCommandOutput } from "./commands/UpdateFieldCommand";
 import {
   UpdateLayoutCommand,
@@ -119,14 +144,17 @@ import {
 import { ConnectCasesClient, ConnectCasesClientConfig } from "./ConnectCasesClient";
 
 const commands = {
+  BatchGetCaseRuleCommand,
   BatchGetFieldCommand,
   BatchPutFieldOptionsCommand,
   CreateCaseCommand,
+  CreateCaseRuleCommand,
   CreateDomainCommand,
   CreateFieldCommand,
   CreateLayoutCommand,
   CreateRelatedItemCommand,
   CreateTemplateCommand,
+  DeleteCaseRuleCommand,
   DeleteDomainCommand,
   DeleteFieldCommand,
   DeleteLayoutCommand,
@@ -137,6 +165,7 @@ const commands = {
   GetDomainCommand,
   GetLayoutCommand,
   GetTemplateCommand,
+  ListCaseRulesCommand,
   ListCasesForContactCommand,
   ListDomainsCommand,
   ListFieldOptionsCommand,
@@ -150,12 +179,30 @@ const commands = {
   TagResourceCommand,
   UntagResourceCommand,
   UpdateCaseCommand,
+  UpdateCaseRuleCommand,
   UpdateFieldCommand,
   UpdateLayoutCommand,
   UpdateTemplateCommand,
 };
 
 export interface ConnectCases {
+  /**
+   * @see {@link BatchGetCaseRuleCommand}
+   */
+  batchGetCaseRule(
+    args: BatchGetCaseRuleCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<BatchGetCaseRuleCommandOutput>;
+  batchGetCaseRule(
+    args: BatchGetCaseRuleCommandInput,
+    cb: (err: any, data?: BatchGetCaseRuleCommandOutput) => void
+  ): void;
+  batchGetCaseRule(
+    args: BatchGetCaseRuleCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: BatchGetCaseRuleCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link BatchGetFieldCommand}
    */
@@ -195,6 +242,20 @@ export interface ConnectCases {
     cb: (err: any, data?: CreateCaseCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CreateCaseRuleCommand}
+   */
+  createCaseRule(
+    args: CreateCaseRuleCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CreateCaseRuleCommandOutput>;
+  createCaseRule(args: CreateCaseRuleCommandInput, cb: (err: any, data?: CreateCaseRuleCommandOutput) => void): void;
+  createCaseRule(
+    args: CreateCaseRuleCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CreateCaseRuleCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateDomainCommand}
    */
@@ -259,6 +320,20 @@ export interface ConnectCases {
     cb: (err: any, data?: CreateTemplateCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeleteCaseRuleCommand}
+   */
+  deleteCaseRule(
+    args: DeleteCaseRuleCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeleteCaseRuleCommandOutput>;
+  deleteCaseRule(args: DeleteCaseRuleCommandInput, cb: (err: any, data?: DeleteCaseRuleCommandOutput) => void): void;
+  deleteCaseRule(
+    args: DeleteCaseRuleCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeleteCaseRuleCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteDomainCommand}
    */
@@ -384,6 +459,17 @@ export interface ConnectCases {
     cb: (err: any, data?: GetTemplateCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListCaseRulesCommand}
+   */
+  listCaseRules(args: ListCaseRulesCommandInput, options?: __HttpHandlerOptions): Promise<ListCaseRulesCommandOutput>;
+  listCaseRules(args: ListCaseRulesCommandInput, cb: (err: any, data?: ListCaseRulesCommandOutput) => void): void;
+  listCaseRules(
+    args: ListCaseRulesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListCaseRulesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListCasesForContactCommand}
    */
@@ -558,6 +644,20 @@ export interface ConnectCases {
     cb: (err: any, data?: UpdateCaseCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link UpdateCaseRuleCommand}
+   */
+  updateCaseRule(
+    args: UpdateCaseRuleCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<UpdateCaseRuleCommandOutput>;
+  updateCaseRule(args: UpdateCaseRuleCommandInput, cb: (err: any, data?: UpdateCaseRuleCommandOutput) => void): void;
+  updateCaseRule(
+    args: UpdateCaseRuleCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateCaseRuleCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link UpdateFieldCommand}
    */
@@ -596,7 +696,21 @@ export interface ConnectCases {
 }
 
 /**
- * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
+ * <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